button

Button widget builder.

Types

Button

opaque </>

pub opaque type Button

ButtonStyle

</>

pub type ButtonStyle {
  Primary
  Secondary
  Success
  Warning
  Danger
  TextStyle
  BackgroundStyle
  Subtle
  Custom(style_map.StyleMap)
}

Constructors

```
Primary
```
```
Secondary
```
```
Success
```
```
Warning
```
```
Danger
```
```
TextStyle
```
```
BackgroundStyle
```
```
Subtle
```
```
Custom(style_map.StyleMap)
```
Reusable-design-token style: pass a StyleMap for background, text_color, border, shadow, and state overrides. Matches the pattern Elixir / Python / TypeScript / Ruby already use.

Opt

</>

Option type for button properties.

pub type Opt {
  Style(ButtonStyle)
  Width(length.Length)
  Height(length.Length)
  Padding(padding.Padding)
  Clip(Bool)
  Disabled(Bool)
  A11y(a11y.A11y)
}

Constructors

```
Style(ButtonStyle)
```
```
Width(length.Length)
```
```
Height(length.Length)
```
```
Padding(padding.Padding)
```
```
Clip(Bool)
```
```
Disabled(Bool)
```
```
A11y(a11y.A11y)
```

Values

</>

pub fn a11y(button: Button, a: a11y.A11y) -> Button

Set accessibility properties for this button.

build

</>

pub fn build(button: Button) -> node.Node

Build the button into a renderable Node.

clip

</>

pub fn clip(button: Button, c: Bool) -> Button

Set whether child content that overflows is clipped.

disabled

</>

pub fn disabled(button: Button, d: Bool) -> Button

Set whether the button is disabled.

height

</>

pub fn height(button: Button, h: length.Length) -> Button

Set the button height.

height_animated

</>

pub fn height_animated(
  button: Button,
  animation: node.PropValue,
) -> Button

Set height to an animation descriptor (Transition, Spring, or Sequence). The descriptor must be pre-encoded via its module’s encode function.

new

</>

pub fn new(id: String, label: String) -> Button

Create a new button builder with the given ID and label.

padding

</>

pub fn padding(button: Button, p: padding.Padding) -> Button

Set the button padding.

padding_animated

</>

pub fn padding_animated(
  button: Button,
  animation: node.PropValue,
) -> Button

Set padding to an animation descriptor (Transition, Spring, or Sequence). The descriptor must be pre-encoded via its module’s encode function.

style

</>

pub fn style(button: Button, s: ButtonStyle) -> Button

Set the button style preset.

width

</>

pub fn width(button: Button, w: length.Length) -> Button

Set the button width.

width_animated

</>

pub fn width_animated(
  button: Button,
  animation: node.PropValue,
) -> Button

Set width to an animation descriptor (Transition, Spring, or Sequence). The descriptor must be pre-encoded via its module’s encode function.

with_opts

</>

pub fn with_opts(button: Button, opts: List(Opt)) -> Button

Apply a list of options to a button builder.