MultiSelect

A select component for multi selection with local data.

Architecture

The opaque type representing a particular smart select instance.

type Msg a

Opaque type representing cases to be passed to MultiSelect.update

{ selectionMsg : ( List a, Msg a ) -> msg

, internalMsg : Msg a -> msg

, idPrefix : String

}

-> SmartSelect msg a

Instantiates and returns a smart select.

selectionMsg takes a function that expects a tuple representing the list of selections and a MultiSelect.Msg and returns an externally defined msg for handling selection.
internalMsg takes a function that expects a MultiSelect.Msg and returns an externally defined msg for handling the update of the select.
idPrefix takes a string with a unique prefix

{ selected : List a

, options : List a

, optionLabelFn : a -> String

, viewSelectedOptionFn : a -> Html msg

, settings : Settings msg

}

-> SmartSelect msg a

-> Html msg

The smart select view for selecting multiple options at a time with local data.

selected takes a list of the currently selected entities.
options takes a list of the data being selected from.
optionLabelFn takes a function that expects an instance of the data being selected from and returns a string naming/labeling the instance, i.e. if it is a "Product" being selected, the label may be "Garden Hose".
viewSelectedOptionFn takes a function that expects and instance of the data being selected from and returns html to render a selected option.
settings takes the settings record (see the Settings type)

viewCustom : Config msg a -> SmartSelect msg a -> Html msg

The smart select custom view for selecting multiple options at a time with local data. You have to pass a custom configuration here.

Events external to the smart select to which it is subscribed.

update : Msg a -> SmartSelect msg a -> ( SmartSelect msg a, Cmd msg )

Update the provided smart select and receive the updated select instance and a cmd to run.

Triggers an update of the provided smart select's alignment