Toddy.Iced.Widget.Pin (Toddy v0.3.0)

Pin layout -- positions child at absolute coordinates.

Props

x (number) -- x position in pixels. Default: 0.
y (number) -- y position in pixels. Default: 0.
width (length) -- pin container width. Default: shrink. See Toddy.Iced.Length.
height (length) -- pin container height. Default: shrink.
a11y (map) -- accessibility overrides. See Toddy.Iced.A11y.

Summary

Types

option()

t()

Functions

a11y(pin, a11y)

Sets accessibility annotations.

build(pin)

Converts this pin struct to a ui_node() map via the Toddy.Iced.Widget protocol.

extend(pin, children)

Appends multiple children to the pin.

height(pin, height)

Sets the pin container height.

new(id, opts \\ [])

Creates a new pin struct with optional keyword opts.

push(pin, child)

Appends a child to the pin.

width(pin, width)

Sets the pin container width.

with_options(pin, opts)

Applies keyword options to an existing pin struct.

x(pin, x)

Sets the x position in pixels.

y(pin, y)

Sets the y position in pixels.

Types

option()

@type option() ::
  {:x, number()}
  | {:y, number()}
  | {:width, Toddy.Iced.Length.t()}
  | {:height, Toddy.Iced.Length.t()}
  | {:a11y, Toddy.Iced.A11y.t()}

t()

@type t() :: %Toddy.Iced.Widget.Pin{
  a11y: Toddy.Iced.A11y.t() | nil,
  children: [Toddy.Iced.ui_node() | struct()],
  height: Toddy.Iced.Length.t() | nil,
  id: String.t(),
  width: Toddy.Iced.Length.t() | nil,
  x: number() | nil,
  y: number() | nil
}

Functions

build(pin)

@spec build(pin :: t()) :: Toddy.Iced.ui_node()

Converts this pin struct to a ui_node() map via the Toddy.Iced.Widget protocol.

extend(pin, children)

@spec extend(pin :: t(), children :: [Toddy.Iced.ui_node() | struct()]) :: t()

Appends multiple children to the pin.

height(pin, height)

@spec height(pin :: t(), height :: Toddy.Iced.Length.t()) :: t()

Sets the pin container height.

new(id, opts \\ [])

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

Creates a new pin struct with optional keyword opts.

push(pin, child)

@spec push(pin :: t(), child :: Toddy.Iced.ui_node() | struct()) :: t()

Appends a child to the pin.

width(pin, width)

@spec width(pin :: t(), width :: Toddy.Iced.Length.t()) :: t()

Sets the pin container width.

with_options(pin, opts)

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

Applies keyword options to an existing pin struct.

x(pin, x)

@spec x(pin :: t(), x :: number()) :: t()

Sets the x position in pixels.

y(pin, y)

@spec y(pin :: t(), y :: number()) :: t()

Sets the y position in pixels.