Lumi.Components.Wizard

newtype Wizard step (props :: Type) value a

A Wizard is a sequential computation of FormBuilders, representing, each one, a wizard step that can depend on the result of previous steps to produce a final result.

Wizard is a monadic DSL that contains only a single instruction: step.

Instances

• Newtype (Wizard step props value a) _
• Functor (Wizard step props value)
• Apply (Wizard step props value)
• Applicative (Wizard step props value)
• Bind (Wizard step props value)
• Monad (Wizard step props value)

step :: forall step props value. step -> (FormBuilder { readonly :: Boolean | props } value) ~> (Wizard step { readonly :: Boolean | props } value)

Lift a FormBuilder and an associated identifier of type step into a Wizard step.

revalidate :: forall step props value a. Wizard step props value a -> props -> value -> Maybe a

Revalidate a Wizard, returning the final result if, with the given value, all steps produce valid results.

newtype WizardStep step (props :: Type) value a

WizardStep is a suspended Wizard computation, that is, a Wizard whose execution has been stopped at some step. It can be thought of as a Wizard zipper.

Instances

• Newtype (WizardStep step props value a) _

stepIdentifier :: forall step props value a. WizardStep step props value a -> Maybe step

Retrieve the identifier for the focused step of a WizardStep. Returns Nothing if the WizardStep represents a finalized Wizard.

liftStep :: forall step props value. (Wizard step props value) ~> (WizardStep step props value)

Lifts a Wizard into a WizardStep that focuses on its first step.

resumeStep :: forall step props value a. WizardStep step props value a -> props -> value -> Maybe (Either (WizardStep step props value a) a)

Resume a suspended WizardStep, if the current step produces a valid result, returning either the next WizardStep or the final result.

previousStep :: forall step props value a. WizardStep step props value a -> Maybe (WizardStep step props value a)

Return the previous step, if there is one.

gotoStep :: forall step props value a. Ord step => step -> Wizard step props value a -> props -> value -> Maybe (WizardStep step props value a)

Given that the step identifiers for the supplied Wizard are ordered, go to the first step in a Wizard that is assigned to the given identifier, if found.

wizard :: forall step props value a. { forceTopLabels :: Boolean, formProps :: props, inlineTable :: Boolean, onChange :: (value -> value) -> Effect Unit, step :: WizardStep step props value a, value :: value } -> JSX

A component that renders a WizardStep (a suspended Wizard).