Lumi.Components.Form.Validation

type Validator result valid = result -> Either String valid

A Validator takes a possibly invalid form result and produces a valid result, or an error message.

nonEmpty :: String -> Validator String NonEmptyString

A Validator which verifies that an input string is non-empty.

nonEmptyArray :: forall a. String -> Validator (Array a) (NonEmptyArray a)

A Validator which verifies that an input array is non-empty.

nonNull :: forall a. String -> Validator (Maybe a) a

A Validator which verifies that an optional field is specified.

nonEmpty' :: String -> Validator String NonEmptyString

nonEmpty, but the argument is the entire validation message.

nonEmptyArray' :: forall a. String -> Validator (Array a) (NonEmptyArray a)

nonEmptyArray, but the argument is the entire validation message.

nonNull' :: forall a. String -> Validator (Maybe a) a

nonNull, but the argument is the entire validation message.

mustEqual :: forall a. Eq a => a -> String -> Validator a a

A Validator which verifies that its input equals some value.

mustBe :: forall a. (a -> Boolean) -> String -> Validator a a

A Validator which verifies that its input fulfills a specified condition.

validNumber :: String -> Validator String Number

A Validator which verifies that its input can be parsed as a number.

validInt :: String -> Validator String Int

A Validator which verifies that its input can be parsed as an integer.

validDate :: String -> Validator String Date

A Validator which verifies that its input can be parsed as a date. Dates are of the format "YYYY-MM-DD".

validNumber' :: String -> Validator String Number

validNumber, but the argument is the entire validation message.

validInt' :: String -> Validator String Int

validInt, but the argument is the entire validation message.

validDate' :: String -> Validator String Date

validDate, but the argument is the entire validation message.

optional :: forall a. Validator String a -> Validator String (Maybe a)

Modify a Validator to accept empty strings in addition to anything it already accepts. The empty string is mapped to Nothing, and any other valid input is mapped to Just the result of the original validator.

data Validated a

The Validated type describes the state of a validated form field. This state may be used to modify the way this form field or its validation messages are displayed.

TODO: maybe convert this type to a record? Possible extensions to this type (as a record) could be a field valid :: Boolean to display an indicator that the field is valid, or a field validating :: Maybe (Canceler a) to control form fields with asynchronous validation.

Constructors

• Fresh a
• Modified a

Instances

• (Eq a) => Eq (Validated a)
• Eq1 Validated
• (Ord a) => Ord (Validated a)
• Ord1 Validated
• Functor Validated
• Apply Validated
• Applicative Validated
• (Generic value rep) => Generic (Validated value) rep
• (Mapping ModifyValidated a a) => Mapping ModifyValidated (Validated a) (Validated a)
• CanValidate (Validated a) a

_Validated :: forall a b. Lens (Validated a) (Validated b) a b

Lens for viewing and modifying Validated values.

_Fresh :: forall a. Prism' (Validated a) a

Prism for the Fresh constructor of Validated.

_Modified :: forall a. Prism' (Validated a) a

Prism for the Modified constructor of Validated.

setFresh :: forall value. Mapping ModifyValidated value value => value -> value

Sets all Validated fields in a record to Fresh, hiding all validation messages.

setModified :: forall value. Mapping ModifyValidated value value => value -> value

Sets all Validated fields in a record to Modified, showing all validation messages.

newtype ModifyValidated

Internal utility type for modifying the validated state of fields in records containing Validated values.

Constructors

• ModifyValidated (Validated ~> Validated)

Instances

• (Mapping ModifyValidated a a) => Mapping ModifyValidated (Validated a) (Validated a)
• (RowToList r xs, MapRecordWithIndex xs (ConstMapping ModifyValidated) r r) => Mapping ModifyValidated (Record r) (Record r)
• (Mapping ModifyValidated a a) => Mapping ModifyValidated (Array a) (Array a)
• (Mapping ModifyValidated a a) => Mapping ModifyValidated (Maybe a) (Maybe a)
• (CustomModifyValidated a, Mapping ModifyValidated a a) => Mapping ModifyValidated (ModifyValidatedProxy a) (ModifyValidatedProxy a)
• Mapping ModifyValidated a a

newtype ModifyValidatedProxy a

Constructors

• ModifyValidatedProxy a

Instances

• Newtype (ModifyValidatedProxy a) _
• (Eq value) => Eq (ModifyValidatedProxy value)
• (Ord value) => Ord (ModifyValidatedProxy value)
• (Generic value rep) => Generic (ModifyValidatedProxy value) rep
• (CustomModifyValidated a, Mapping ModifyValidated a a) => Mapping ModifyValidated (ModifyValidatedProxy a) (ModifyValidatedProxy a)

class CustomModifyValidated a  where

Members

• customModifyValidated :: ModifyValidated -> a -> a

class CanValidate u v | u -> v where

Internal utility type class used to flatten repeated applications of Validated to a type.

Members

• fresh :: Prism' (Validated v) u
• modified :: Prism' (Validated v) u
• fromValidated :: Validated v -> u

Instances

• CanValidate (Validated a) a
• CanValidate a a

validated :: forall props unvalidated validated result result_. CanValidate unvalidated validated => Validator result_ result -> FormBuilder { readonly :: Boolean | props } unvalidated result_ -> FormBuilder { readonly :: Boolean | props } (Validated validated) result

Attach a validation function to a FormBuilder p u a, producing a new FormBuilder that takes a Validated u as form state and displays an error message if its form data is invalid.

This Validated data type describes a form field as either Fresh or Modified, so that validation messages are only displayed if the field is Modified.

warn :: forall props unvalidated validated result. CanValidate unvalidated validated => WarningValidator result -> FormBuilder { readonly :: Boolean | props } unvalidated result -> FormBuilder { readonly :: Boolean | props } (Validated validated) result

Attach a validation function to a FormBuilder p u a, producing a new FormBuilder that takes a Validated u as form state and displays a warning message if its form data triggers a warning, while still allowing the form to proceed.