m3e/breadcrumb_item

BreadcrumbItem is an item in a breadcrumb.

This file was generated by m3e/generator

     DO NOT EDIT

Types

BreadcrumbItem

opaque </>

BreadcrumbItem is a View Model for this component

Fields:

item_label: The accessible label given to the item’s internal button.
disabled: Whether the element is disabled.
current: Indicates the current item in the breadcrumb path.
href: The URL to which the internal breadcrumb link button points.
target: The target of the internal breadcrumb link button.
download: A value indicating whether the internal link target will be downloaded, optionally specifying a file name.
rel: The relationship between the internal link target and the document.

pub opaque type BreadcrumbItem

Config

</>

Config is a public record for configuring this component.

pub type Config {
  Config(
    item_label: String,
    disabled: Disabled,
    current: option.Option(
      breadcrumb_item_current.BreadcrumbItemCurrent,
    ),
    href: String,
    target: option.Option(link_target.LinkTarget),
    download: option.Option(String),
    rel: String,
  )
}

Constructors

Config(
  item_label: String,
  disabled: Disabled,
  current: option.Option(
    breadcrumb_item_current.BreadcrumbItemCurrent,
  ),
  href: String,
  target: option.Option(link_target.LinkTarget),
  download: option.Option(String),
  rel: String,
)

Disabled

</>

Disabled is whether the element is disabled.

pub type Disabled {
  IsDisabled
  IsNotDisabled
}

Constructors

```
IsDisabled
```
```
IsNotDisabled
```

Slot

</>

Slots are used in child elements to insert content into this component

pub type Slot {
  Icon
}

Constructors

```
Icon
```

Values

current

</>

pub fn current(
  record: BreadcrumbItem,
  current: option.Option(
    breadcrumb_item_current.BreadcrumbItemCurrent,
  ),
) -> BreadcrumbItem

current sets the value of current for this BreadcrumbItem.

default_config

</>

pub fn default_config() -> Config

default_config is the default configuration for this component.

default_current

</>

pub const default_current: option.Option(
  breadcrumb_item_current.BreadcrumbItemCurrent,
)

default_disabled

</>

pub const default_disabled: Disabled

default_download

</>

pub const default_download: option.Option(String)

default_href

</>

pub const default_href: String

default_item_label

</>

pub const default_item_label: String

default_rel

</>

pub const default_rel: String

default_target

</>

pub const default_target: option.Option(link_target.LinkTarget)

disabled

</>

pub fn disabled(
  record: BreadcrumbItem,
  disabled: Disabled,
) -> BreadcrumbItem

disabled sets the value of disabled for this BreadcrumbItem.

download

</>

pub fn download(
  record: BreadcrumbItem,
  download: option.Option(String),
) -> BreadcrumbItem

download sets the value of download for this BreadcrumbItem.

from_config

</>

pub fn from_config(config: Config) -> BreadcrumbItem

from_config creates a new BreadcrumbItem from the given configuration.

href

</>

pub fn href(
  record: BreadcrumbItem,
  href: String,
) -> BreadcrumbItem

href sets the value of href for this BreadcrumbItem.

item_label

</>

pub fn item_label(
  record: BreadcrumbItem,
  item_label: String,
) -> BreadcrumbItem

item_label sets the value of item_label for this BreadcrumbItem.

new

</>

pub fn new() -> BreadcrumbItem

new creates a new BreadcrumbItem with the default configuration.

rel

</>

pub fn rel(record: BreadcrumbItem, rel: String) -> BreadcrumbItem

rel sets the value of rel for this BreadcrumbItem.

render

</>

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

render creates a Lustre Element for a BreadcrumbItem

render_config

</>

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

render_config creates a Lustre Element from a BreadcrumbItem Config

slot

</>

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

slot returns a Lustre Attribute(msg) for the given slot name

target

</>

pub fn target(
  record: BreadcrumbItem,
  target: option.Option(link_target.LinkTarget),
) -> BreadcrumbItem

target sets the value of target for this BreadcrumbItem.