m3e - v1.1.1

m3e/switch

switch provides Lustre support for the M3E Switch component

Types

Config

</>

Config holds the configuration for a Switch

pub type Config {
  Config(
    label: option.Option(String),
    icons: Icons,
    checked: state.CheckedState,
    disabled: state.Interaction,
    form_submission: option.Option(form_submission.FormSubmission),
  )
}

Constructors

Icons

</> 
pub type Icons {
  Both
  Neither
  Selected
}

Constructors 

  • Both
  • Neither
  • Selected

Switch

opaque </>

Switch is a configuration type representing an M3E Switch

Fields:

  • id: id of the switch,
  • label: label on the switch
  • icons: The icons to present
  • checked: Whether the element is checked
  • disabled: Whether the element is disabled
  • form_submission: handles this element’s role in form submission
pub opaque type Switch

Values

checked

</> 
pub fn checked(s: Switch, checked: state.CheckedState) -> Switch

checked sets the checked field

default_config

</> 
pub fn default_config() -> Config

default_config creates a new Config with default values

default_icons

</> 
pub const default_icons: Icons

disabled

</> 
pub fn disabled(s: Switch, disabled: state.Interaction) -> Switch

disabled sets the disabled field

form

</> 
pub fn form(
  s: Switch,
  form_submission: option.Option(form_submission.FormSubmission),
) -> Switch

form sets theform_submission field when the switch is used in a form

Pass None to name & value to clear the form controls

from_config

</> 
pub fn from_config(config: Config) -> Switch

from_config creates a Switch from a Config

icon

</> 
pub fn icon(s: Switch, icons: Icons) -> Switch

icon sets the icons field

label

</> 
pub fn label(s: Switch, label: option.Option(String)) -> Switch

label sets the label field

new

</> 
pub fn new(id: String) -> Switch

new creates a Switch with default values

render

</> 
pub fn render(
  s: Switch,
  attributes: List(attribute.Attribute(msg)),
) -> List(element.Element(msg))

render creates a list of Lustre Elements from a Switch

render_config

</> 
pub fn render_config(
  config: Config,
  attributes: List(attribute.Attribute(msg)),
) -> List(element.Element(msg))

render_config creates a Lustre Element directly from a Config

✨ Search Document