m3e - v1.1.3

m3e/button_segment

button_segment provides Lustre support for the M3E Button Segment component

Types

ButtonSegment

opaque </>

ButtonSegment provides Lustre support for the M3E Button Segment component

Fields:

  • checked: Whether the element is checked
  • disabled: Whether the element is disabled
  • value: A string representing the value of the segment
pub opaque type ButtonSegment

Config

</>

Config allows for a declarative configuration of the ButtonSegment

pub type Config {
  Config(
    checked: state.SelectionState,
    disabled: state.Interaction,
    value: option.Option(String),
  )
}

Constructors

Slot

</>

Slot gives type-safe names to each of the defined HTML named slots

pub type Slot {
  Icon
}

Constructors 

  • Icon

Values

checked

</> 
pub fn checked(
  b: ButtonSegment,
  checked: state.SelectionState,
) -> ButtonSegment

checked sets the checked field

default_config

</> 
pub fn default_config() -> Config

default_config returns a default Config

disabled

</> 
pub fn disabled(
  b: ButtonSegment,
  disabled: state.Interaction,
) -> ButtonSegment

disabled sets the disabled field

from_config

</> 
pub fn from_config(c: Config) -> ButtonSegment

from_config creates a ButtonSegment from a Config

new

</> 
pub fn new() -> ButtonSegment

new creates a new ButtonSegment

render

</> 
pub fn render(
  b: ButtonSegment,
  attributes: List(attribute.Attribute(msg)),
  children: List(element.Element(msg)),
) -> element.Element(msg)

render creates a Lustre Element(msg) from a ButtonSegment

Parameters:

  • b: a ButtonSegment
  • attributes: additional attributes
  • children: additional children

render_config

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

render_config creates a Lustre Element from a Config

slot

</> 
pub fn slot(s: Slot) -> attribute.Attribute(msg)

slot creates a Lustre ‘slot’ Attribute(msg) for a Slot

value

</> 
pub fn value(
  b: ButtonSegment,
  value: option.Option(String),
) -> ButtonSegment

value sets the value field

✨ Search Document