Ditto.Generalized.Named

This module provides helper functions for HTML input elements. These helper functions are not specific to any particular web framework or html library.

For unnamed (enumerated) formlets, see Ditto.Generalized.Unnamed

Documentation

data Choice lbl a

a choice for inputChoice

Constructors

Choice

Fields

• choiceFormId :: FormId

  the formId

• choiceLabel :: lbl

  label

• choiceIsSelected :: Bool

  is the choice selected

• choiceVal :: a

  the haskell value of the choice

input :: (Environment m input, FormError input err) => Text -> (input -> Either err a) -> (FormId -> a -> view) -> a -> Form m input err view a

used for constructing elements like <input type="text">, which pure a single input value.

inputMaybe :: (Environment m input, FormError input err) => Text -> (input -> Either err a) -> (FormId -> Maybe a -> view) -> Maybe a -> Form m input err view (Maybe a)

used for elements like <input type="submit"> which are not always present in the form submission data.

inputNoData :: Environment m input => Text -> (FormId -> view) -> Form m input err view ()

used for elements like <input type="reset"> which take a value, but are never present in the form data set.

inputFile :: forall m input err view ft. (Environment m input, FormInput input, FormError input err, ft ~ FileType input, Monoid ft) => Text -> (FormId -> view) -> Form m input err view (FileType input)

used for <input type="file">

inputMulti

Arguments

:: forall m input err view a lbl. (FormError input err, FormInput input, Environment m input, Eq a)

=> Text

-> [(a, lbl)]

value, label, initially checked

-> (input -> Either err [a])

-> (FormId -> [Choice lbl a] -> view)

function which generates the view

-> (a -> Bool)

isChecked/isSelected initially

-> Form m input err view [a]

used for groups of checkboxes, <select multiple="multiple"> boxes

inputChoice

Arguments

:: forall a m err input lbl view. (FormError input err, FormInput input, Environment m input, Eq a, Monoid view)

=> Text

-> (a -> Bool)

is default

-> NonEmpty (a, lbl)

value, label

-> (input -> Either err a)

-> (FormId -> [Choice lbl a] -> view)

function which generates the view

-> Form m input err view a

radio buttons, single <select> boxes

inputList

Arguments

:: forall m input err a view. (Monad m, FormError input err, Environment m input)

=> Text

-> (input -> m (Either err [a]))

decoding function for the list

-> ([view] -> view)

how to concatenate views

-> [a]

initial values

-> view

view to generate in the fail case

-> (a -> Form m input err view a)

-> Form m input err view [a]

this is necessary in order to basically map over the decoding function

label :: Environment m input => Text -> (FormId -> view) -> Form m input err view ()

used to create <label> elements

errors

Arguments

:: Environment m input

=> ([err] -> view)

function to convert the err messages into a view

-> Form m input err view ()

used to add a list of err messages to a Form

This function automatically takes care of extracting only the errors that are relevent to the form element it is attached to via <* or *>.

childErrors :: Environment m input => ([err] -> view) -> Form m input err view ()

similar to errors but includes err messages from children of the form as well.

withErrors :: Environment m input => (view -> [err] -> view) -> Form m input err view a -> Form m input err view a

modify the view of a form based on its errors

withChildErrors :: Monad m => (view -> [err] -> view) -> Form m input err view a -> Form m input err view a

modify the view of a form based on its child errors

ireq :: forall m input view err a. (Monoid view, Environment m input, FormError input err) => Text -> (input -> Either err a) -> a -> Form m input err view a

a Form with no view

iopt :: forall m input view err a. (Monoid view, Environment m input, FormError input err) => Text -> (input -> Either err a) -> Maybe a -> Form m input err view (Maybe a)

an optional Form with no view