m3e/tabs

tab provides Lustre support for the M3E Tab component

Types

Config

Config holds the configuration for a Tabs

pub type Config {
  Config(
    disabled_pagination: ScrollButtons,
    header_position: HeaderPosition,
    next_page_label: String,
    previous_page_label: String,
    stretch: Stretch,
    variant: Variant,
  )
}

Constructors

Config(
  disabled_pagination: ScrollButtons,
  header_position: HeaderPosition,
  next_page_label: String,
  previous_page_label: String,
  stretch: Stretch,
  variant: Variant,
)

HeaderPosition

</>

HeaderPosition is the position of the tab headers

pub type HeaderPosition {
  After
  Before
}

Constructors

```
After
```
```
Before
```

ScrollButtons

</>

ScrollButtons is whether scroll buttons are disabled, defining the disable-pagination attribute

pub type ScrollButtons {
  Scroll
  NoScroll
}

Constructors

```
Scroll
```
```
NoScroll
```

Slot

</>

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

pub type Slot {
  NextIcon
  Panel
  PrevIcon
}

Constructors

```
NextIcon
```
```
Panel
```
```
PrevIcon
```

Stretch

</>

Stretch defines whether tabs are stretched to fill the header

pub type Stretch {
  Stretch
  NoStretch
}

Constructors

```
Stretch
```
```
NoStretch
```

Tabs

opaque </>

Tabs provides a structured navigation surface for organizing content into distinct views, where only one view is visible at a time

Fields:

disabled_pagination: Whether scroll buttons are disabled
header_position: The position of the tab headers
next_page_label: The accessible label given to the button used to move to the previous page
previous_page_label: The accessible label given to the button used to move to the next page
stretch: Whether tabs are stretched to fill the header
variant: The appearance variant of the tabs

pub opaque type Tabs

Variant

</>

Variant is the appearance variant of the tabs

pub type Variant {
  Primary
  Secondary
}

Constructors

```
Primary
```
```
Secondary
```

Values

default_config

</>

pub fn default_config() -> Config

default_config creates a new Config with default values

default_header_position

</>

pub const default_header_position: HeaderPosition

default_next_page_label

</>

pub const default_next_page_label: String

default_previous_page_label

</>

pub const default_previous_page_label: String

default_scroll_buttons

</>

pub const default_scroll_buttons: ScrollButtons

default_stretch

</>

pub const default_stretch: Stretch

default_variant

</>

pub const default_variant: Variant

disabled_pagination

</>

pub fn disabled_pagination(
  t: Tabs,
  disabled_pagination: ScrollButtons,
) -> Tabs

disabled_pagination sets the disabled_pagination field

from_config

</>

pub fn from_config(config: Config) -> Tabs

from_config creates a Tabs from a Config

header_position

</>

pub fn header_position(
  t: Tabs,
  header_position: HeaderPosition,
) -> Tabs

header_position sets the header_position field

new

</>

pub fn new() -> Tabs

new creates a new Tabs

next_page_label

</>

pub fn next_page_label(t: Tabs, next_page_label: String) -> Tabs

next_page_label sets the next_page_label field

previous_page_label

</>

pub fn previous_page_label(
  t: Tabs,
  previous_page_label: String,
) -> Tabs

previous_page_label sets the previous_page_label field

render

</>

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

render creates a Lustre Element(msg) from a Tabs

Parameters:

t: a Tabs
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

slot

</>

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

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

stretch

</>

pub fn stretch(t: Tabs, stretch: Stretch) -> Tabs

stretch sets the stretch field

variant

</>

pub fn variant(t: Tabs, variant: Variant) -> Tabs

variant sets the variant field