m3e - v1.1.3

m3e/slider

slider provides Lustre support for the M3E Slider component

Types

Config

</>

Config holds the configuration for a Slider

pub type Config {
  Config(
    discrete: Discrete,
    interaction: state.Interaction,
    labels: ValueLabels,
    max: Float,
    min: Float,
    size: config.Size,
    step: Float,
  )
}

Constructors

Discrete

</>

Discrete specifies if a slider is discrete or continuous

pub type Discrete {
  Discrete
  Continuous
}

Constructors 

  • Discrete
  • Continuous

Slider

opaque </>

Slider provides Lustre support for the M3E Slider component

Fields:

  • discrete: Whether to show tick marks
  • interaction: Whether the element is enabled or disabled
  • labels: Whether to show value labels when activated
  • max: The maximum allowable value
  • min: The minimum allowable value
  • size: The size of the slider
  • step: The value at which the thumb will snap
pub opaque type Slider

ValueLabels

</>

ValueLabels specifies if a slider shows value labels

pub type ValueLabels {
  ShowLabels
  HideLabels
}

Constructors 

  • ShowLabels
  • HideLabels

Values

default_config

</> 
pub fn default_config() -> Config

default_config creates a new Config with default values

default_discrete

</> 
pub const default_discrete: Discrete

default_max

</> 
pub const default_max: Float

default_min

</> 
pub const default_min: Float

default_size

</> 
pub const default_size: config.Size

default_step

</> 
pub const default_step: Float

default_value_labels

</> 
pub const default_value_labels: ValueLabels

disabled

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

disabled sets the interaction field

discrete

</> 
pub fn discrete(s: Slider, d: Discrete) -> Slider

discrete sets the discrete field

from_config

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

from_config creates a Slider from a Config record

labelled

</> 
pub fn labelled(s: Slider, l: ValueLabels) -> Slider

labelled sets the labels field

max

</> 
pub fn max(s: Slider, max: Float) -> Slider

max sets the max field

min

</> 
pub fn min(s: Slider, min: Float) -> Slider

min sets the min field

new

</> 
pub fn new() -> Slider

new creates a new Slider

render

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

render creates a Lustre Element(msg) from a Slider

Parameters:

  • s: a Slider
  • 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

size

</> 
pub fn size(s: Slider, size: config.Size) -> Slider

size sets the size field

step

</> 
pub fn step(s: Slider, step: Float) -> Slider

step sets the step field

✨ Search Document