Search documentation of Plushie

# Plushie.Widget.VerticalSlider (Plushie v0.7.2)

Copy Markdown View Source

Vertical slider, vertical range input.

## Props

Name | Type | Default | Description
--- | --- | --- | ---
`range` | `{number(), number()}` | required | `{min, max}` numeric range.
`value` | `number()` | required | Current slider value.
`step` | `number()` | `nil` | Step increment.
`shift_step` | `number()` | `nil` | Step increment when Shift is held.
`default` | `number()` | `nil` | Default value (double-click resets to this).
`width` | `number()` | `nil` | Slider width in pixels.
`height` | `:fill | :shrink | {:fill_portion, pos_integer()} | number()` | `nil` | Slider height. Default: fill.
`rail_color` | `String.t()` | `nil` | Color for the slider rail.
`rail_width` | `number()` | `nil` | Rail thickness in pixels.

| `style` | `:default \| :primary \| :secondary \| :success \| :danger \| :warning \| :dark \| :weak \| :rounded_box \| term()` | `nil` | Named preset or custom `StyleMap`. | | `label` | `String.t() \| atom()` | `nil` | Accessible label for the slider. | | `event_rate` | `integer()` | `nil` | Max events per second for coalescable events. | | `a11y` | `%Plushie.Type.A11y{} \| map() \| keyword()` | `%{role: :slider}` | Accessibility annotations. |

## Events

Event | Type | Description
--- | --- | ---
`:slide` | `value: number()` | Emitted continuously while dragging.
`:slide_release` | `value: number()` | Emitted when drag ends.

## Constructor

    VerticalSlider.new(id, range, value)
    VerticalSlider.new(id, range, value, opts)

## Summary

### Types

option()
t()

### Functions

a11y(widget, descriptor)

Accessibility annotations.

build(widget)

Converts this widget struct to a `ui_node()` map.

default(widget, descriptor)

Default value (double-click resets to this).

event_rate(widget, descriptor)

Max events per second for coalescable events.

height(widget, descriptor)

Slider height. Default: fill.

label(widget, descriptor)

Accessible label for the slider.

new(id, range, value, opts \\ [])

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

rail_color(widget, descriptor)

Color for the slider rail.

rail_width(widget, descriptor)

Rail thickness in pixels.

range(widget, descriptor)

`{min, max}` numeric range.

shift_step(widget, descriptor)

Step increment when Shift is held.

step(widget, descriptor)

Step increment.

style(widget, descriptor)

Named preset or custom `StyleMap`.

value(widget, descriptor)

Current slider value.

vertical_slider(id, opts \\ [])

Creates a `:vertical_slider` widget.

width(widget, descriptor)

Slider width in pixels.

with_options(widget, opts)

Applies keyword options to an existing widget struct.

## Types

# option()

    @type option() ::
      ((((((((({:step, number()} | {:shift_step, number()}) | {:default, number()})
             | {:width, number()})
            | {:height, :fill | :shrink | {:fill_portion, pos_integer()} | number()})
           | {:rail_color, atom() | String.t() | map()})
          | {:rail_width, number()})
         | {:style,
            :default
            | :primary
            | :secondary
            | :success
            | :danger
            | :warning
            | :dark
            | :weak
            | :rounded_box
            | term()})
        | {:label, 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.VerticalSlider{
      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,
      default:
        number()
        | 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(),
      label:
        (String.t() | atom())
        | Plushie.Animation.Transition.t()
        | Plushie.Animation.Spring.t()
        | Plushie.Animation.Sequence.t()
        | nil,
      rail_color:
        String.t()
        | Plushie.Animation.Transition.t()
        | Plushie.Animation.Spring.t()
        | Plushie.Animation.Sequence.t()
        | nil,
      rail_width:
        number()
        | Plushie.Animation.Transition.t()
        | Plushie.Animation.Spring.t()
        | Plushie.Animation.Sequence.t()
        | nil,
      range:
        {number(), number()}
        | Plushie.Animation.Transition.t()
        | Plushie.Animation.Spring.t()
        | Plushie.Animation.Sequence.t()
        | nil,
      shift_step:
        number()
        | Plushie.Animation.Transition.t()
        | Plushie.Animation.Spring.t()
        | Plushie.Animation.Sequence.t()
        | nil,
      step:
        number()
        | Plushie.Animation.Transition.t()
        | Plushie.Animation.Spring.t()
        | Plushie.Animation.Sequence.t()
        | nil,
      style:
        (:default
         | :primary
         | :secondary
         | :success
         | :danger
         | :warning
         | :dark
         | :weak
         | :rounded_box
         | term())
        | Plushie.Animation.Transition.t()
        | Plushie.Animation.Spring.t()
        | Plushie.Animation.Sequence.t()
        | nil,
      value:
        number()
        | Plushie.Animation.Transition.t()
        | Plushie.Animation.Spring.t()
        | Plushie.Animation.Sequence.t()
        | nil,
      width:
        number()
        | 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()`.

# build(widget)

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

Converts this widget struct to a `ui_node()` map.

# default(widget, descriptor)

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

Default value (double-click resets to this).

Accepts `number()`.

# event_rate(widget, descriptor)

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

Max events per second for coalescable events.

Accepts `integer()`.

# height(widget, descriptor)

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

Slider height. Default: fill.

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

# label(widget, descriptor)

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

Accessible label for the slider.

Accepts `String.t() | atom()`.

# new(id, range, value, opts \\ [])

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

## Arguments

- `id` - unique widget identifier
- `range` - `{min, max}` numeric range.
- `value` - Current slider value.
- `opts` - keyword list of optional props

# rail_color(widget, descriptor)

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

Color for the slider rail.

Accepts `String.t()`.

# rail_width(widget, descriptor)

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

Rail thickness in pixels.

Accepts `number()`.

# range(widget, descriptor)

    @spec range(widget :: t(), value :: {number(), number()} | nil) :: t()

`{min, max}` numeric range.

Accepts `{number(), number()}`.

# shift_step(widget, descriptor)

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

Step increment when Shift is held.

Accepts `number()`.

# step(widget, descriptor)

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

Step increment.

Accepts `number()`.

# style(widget, descriptor)

    @spec style(
      widget :: t(),
      value ::
        (:default
         | :primary
         | :secondary
         | :success
         | :danger
         | :warning
         | :dark
         | :weak
         | :rounded_box
         | term())
        | nil
    ) :: t()

Named preset or custom `StyleMap`.

Accepts `:default | :primary | :secondary | :success | :danger | :warning | :dark | :weak | :rounded_box | term()`.

# value(widget, descriptor)

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

Current slider value.

Accepts `number()`.

# vertical_slider(id, opts \\ [])

(macro)

Creates a `:vertical_slider` widget.

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

    import Plushie.Widget.VerticalSlider, only: [vertical_slider: 2]

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

# width(widget, descriptor)

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

Slider width in pixels.

Accepts `number()`.

# with_options(widget, opts)

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

Applies keyword options to an existing widget struct.