Plushie.Widget.Row (Plushie v0.6.0)

Row layout -- arranges children horizontally.

Props

spacing (number) -- horizontal space between children in pixels. Default: 0.
padding (number | map) -- padding inside the row. See Plushie.Type.Padding.
width (length) -- width of the row. Default: shrink. See Plushie.Type.Length.
height (length) -- height of the row. Default: shrink.
align_y -- vertical alignment of children: :top, :center, :bottom. See Plushie.Type.Alignment.
max_width (number) -- maximum width of the row in pixels.
clip (boolean) -- clip children that overflow. Default: false.
wrap (boolean) -- wrap children to next row when they overflow. Default: false.
a11y (map) -- accessibility overrides. See Plushie.Type.A11y.

Summary

Types

option()

t()

Functions

a11y(row, a11y)

Sets accessibility annotations.

align_y(row, align_y)

Sets the vertical alignment of children.

build(row)

Converts this row struct to a ui_node() map via the Plushie.Widget protocol.

clip(row, clip)

Sets whether children that overflow are clipped.

extend(row, children)

Appends multiple children to the row.

height(row, height)

Sets the row height.

max_width(row, max_width)

Sets the maximum width of the row in pixels.

new(id, opts \\ [])

Creates a new row struct with optional keyword opts.

padding(row, padding)

Sets the padding inside the row.

push(row, child)

Appends a child to the row.

spacing(row, spacing)

Sets the spacing between children in pixels.

width(row, width)

Sets the row width.

with_options(row, opts)

Applies keyword options to an existing row struct.

wrap(row, wrap)

Sets whether children wrap to the next row on overflow.

Types

option()

@type option() ::
  {:spacing, number()}
  | {:padding, Plushie.Type.Padding.t()}
  | {:width, Plushie.Type.Length.t()}
  | {:height, Plushie.Type.Length.t()}
  | {:align_y, Plushie.Type.Alignment.t()}
  | {:max_width, number()}
  | {:clip, boolean()}
  | {:wrap, boolean()}
  | {:a11y, Plushie.Type.A11y.t() | map() | keyword()}

t()

@type t() :: %Plushie.Widget.Row{
  a11y: Plushie.Type.A11y.t() | nil,
  align_y: Plushie.Type.Alignment.t() | nil,
  children: [Plushie.Widget.child()],
  clip: boolean() | nil,
  height: Plushie.Type.Length.t() | nil,
  id: String.t(),
  max_width: number() | nil,
  padding: Plushie.Type.Padding.t() | nil,
  spacing: number() | nil,
  width: Plushie.Type.Length.t() | nil,
  wrap: boolean() | nil
}

Functions

align_y(row, align_y)

@spec align_y(row :: t(), align_y :: Plushie.Type.Alignment.t()) :: t()

Sets the vertical alignment of children.

build(row)

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

Converts this row struct to a ui_node() map via the Plushie.Widget protocol.

clip(row, clip)

@spec clip(row :: t(), clip :: boolean()) :: t()

Sets whether children that overflow are clipped.

extend(row, children)

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

Appends multiple children to the row.

height(row, height)

@spec height(row :: t(), height :: Plushie.Type.Length.t()) :: t()

Sets the row height.

max_width(row, max_width)

@spec max_width(row :: t(), max_width :: number()) :: t()

Sets the maximum width of the row in pixels.

new(id, opts \\ [])

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

Creates a new row struct with optional keyword opts.

padding(row, padding)

@spec padding(row :: t(), padding :: Plushie.Type.Padding.t()) :: t()

Sets the padding inside the row.

push(row, child)

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

Appends a child to the row.

spacing(row, spacing)

@spec spacing(row :: t(), spacing :: number()) :: t()

Sets the spacing between children in pixels.

width(row, width)

@spec width(row :: t(), width :: Plushie.Type.Length.t()) :: t()

Sets the row width.

with_options(row, opts)

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

Applies keyword options to an existing row struct.

wrap(row, wrap)

@spec wrap(row :: t(), wrap :: boolean()) :: t()

Sets whether children wrap to the next row on overflow.