m3e - v1.0.0

m3e/app_bar

app_bar provides Lustre support for the M3E App Bar component

Types

AppBar

opaque </>

AppBar is a prominent user interface component that provides consistent access to key actions, navigation, and contextual information at the top of an application screen

Fields:

  • alignment: Whether the title and subtitle are centered
  • for: The identifier of the interactive control to which this element is attached
  • size: Size of the bar
pub opaque type AppBar

Config

</>

Config holds the configuration for an AppBar

pub type Config {
  Config(
    alignment: TitleAlignment,
    for: option.Option(String),
    size: size_few.Size,
  )
}

Constructors

Slot

</>

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

pub type Slot {
  LeadingIcon
  Subtitle
  Title
  TrailingIcon
}

Constructors 

  • LeadingIcon
  • Subtitle
  • Title
  • TrailingIcon

TitleAlignment

</>

TitleAlignment specifies if the title and subtitle are centered

pub type TitleAlignment {
  Centered
  Standard
}

Constructors 

  • Centered
  • Standard

Values

alignment

</> 
pub fn alignment(a: AppBar, alignment: TitleAlignment) -> AppBar

alignment sets the title alignment

default_config

</> 
pub fn default_config() -> Config

default_config creates a new Config with default values

default_size

</> 
pub const default_size: size_few.Size

Default size

default_title_alignment

</> 
pub const default_title_alignment: TitleAlignment

for

</> 
pub fn for(a: AppBar, for: option.Option(String)) -> AppBar

for sets the for attribute

from_config

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

from_config creates a new AppBar from a Config record

new

</> 
pub fn new() -> AppBar

new creates a new AppBar with default values

render

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

render creates an M3E App Bar component from an AppBar

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(a: AppBar, size: size_few.Size) -> AppBar

size sets the size attribute

slot

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

slot creates a Lustre ‘slot’ attribute for a named Slot

✨ Search Document