m3e - v1.1.1

m3e/radio_group

radio_group provides Lustre support for the M3E Radio Group component

Types

Config

</>

Config holds the configuration for a RadioGroup

pub type Config {
  Config(
    interaction: state.Interaction,
    id: option.Option(String),
    name: option.Option(String),
    requirement: state.Requirement,
  )
}

Constructors

RadioGroup

opaque </>

RadioGroup provides Lustre support for the M3E Radio Group component

Fields:

  • interaction: Whether the element is enabled or disabled.
  • id: The id of the element
  • name: The name that identifies the element when submitting the associated form
  • requirement: Whether the element is required
pub opaque type RadioGroup

Values

default_config

</> 
pub fn default_config() -> Config

default_config creates a new Config with default values

disabled

</> 
pub fn disabled(
  group: RadioGroup,
  interaction: state.Interaction,
) -> RadioGroup

disabled sets the interaction field

from_config

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

from_config creates a RadioGroup from a Config record

id

</> 
pub fn id(
  group: RadioGroup,
  id: option.Option(String),
) -> RadioGroup

id sets the id field

name

</> 
pub fn name(
  group: RadioGroup,
  name: option.Option(String),
) -> RadioGroup

name sets the name field

new

</> 
pub fn new() -> RadioGroup

new creates a new RadioGroup with default values

render

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

render creates a Lustre Element(msg) from a RadioGroup

Parameters:

  • group: a RadioGroup
  • 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

required

</> 
pub fn required(
  group: RadioGroup,
  requirement: state.Requirement,
) -> RadioGroup

required sets the requirement field

✨ Search Document