Plushie.Widget.Button (Plushie v0.7.0)

Copy Markdown View Source

Button, clickable widget that emits %WidgetEvent{type: :click} events.

The button can contain either a text label (via the label prop) or arbitrary child content (if children are provided, the first child is rendered).

Props

NameTypeDefaultDescription
labelString.t() | atom()requiredText label displayed on the button.
width:fill | :shrink | {:fill_portion, pos_integer()} | number()nilButton width. Default: shrink.
height:fill | :shrink | {:fill_portion, pos_integer()} | number()nilButton height. Default: shrink.
paddingnumber() | {number(), number()} | %Plushie.Type.Padding{}nilInternal padding.
clipboolean()nilClip child content that overflows. Default: false.

| style | :default \| :primary \| :secondary \| :success \| :danger \| :warning \| :dark \| :weak \| :rounded_box \| term() | nil | Named preset or custom StyleMap. | | disabled | boolean() | nil | Disable the button (no click events). Default: false. | | event_rate | integer() | nil | Max events per second for coalescable events. | | a11y | %Plushie.Type.A11y{} \| map() \| keyword() | %{role: :button, label_from: :label} | Accessibility annotations. |

Events

EventTypeDescription
:clicknoneEmitted on press (unless disabled).

Constructor

Button.new(id, label)
Button.new(id, label, opts)

Summary

Types

option()
t()

Functions

a11y(widget, descriptor)

Accessibility annotations.

build(widget)

Converts this widget struct to a ui_node() map.

button(id, opts \\ [])

Creates a :button widget.

clip(widget, descriptor)

Clip child content that overflows. Default: false.

disabled(widget, descriptor)

Disable the button (no click events). Default: false.

event_rate(widget, descriptor)

Max events per second for coalescable events.

height(widget, descriptor)

Button height. Default: shrink.

label(widget, descriptor)

Text label displayed on the button.

new(id, label, opts \\ [])

Creates a new widget struct with the given positional args and keyword options.

padding(widget, descriptor)

Internal padding.

style(widget, descriptor)

Named preset or custom StyleMap.

width(widget, descriptor)

Button width. Default: shrink.

with_options(widget, opts)

Applies keyword options to an existing widget struct.

Types

option()

@type option() ::
  (((((({:width, :fill | :shrink | {:fill_portion, pos_integer()} | number()}
        | {:height, :fill | :shrink | {:fill_portion, pos_integer()} | number()})
       | {:padding,
          number()
          | {number(), number()}
          | %Plushie.Type.Padding{
              bottom: term(),
              left: term(),
              right: term(),
              top: term()
            }})
      | {:clip, boolean()})
     | {:style,
        :default
        | :primary
        | :secondary
        | :success
        | :danger
        | :warning
        | :dark
        | :weak
        | :rounded_box
        | term()})
    | {:disabled, boolean()})
   | {:event_rate, integer()})
  | {:a11y,
     %Plushie.Type.A11y{
       active_descendant: term(),
       busy: term(),
       described_by: term(),
       description: term(),
       disabled: term(),
       error_message: term(),
       expanded: term(),
       has_popup: term(),
       hidden: term(),
       invalid: term(),
       label: term(),
       label_from: term(),
       labelled_by: term(),
       level: term(),
       live: term(),
       mnemonic: term(),
       modal: term(),
       orientation: term(),
       position_in_set: term(),
       radio_group: term(),
       read_only: term(),
       required: term(),
       role: term(),
       selected: term(),
       size_of_set: term(),
       toggled: term(),
       value: term()
     }
     | map()
     | keyword()}

t()

@type t() :: %Plushie.Widget.Button{
  a11y:
    (%Plushie.Type.A11y{
       active_descendant: term(),
       busy: term(),
       described_by: term(),
       description: term(),
       disabled: term(),
       error_message: term(),
       expanded: term(),
       has_popup: term(),
       hidden: term(),
       invalid: term(),
       label: term(),
       label_from: term(),
       labelled_by: term(),
       level: term(),
       live: term(),
       mnemonic: term(),
       modal: term(),
       orientation: term(),
       position_in_set: term(),
       radio_group: term(),
       read_only: term(),
       required: term(),
       role: term(),
       selected: term(),
       size_of_set: term(),
       toggled: term(),
       value: term()
     }
     | map()
     | keyword())
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  clip:
    boolean()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  disabled:
    boolean()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  event_rate:
    integer()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  height:
    (:fill | :shrink | {:fill_portion, pos_integer()} | number())
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  id: String.t(),
  label:
    (String.t() | atom())
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  padding:
    (number()
     | {number(), number()}
     | %Plushie.Type.Padding{
         bottom: term(),
         left: term(),
         right: term(),
         top: term()
       })
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  style:
    (:default
     | :primary
     | :secondary
     | :success
     | :danger
     | :warning
     | :dark
     | :weak
     | :rounded_box
     | term())
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  width:
    (:fill | :shrink | {:fill_portion, pos_integer()} | number())
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil
}

Functions

a11y(widget, descriptor)

@spec a11y(
  widget :: t(),
  value ::
    (%Plushie.Type.A11y{
       active_descendant: term(),
       busy: term(),
       described_by: term(),
       description: term(),
       disabled: term(),
       error_message: term(),
       expanded: term(),
       has_popup: term(),
       hidden: term(),
       invalid: term(),
       label: term(),
       label_from: term(),
       labelled_by: term(),
       level: term(),
       live: term(),
       mnemonic: term(),
       modal: term(),
       orientation: term(),
       position_in_set: term(),
       radio_group: term(),
       read_only: term(),
       required: term(),
       role: term(),
       selected: term(),
       size_of_set: term(),
       toggled: term(),
       value: term()
     }
     | map()
     | keyword())
    | nil
) :: t()

Accessibility annotations.

Accepts %Plushie.Type.A11y{} | map() | keyword().

build(widget)

@spec build(widget :: t()) :: Plushie.Widget.ui_node()

Converts this widget struct to a ui_node() map.

button(id, opts \\ [])

(macro)

Creates a :button widget.

Shorthand for new/2. Import this macro to use the widget name directly in view functions:

import Plushie.Widget.Button, only: [button: 2]

button("my-id", prop: value)

clip(widget, descriptor)

@spec clip(widget :: t(), value :: boolean() | nil) :: t()

Clip child content that overflows. Default: false.

Accepts boolean().

disabled(widget, descriptor)

@spec disabled(widget :: t(), value :: boolean() | nil) :: t()

Disable the button (no click events). Default: false.

Accepts boolean().

event_rate(widget, descriptor)

@spec event_rate(widget :: t(), value :: integer() | nil) :: t()

Max events per second for coalescable events.

Accepts integer().

height(widget, descriptor)

@spec height(
  widget :: t(),
  value :: (:fill | :shrink | {:fill_portion, pos_integer()} | number()) | nil
) :: t()

Button height. Default: shrink.

Accepts :fill | :shrink | {:fill_portion, pos_integer()} | number().

label(widget, descriptor)

@spec label(widget :: t(), value :: (String.t() | atom()) | nil) :: t()

Text label displayed on the button.

Accepts String.t() | atom().

new(id, label, opts \\ [])

Creates a new widget struct with the given positional args and keyword options.

Arguments

  • id - unique widget identifier
  • label - Text label displayed on the button.
  • opts - keyword list of optional props

padding(widget, descriptor)

@spec padding(
  widget :: t(),
  value ::
    (number()
     | {number(), number()}
     | %Plushie.Type.Padding{
         bottom: term(),
         left: term(),
         right: term(),
         top: term()
       })
    | nil
) :: t()

Internal padding.

Accepts number() | {number(), number()} | %Plushie.Type.Padding{}.

style(widget, descriptor)

@spec style(
  widget :: t(),
  value ::
    (:default
     | :primary
     | :secondary
     | :success
     | :danger
     | :warning
     | :dark
     | :weak
     | :rounded_box
     | term())
    | nil
) :: t()

Named preset or custom StyleMap.

Accepts :default | :primary | :secondary | :success | :danger | :warning | :dark | :weak | :rounded_box | term().

width(widget, descriptor)

@spec width(
  widget :: t(),
  value :: (:fill | :shrink | {:fill_portion, pos_integer()} | number()) | nil
) ::
  t()

Button width. Default: shrink.

Accepts :fill | :shrink | {:fill_portion, pos_integer()} | number().

with_options(widget, opts)

@spec with_options(widget :: t(), opts :: [option()]) :: t()

Applies keyword options to an existing widget struct.