Plushie.Widget.Sensor (Plushie v0.7.0)

Sensor, detects visibility and size changes on child content.

Props

Name	Type	Default	Description
`delay`	`integer()`	`nil`	Delay in milliseconds before emitting events.
`anticipate`	`number()`	`nil`	Distance in pixels to anticipate visibility.
`on_resize`	`String.t() \| atom()`	`nil`	Event tag for resize events.
`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.

anticipate(widget, descriptor)

Distance in pixels to anticipate visibility.

build(widget)

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

delay(widget, descriptor)

Delay in milliseconds before emitting events.

event_rate(widget, descriptor)

Max events per second for coalescable events.

extend(widget, children)

Appends multiple children to the widget.

new(id, opts \\ [])

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

on_resize(widget, descriptor)

Event tag for resize events.

push(widget, child)

Appends a child to the widget.

sensor(id, opts \\ [])

Creates a :sensor widget.

with_options(widget, opts)

Applies keyword options to an existing widget struct.

Types

option()

@type option() ::
  ((({:delay, integer()} | {:anticipate, number()})
    | {:on_resize, String.t() | atom()})
   | {: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.Sensor{
  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,
  anticipate:
    number()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  children: [Plushie.Widget.ui_node()],
  delay:
    integer()
    | 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,
  id: String.t(),
  on_resize:
    (String.t() | atom())
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil
}

Functions

anticipate(widget, descriptor)

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

Distance in pixels to anticipate visibility.

Accepts number().

build(widget)

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

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

delay(widget, descriptor)

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

Delay in milliseconds before emitting events.

Accepts integer().

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.

new(id, opts \\ [])

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

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

on_resize(widget, descriptor)

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

Event tag for resize events.

Accepts String.t() | atom().

push(widget, child)

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

Appends a child to the widget.

sensor(id, opts \\ [])

(macro)

Creates a :sensor widget.

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

import Plushie.Widget.Sensor, only: [sensor: 2]

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

with_options(widget, opts)

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

Applies keyword options to an existing widget struct.