Reflex.Dom.Contrib.Widgets.Common

Infrastructure common to a wide variety of widgets. WidgetConfig holds the core inputs needed by most widgets, while HtmlWidget holds the core Dynamics and Events returned by most widgets. Encapsulating widget inputs and outputs this way makes it easier to compose and transform widgets.

Documentation

class HasChange a where

Associated Types

type Change a :: *

Methods

change :: a -> Change a

Instances

HasChange (Widget0 t a)

HasChange (HtmlWidget t a)

data WidgetConfig t a

Generic config structure common to most widgets. The attributes field may not be used for all widgets, but in that case it can just be ignored. We may want to change this in the future, but it seems like a reasonable start for now.

Constructors

WidgetConfig

Fields

_widgetConfig_setValue :: Event t a

_widgetConfig_initialValue :: a

_widgetConfig_attributes :: Dynamic t (Map String String)

Instances

Reflex t => Functor (WidgetConfig t)

(Reflex t, Default a) => Default (WidgetConfig t a)

HasSetValue (WidgetConfig t a)

HasAttributes (WidgetConfig t a)

type SetValue (WidgetConfig t a) = Event t a

type Attrs (WidgetConfig t a) = Dynamic t (Map String String)

widgetConfig_setValue :: forall t a. Lens' (WidgetConfig t a) (Event t a)

widgetConfig_initialValue :: forall t a. Lens' (WidgetConfig t a) a

widgetConfig_attributes :: forall t a. Lens' (WidgetConfig t a) (Dynamic t (Map String String))

class IsWidget w where

Minimal complete definition

constWidget, mapWidget, combineWidgets, extractWidget

Methods

constWidget :: Reflex t => a -> w t a

HtmlWidget with a constant value that never fires any events.

mapWidget :: MonadWidget t m => (a -> b) -> w t a -> m (w t b)

We can't make a Functor instance until Dynamic gets a Functor instance.

combineWidgets :: MonadWidget t m => (a -> b -> c) -> w t a -> w t b -> m (w t c)

wconcat :: (MonadWidget t m, Foldable f, Monoid a) => f (w t a) -> m (w t a)

Combines multiple widgets over a Monoid operation.

extractWidget :: MonadWidget t m => Dynamic t (w t a) -> m (w t a)

Since widgets contain Dynamics and Events inside them, we can pull Dynamic widgets out of the Dynamic.

Instances

IsWidget Widget0

IsWidget HtmlWidget

data Widget0 t a

A general-purpose widget return value.

Constructors

Widget0

Fields

_widget0_value :: Dynamic t a

The authoritative value for this widget.

_widget0_change :: Event t a

Event that fires when the widget changes internally (not via a setValue event).

Instances

IsWidget Widget0

HasValue (Widget0 t a)

HasChange (Widget0 t a)

type Value (Widget0 t a) = Dynamic t a

type Change (Widget0 t a) = Event t a

widget0_value :: forall t a. Lens' (Widget0 t a) (Dynamic t a)

widget0_change :: forall t a. Lens' (Widget0 t a) (Event t a)

data HtmlWidget t a

A general-purpose widget return value.

Constructors

HtmlWidget

Fields

_hwidget_value :: Dynamic t a

The authoritative value for this widget.

_hwidget_change :: Event t a

Event that fires when the widget changes internally (not via a setValue event).

_hwidget_keypress :: Event t Int

_hwidget_keydown :: Event t Int

_hwidget_keyup :: Event t Int

_hwidget_hasFocus :: Dynamic t Bool

Instances

IsWidget HtmlWidget

HasValue (HtmlWidget t a)

HasChange (HtmlWidget t a)

type Value (HtmlWidget t a) = Dynamic t a

type Change (HtmlWidget t a) = Event t a

hwidget_value :: forall t a. Lens' (HtmlWidget t a) (Dynamic t a)

hwidget_keyup :: forall t a. Lens' (HtmlWidget t a) (Event t Int)

hwidget_keypress :: forall t a. Lens' (HtmlWidget t a) (Event t Int)

hwidget_keydown :: forall t a. Lens' (HtmlWidget t a) (Event t Int)

hwidget_hasFocus :: forall t a. Lens' (HtmlWidget t a) (Dynamic t Bool)

hwidget_change :: forall t a. Lens' (HtmlWidget t a) (Event t a)

htmlTo0 :: HtmlWidget t a -> Widget0 t a

type GWidget t m a = WidgetConfig t a -> m (HtmlWidget t a)

Generalized form of many widget functions.

dateTimeWidget :: MonadWidget t m => GWidget t m (Maybe UTCTime)

Input widget for datetime values.

dateWidget :: MonadWidget t m => GWidget t m (Maybe Day)

Input widget for dates.

htmlCheckbox :: MonadWidget t m => GWidget t m Bool

HtmlWidget version of reflex-dom's checkbox.

htmlTextInput :: MonadWidget t m => String -> GWidget t m String

HtmlWidget version of reflex-dom's textInput.

htmlTextInput' :: MonadWidget t m => String -> WidgetConfig t String -> m (HTMLInputElement, HtmlWidget t String)

HtmlWidget version of reflex-dom's textInput that also returns the HTMLInputElement.

readableWidget :: (MonadWidget t m, Show a, Readable a) => GWidget t m (Maybe a)

NOTE: You should probably not use this function with string types because the Show instance will quote strings.

doubleWidget :: MonadWidget t m => GWidget t m (Maybe Double)

Widget that parses its input to a Double.

integerWidget :: MonadWidget t m => GWidget t m (Maybe Integer)

Widget that parses its input to an Integer.

intWidget :: MonadWidget t m => GWidget t m (Maybe Int)

Widget that parses its input to an Int.

htmlDropdown :: (MonadWidget t m, Eq b) => Dynamic t [a] -> (a -> String) -> (a -> b) -> WidgetConfig t b -> m (Widget0 t b)

Dropdown widget that takes a dynamic list of items and a function generating a String representation of those items.

htmlDropdownStatic :: (MonadWidget t m, Eq b) => [a] -> (a -> String) -> (a -> b) -> WidgetConfig t b -> m (Widget0 t b)

Dropdown widget that takes a list of items and a function generating a String representation of those items.

This widget doesn't require your data type to have Read and Show instances like reflex-dom's dropdown function. It does this by using Int indices into your static list of items in the actual rendered dropdown element.

But this comes with a price--it has unexpected behavior under insertions, deletions, and reorderings of the list of options. Because of this, you should probably only use this for static dropdowns where the list of options never changes.

blurOrEnter :: Reflex t => HtmlWidget t a -> Event t a

Returns an event that fires when the widget loses focus or enter is pressed.

restrictWidget :: MonadWidget t m => (HtmlWidget t a -> Event t a) -> GWidget t m a -> GWidget t m a

Allows you to restrict when a widget fires. For instance, restrictWidget blurOrEnter restricts a widget so it only fires on blur or when enter is pressed.

inputOnEnter :: MonadWidget t m => (WidgetConfig t a -> m (HtmlWidget t a)) -> WidgetConfig t a -> m (Dynamic t a)

Like readableWidget but only generates change events on blur or when enter is pressed.

listDropdown :: MonadWidget t m => Dynamic t [a] -> (a -> String) -> Dynamic t (Map String String) -> String -> m (Dynamic t (Maybe a))

A list dropdown widget.