Lumi.Components.Form.Table

newtype TableFormBuilder props row result

An applicative functor used to build editable tables out of FormBuilders. FormBuilders can be turned into TableFormBuilders with the column function. TableFormBuilders can, then, be used inside forms with the editableTable function.

Instances

• Newtype (TableFormBuilder props row a) _
• Functor (TableFormBuilder props row)
• Apply (TableFormBuilder props row)
• Applicative (TableFormBuilder props row)

revalidate :: forall props row result. TableFormBuilder props row result -> props -> row -> Maybe result

Revalidate the table form, in order to display error messages or create a validated result.

editableTable :: forall props row result. { addLabel :: String, addRow :: Maybe (Aff (Maybe row)), formBuilder :: TableFormBuilder { readonly :: Boolean | props } row result, maxRows :: Int, rowMenu :: { remove :: Maybe (Effect Unit), update :: (row -> row) -> Effect Unit } -> row -> Maybe result -> JSX, summary :: Array row -> Maybe (Array result) -> JSX } -> FormBuilder { readonly :: Boolean | props } (Array row) (Array result)

A TableFormBuilder makes a FormBuilder for an array where each row has columns defined by it.

nonEmptyEditableTable :: forall props row result. { addLabel :: String, addRow :: Maybe (Aff (Maybe row)), formBuilder :: TableFormBuilder { readonly :: Boolean | props } row result, maxRows :: Int, rowMenu :: { remove :: Maybe (Effect Unit), update :: (row -> row) -> Effect Unit } -> row -> Maybe result -> JSX, summary :: NonEmptyArray row -> Maybe (NonEmptyArray result) -> JSX } -> FormBuilder { readonly :: Boolean | props } (NonEmptyArray row) (NonEmptyArray result)

A TableFormBuilder makes a FormBuilder for a non-empty array where each row has columns defined by it.

defaultRowMenu :: forall row result. { remove :: Maybe (Effect Unit), update :: (row -> row) -> Effect Unit } -> row -> Maybe result -> JSX

Default row menu that displays a bin icon, which, when clicked, deletes the current row.

column :: forall props row. String -> Orientation -> (FormBuilder { readonly :: Boolean | props } row) ~> (TableFormBuilder { readonly :: Boolean | props } row)

Convert a FormBuilder into a column of a table form with the specified label and orientation.

column_ :: forall props row. String -> (FormBuilder { readonly :: Boolean | props } row) ~> (TableFormBuilder { readonly :: Boolean | props } row)

Convert a FormBuilder into a column of a table form with the specified label where all fields are laid out horizontally.

infoColumn :: forall props row. Orientation -> (FormBuilder { readonly :: Boolean | props } row) ~> (TableFormBuilder { readonly :: Boolean | props } row)

Convert a FormBuilder into a readonly info column of a table form with the specified orientation.

infoColumn_ :: forall props row. (FormBuilder { readonly :: Boolean | props } row) ~> (TableFormBuilder { readonly :: Boolean | props } row)

Convert a FormBuilder into a readonly info column of a table form with the specified label where all fields are laid out horizontally.

withProps :: forall props row result. (props -> TableFormBuilder props row result) -> TableFormBuilder props row result

Make the props available. This allows for changing the structure of a table form builder based on the current props.