m3e/card

card provides Lustre support for the M3E Card component

Types

Actionability

Actionability specifies if a card is interactive

pub type Actionability {
  Actionable
  Static
}

Constructors

```
Actionable
```
```
Static
```

Card

opaque </>

Card is a flexible, expressive container for presenting a unified subject

Fields:

actionability: Whether the card is “actionable” and will respond to user interaction
interaction: Whether the element is enabled or disabled
layout: Whether to present the card inline with surrounding content
link: Whether the card is a link
orientation: The orientation of the card
variant: The appearance variant of the card

pub opaque type Card

Config

</>

Config holds the configuration for a Card

pub type Config {
  Config(
    actionability: Actionability,
    interaction: types.Interaction,
    layout: Layout,
    link: option.Option(link.Link),
    orientation: types.Orientation,
    variant: Variant,
  )
}

Constructors

Config(
  actionability: Actionability,
  interaction: types.Interaction,
  layout: Layout,
  link: option.Option(link.Link),
  orientation: types.Orientation,
  variant: Variant,
)

Layout

</>

Layout specifies if a card is rendered inline or as a block

pub type Layout {
  Inline
  Block
}

Constructors

```
Inline
```
```
Block
```

Slot

</>

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

pub type Slot {
  Actions
  Content
  Footer
  Header
}

Constructors

```
Actions
```
```
Content
```
```
Footer
```
```
Header
```

Variant

</>

Variant is the appearance variant of the card

pub type Variant {
  Elevated
  Filled
  Outlined
}

Constructors

```
Elevated
```
```
Filled
```
```
Outlined
```

Values

actionable

</>

pub fn actionable(c: Card, a: Actionability) -> Card

actionable sets the actionability field of a Card

default_actionability

</>

pub const default_actionability: Actionability

default_config

</>

pub fn default_config() -> Config

default_config creates a new Config with default values

default_layout

</>

pub const default_layout: Layout

default_variant

</>

pub const default_variant: Variant

Default variant

disabled

</>

pub fn disabled(c: Card, i: types.Interaction) -> Card

disabled sets the interaction field of a Card

from_config

</>

pub fn from_config(c: Config) -> Card

from_config creates a Card from a Config record

inline

</>

pub fn inline(c: Card, l: Layout) -> Card

inline sets the layout field of a Card

link

</>

pub fn link(c: Card, link: option.Option(link.Link)) -> Card

link sets the link field of a Card

new

</>

pub fn new() -> Card

new creates a Card with default values

orientation

</>

pub fn orientation(c: Card, o: types.Orientation) -> Card

orientation sets the orientation field of a Card

render

</>

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

render creates a Lustre Element from a Card

Parameters:

c: a Card
attributes: a list of additional Attributes
children: a list of child Elements

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

variant

</>

pub fn variant(c: Card, v: Variant) -> Card

variant sets the variant field of a Card