Monomer.Widgets.Singles.DateField

Input field for dates types with support for valid ranges, different formats and separators.

dateField dateLens

With configuration options:

dateField_ dateLens [dateFormatMMDDYYYY, dateFormatDelimiter '-']

Supports the Day type of the time library, but other types can be supported by implementing DayConverter. Maybe is also supported.

Handles mouse wheel and shift + vertical drag to increase/decrease days.

Configuration

data DateFieldCfg s e a

Configuration options for dateField:

• caretWidth: the width of the caret.
• caretMs: the blink period of the caret.
• validInput: field indicating if the current input is valid. Useful to show warnings in the UI, or disable buttons if needed.
• resizeOnChange: Whether input causes ResizeWidgets requests.
• selectOnFocus: Whether all input should be selected when focus is received.
• readOnly: Whether to prevent the user changing the input text.
• minValue: Minimum valid date.
• maxValue: Maximum valid date.
• wheelRate: The rate at which wheel movement affects the date.
• dragRate: The rate at which drag movement affects the date.
• onFocus: event to raise when focus is received.
• onFocusReq: WidgetRequest to generate when focus is received.
• onBlur: event to raise when focus is lost.
• onBlurReq: WidgetRequest to generate when focus is lost.
• onChange: event to raise when the value changes.
• onChangeReq: WidgetRequest to generate when the value changes.
• dateFormatDelimiter: which text delimiter to separate year, month and day.
• dateFormatDDMMYYYY: using the current delimiter, accept DDMMYYYY.
• dateFormatMMDDYYYY: using the current delimiter, accept MMDDYYYY.
• dateFormatYYYYMMDD: using the current delimiter, accept YYYYMMDD.

Instances

Monoid (DateFieldCfg s e a)

Defined in Monomer.Widgets.Singles.DateField

Methods

mempty :: DateFieldCfg s e a

mappend :: DateFieldCfg s e a -> DateFieldCfg s e a -> DateFieldCfg s e a

mconcat :: [DateFieldCfg s e a] -> DateFieldCfg s e a

Semigroup (DateFieldCfg s e a)

Defined in Monomer.Widgets.Singles.DateField

Methods

(<>) :: DateFieldCfg s e a -> DateFieldCfg s e a -> DateFieldCfg s e a

sconcat :: NonEmpty (DateFieldCfg s e a) -> DateFieldCfg s e a

stimes :: Integral b => b -> DateFieldCfg s e a -> DateFieldCfg s e a

Default (DateFieldCfg s e a)

Defined in Monomer.Widgets.Singles.DateField

Methods

def :: DateFieldCfg s e a

CmbReadOnly (DateFieldCfg s e a)

Defined in Monomer.Widgets.Singles.DateField

Methods

readOnly :: DateFieldCfg s e a

readOnly_ :: Bool -> DateFieldCfg s e a

CmbResizeOnChange (DateFieldCfg s e a)

Defined in Monomer.Widgets.Singles.DateField

Methods

resizeOnChange :: DateFieldCfg s e a

resizeOnChange_ :: Bool -> DateFieldCfg s e a

CmbSelectOnFocus (DateFieldCfg s e a)

Defined in Monomer.Widgets.Singles.DateField

Methods

selectOnFocus :: DateFieldCfg s e a

selectOnFocus_ :: Bool -> DateFieldCfg s e a

CmbCaretMs (DateFieldCfg s e a) Millisecond

Defined in Monomer.Widgets.Singles.DateField

Methods

caretMs :: Millisecond -> DateFieldCfg s e a

CmbCaretWidth (DateFieldCfg s e a) Double

Defined in Monomer.Widgets.Singles.DateField

Methods

caretWidth :: Double -> DateFieldCfg s e a

CmbDragRate (DateFieldCfg s e a) Double

Defined in Monomer.Widgets.Singles.DateField

Methods

dragRate :: Double -> DateFieldCfg s e a

FormattableDate a => CmbMaxValue (DateFieldCfg s e a) a

Defined in Monomer.Widgets.Singles.DateField

Methods

maxValue :: a -> DateFieldCfg s e a

FormattableDate a => CmbMinValue (DateFieldCfg s e a) a

Defined in Monomer.Widgets.Singles.DateField

Methods

minValue :: a -> DateFieldCfg s e a

CmbValidInput (DateFieldCfg s e a) s

Defined in Monomer.Widgets.Singles.DateField

Methods

validInput :: ALens' s Bool -> DateFieldCfg s e a

CmbValidInputV (DateFieldCfg s e a) e

Defined in Monomer.Widgets.Singles.DateField

Methods

validInputV :: (Bool -> e) -> DateFieldCfg s e a

CmbWheelRate (DateFieldCfg s e a) Double

Defined in Monomer.Widgets.Singles.DateField

Methods

wheelRate :: Double -> DateFieldCfg s e a

WidgetEvent e => CmbOnBlur (DateFieldCfg s e a) e Path

Defined in Monomer.Widgets.Singles.DateField

Methods

onBlur :: (Path -> e) -> DateFieldCfg s e a

WidgetEvent e => CmbOnChange (DateFieldCfg s e a) a e

Defined in Monomer.Widgets.Singles.DateField

Methods

onChange :: (a -> e) -> DateFieldCfg s e a

WidgetEvent e => CmbOnFocus (DateFieldCfg s e a) e Path

Defined in Monomer.Widgets.Singles.DateField

Methods

onFocus :: (Path -> e) -> DateFieldCfg s e a

CmbOnBlurReq (DateFieldCfg s e a) s e Path

Defined in Monomer.Widgets.Singles.DateField

Methods

onBlurReq :: (Path -> WidgetRequest s e) -> DateFieldCfg s e a

CmbOnChangeReq (DateFieldCfg s e a) s e a

Defined in Monomer.Widgets.Singles.DateField

Methods

onChangeReq :: (a -> WidgetRequest s e) -> DateFieldCfg s e a

CmbOnFocusReq (DateFieldCfg s e a) s e Path

Defined in Monomer.Widgets.Singles.DateField

Methods

onFocusReq :: (Path -> WidgetRequest s e) -> DateFieldCfg s e a

data DateFieldFormat

Available formats for dateField.

Instances

Show DateFieldFormat

Defined in Monomer.Widgets.Singles.DateField

Methods

showsPrec :: Int -> DateFieldFormat -> ShowS

show :: DateFieldFormat -> String

showList :: [DateFieldFormat] -> ShowS

Eq DateFieldFormat

Defined in Monomer.Widgets.Singles.DateField

Methods

(==) :: DateFieldFormat -> DateFieldFormat -> Bool

(/=) :: DateFieldFormat -> DateFieldFormat -> Bool

type FormattableDate a = (Eq a, Ord a, Show a, DateTextConverter a, Typeable a)

Constraints for date types accepted by dateField.

class (Eq a, Ord a, Show a, Typeable a) => DayConverter a where

Converter to and form the Day type of the time library. To use types other than Day of said library, this typeclass needs to be implemented. -

Methods

convertFromDay :: Day -> a

convertToDay :: a -> Maybe Day

Instances

DayConverter Day

Defined in Monomer.Widgets.Singles.DateField

Methods

convertFromDay :: Day -> Day

convertToDay :: Day -> Maybe Day

class DateTextConverter a where

Converts a Day instance to and from Text. Implementing this typeclass is not necessary for instances of DayConverter.

Methods

dateAcceptText :: DateFieldFormat -> Char -> Maybe a -> Maybe a -> Text -> (Bool, Bool, Maybe a)

dateFromText :: DateFieldFormat -> Char -> Text -> Maybe a

dateToText :: DateFieldFormat -> Char -> a -> Text

dateFromDay :: Day -> a

dateToDay :: a -> Maybe Day

Instances

DayConverter a => DateTextConverter a

Defined in Monomer.Widgets.Singles.DateField

Methods

dateAcceptText :: DateFieldFormat -> Char -> Maybe a -> Maybe a -> Text -> (Bool, Bool, Maybe a)

dateFromText :: DateFieldFormat -> Char -> Text -> Maybe a

dateToText :: DateFieldFormat -> Char -> a -> Text

dateFromDay :: Day -> a

dateToDay :: a -> Maybe Day

(DayConverter a, DateTextConverter a) => DateTextConverter (Maybe a)

Defined in Monomer.Widgets.Singles.DateField

Methods

dateAcceptText :: DateFieldFormat -> Char -> Maybe (Maybe a) -> Maybe (Maybe a) -> Text -> (Bool, Bool, Maybe (Maybe a))

dateFromText :: DateFieldFormat -> Char -> Text -> Maybe (Maybe a)

dateToText :: DateFieldFormat -> Char -> Maybe a -> Text

dateFromDay :: Day -> Maybe a

dateToDay :: Maybe a -> Maybe Day

dateFormatDelimiter :: Char -> DateFieldCfg s e a

Which character should be used to delimit dates.

dateFormatDDMMYYYY :: DateFieldCfg s e a

Date format DDMMYYYY, using the appropriate delimiter.

dateFormatMMDDYYYY :: DateFieldCfg s e a

Date format MMDDYYYY, using the appropriate delimiter.

dateFormatYYYYMMDD :: DateFieldCfg s e a

Date format YYYYMMDD, using the appropriate delimiter.

Constructors

dateField

Arguments

:: (FormattableDate a, WidgetEvent e)

=> ALens' s a

The lens into the model.

-> WidgetNode s e

The created date field.

Creates a date field using the given lens.

dateField_

Arguments

:: (FormattableDate a, WidgetEvent e)

=> ALens' s a

The lens into the model.

-> [DateFieldCfg s e a]

The config options.

-> WidgetNode s e

The created date field.

Creates a date field using the given lens. Accepts config.

dateFieldV

Arguments

:: (FormattableDate a, WidgetEvent e)

=> a

The current value.

-> (a -> e)

The event to raise on change.

-> WidgetNode s e

The created date field.

Creates a date field using the given value and onChange event handler.

dateFieldV_

Arguments

:: (FormattableDate a, WidgetEvent e)

=> a

The current value.

-> (a -> e)

The event to raise on change.

-> [DateFieldCfg s e a]

The config options.

-> WidgetNode s e

The created date field.

Creates a date field using the given value and onChange event handler. Accepts config.

dateFieldD_

Arguments

:: (FormattableDate a, WidgetEvent e)

=> WidgetData s a

The WidgetData to retrieve the value from.

-> [DateFieldCfg s e a]

The config options.

-> WidgetNode s e

The created date field.

Creates a date field providing a WidgetData instance and config.