Plushie.Widget.Floating (Plushie v0.7.1)

Floating overlay, positions child with optional translation and scaling.

Props

Name	Type	Default	Description
`translate_x`	`number()`	`nil`	Horizontal translation in pixels. Default: 0.
`translate_y`	`number()`	`nil`	Vertical translation in pixels. Default: 0.
`scale`	`number()`	`nil`	Scale factor for the child content.
`width`	`:fill \| :shrink \| {:fill_portion, pos_integer()} \| number()`	`nil`	Float width.
`height`	`:fill \| :shrink \| {:fill_portion, pos_integer()} \| number()`	`nil`	Float height.
`event_rate`	`integer()`	`nil`	Max events per second for coalescable events.
`a11y`	`%Plushie.Type.A11y{} \| map() \| keyword()`	`nil`	Accessibility annotations.

Summary

Types

option()

t()

Functions

a11y(widget, descriptor)

Accessibility annotations.

build(widget)

Converts this widget struct to a ui_node() map. Validates at most one child.

event_rate(widget, descriptor)

Max events per second for coalescable events.

extend(widget, children)

Appends multiple children to the widget.

float(id, opts \\ [])

Creates a :float widget.

height(widget, descriptor)

Float height.

new(id, opts \\ [])

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

push(widget, child)

Appends a child to the widget.

scale(widget, descriptor)

Scale factor for the child content.

translate_x(widget, descriptor)

Horizontal translation in pixels. Default: 0.

translate_y(widget, descriptor)

Vertical translation in pixels. Default: 0.

width(widget, descriptor)

Float width.

with_options(widget, opts)

Applies keyword options to an existing widget struct.

Types

option()

@type option() ::
  ((((({:translate_x, number()} | {:translate_y, number()})
      | {:scale, number()})
     | {:width, :fill | :shrink | {:fill_portion, pos_integer()} | number()})
    | {:height, :fill | :shrink | {:fill_portion, pos_integer()} | number()})
   | {: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.Floating{
  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,
  children: [Plushie.Widget.ui_node()],
  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(),
  scale:
    number()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  translate_x:
    number()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  translate_y:
    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
}

Functions

build(widget)

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

Converts this widget struct to a ui_node() map. Validates at most one child.

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.

float(id, opts \\ [])

(macro)

Creates a :float widget.

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

import Plushie.Widget.Floating, only: [float: 2]

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

height(widget, descriptor)

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

Float height.

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

new(id, opts \\ [])

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

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

push(widget, child)

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

Appends a child to the widget.

scale(widget, descriptor)

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

Scale factor for the child content.

Accepts number().

translate_x(widget, descriptor)

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

Horizontal translation in pixels. Default: 0.

Accepts number().

translate_y(widget, descriptor)

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

Vertical translation in pixels. Default: 0.

Accepts number().

width(widget, descriptor)

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

Float width.

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.