m3e/segmented_button

segmented_button provides Lustre support for the M3E Segmented Button component

Types

Config

Config holds the configuration for a SegmentedButton

pub type Config {
  Config(
    interaction: types.Interaction,
    indicator_visibility: IndicatorVisibility,
    selection_mode: types.SelectionMode,
    name: option.Option(String),
  )
}

Constructors

Config(
  interaction: types.Interaction,
  indicator_visibility: IndicatorVisibility,
  selection_mode: types.SelectionMode,
  name: option.Option(String),
)

IndicatorVisibility

</>

IndicatorVisibility specifies if the selection indicator is visible or hidden

pub type IndicatorVisibility {
  Visible
  Hidden
}

Constructors

```
Visible
```
```
Hidden
```

SegmentedButton

opaque </>

SegmentedButton provides Lustre support for the M3E Segmented Button component

Fields:

interaction: Whether the element is enabled or disabled
indicator_visibility: Whether to hide the selection indicator
selection_mode: Whether multiple options can be selected
name: The name that identifies the element when submitting the associated form

pub opaque type SegmentedButton

Values

default_config

</>

pub fn default_config() -> Config

default_config creates a new Config with default values

default_indicator_visibility

</>

pub const default_indicator_visibility: IndicatorVisibility

disabled

</>

pub fn disabled(
  s: SegmentedButton,
  interaction: types.Interaction,
) -> SegmentedButton

disabled sets the interaction field

from_config

</>

pub fn from_config(c: Config) -> SegmentedButton

from_config creates a SegmentedButton from a Config record

hide_selection_indicator

</>

pub fn hide_selection_indicator(
  s: SegmentedButton,
  indicator_visibility: IndicatorVisibility,
) -> SegmentedButton

hide_selection_indicator sets the indicator_visibility field

multi

</>

pub fn multi(
  s: SegmentedButton,
  selection_mode: types.SelectionMode,
) -> SegmentedButton

multi sets the selection_mode field

name

</>

pub fn name(
  s: SegmentedButton,
  name: option.Option(String),
) -> SegmentedButton

name sets the name field

new

</>

pub fn new() -> SegmentedButton

new creates a new SegmentedButton with default values

render

</>

pub fn render(
  s: SegmentedButton,
  attributes: List(attribute.Attribute(msg)),
  children: List(element.Element(msg)),
) -> element.Element(msg)

render creates a Lustre Element(msg) from a SegmentedButton

Parameters:

s: a SegmentedButton
attributes: additional attributes
children: additional children

render_config

</>

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

render_config creates a Lustre Element directly from a Config