Plushie.Widget.Row (Plushie v0.7.0)

Copy Markdown View Source

Row layout, arranges children horizontally.

Props

NameTypeDefaultDescription
spacingnumber()nilHorizontal space between children in pixels. Default: 0.
paddingnumber() | {number(), number()} | %Plushie.Type.Padding{}nilPadding inside the row.
width:fill | :shrink | {:fill_portion, pos_integer()} | number()nilWidth of the row. Default: shrink.
height:fill | :shrink | {:fill_portion, pos_integer()} | number()nilHeight of the row. Default: shrink.
max_widthnumber()nilMaximum width in pixels.
align_y:left | :center | :right | :top | :bottomnilVertical alignment of children: :top, :center, :bottom.
clipboolean()nilClip children that overflow. Default: false.
wrapboolean()nilWrap children to next row when they overflow. Default: false.
event_rateinteger()nilMax events per second for coalescable events.
a11y%Plushie.Type.A11y{} | map() | keyword()nilAccessibility annotations.

Summary

Types

option()
t()

Functions

a11y(widget, descriptor)

Accessibility annotations.

align_y(widget, descriptor)

Vertical alignment of children: :top, :center, :bottom.

build(widget)

Converts this widget struct to a ui_node() map.

clip(widget, descriptor)

Clip children that overflow. Default: false.

event_rate(widget, descriptor)

Max events per second for coalescable events.

extend(widget, children)

Appends multiple children to the widget.

height(widget, descriptor)

Height of the row. Default: shrink.

max_width(widget, descriptor)

Maximum width in pixels.

new(id, opts \\ [])

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

padding(widget, descriptor)

Padding inside the row.

push(widget, child)

Appends a child to the widget.

row(id, opts \\ [])

Creates a :row widget.

spacing(widget, descriptor)

Horizontal space between children in pixels. Default: 0.

width(widget, descriptor)

Width of the row. Default: shrink.

with_options(widget, opts)

Applies keyword options to an existing widget struct.

wrap(widget, descriptor)

Wrap children to next row when they overflow. Default: false.

Types

option()

@type option() ::
  (((((((({:spacing, number()}
          | {:padding,
             number()
             | {number(), number()}
             | %Plushie.Type.Padding{
                 bottom: term(),
                 left: term(),
                 right: term(),
                 top: term()
               }})
         | {:width, :fill | :shrink | {:fill_portion, pos_integer()} | number()})
        | {:height, :fill | :shrink | {:fill_portion, pos_integer()} | number()})
       | {:max_width, number()})
      | {:align_y, :left | :center | :right | :top | :bottom})
     | {:clip, boolean()})
    | {:wrap, 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.Row{
  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,
  align_y:
    (:left | :center | :right | :top | :bottom)
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  children: [Plushie.Widget.ui_node()],
  clip:
    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(),
  max_width:
    number()
    | 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,
  spacing:
    number()
    | 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,
  wrap:
    boolean()
    | 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().

align_y(widget, descriptor)

@spec align_y(
  widget :: t(),
  value :: (:left | :center | :right | :top | :bottom) | nil
) :: t()

Vertical alignment of children: :top, :center, :bottom.

Accepts :left | :center | :right | :top | :bottom.

build(widget)

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

Converts this widget struct to a ui_node() map.

clip(widget, descriptor)

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

Clip children that overflow. 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().

extend(widget, children)

@spec extend(widget :: t(), children :: [Plushie.Widget.child()]) :: t()

Appends multiple children to the widget.

height(widget, descriptor)

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

Height of the row. Default: shrink.

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

max_width(widget, descriptor)

@spec max_width(widget :: t(), value :: number() | nil) :: t()

Maximum width in pixels.

Accepts number().

new(id, opts \\ [])

@spec new(id :: String.t(), opts :: [option()]) :: t()

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

padding(widget, descriptor)

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

Padding inside the row.

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

push(widget, child)

@spec push(widget :: t(), child :: Plushie.Widget.child()) :: t()

Appends a child to the widget.

row(id, opts \\ [])

(macro)

Creates a :row widget.

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

import Plushie.Widget.Row, only: [row: 2]

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

spacing(widget, descriptor)

@spec spacing(widget :: t(), value :: number() | nil) :: t()

Horizontal space between children in pixels. Default: 0.

Accepts number().

width(widget, descriptor)

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

Width of the row. 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.

wrap(widget, descriptor)

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

Wrap children to next row when they overflow. Default: false.

Accepts boolean().