Raxol.UI.Components.Input.SelectList.Selection (Raxol v2.0.1)

Selection management for SelectList component.

Summary

Functions

get_selected_option(state)

Gets the currently selected option.

get_selected_value(state)

Gets the value of the currently selected option.

is_selected?(state, index) deprecated

move_down(state)

Moves selection down by one.

move_up(state)

Moves selection up by one.

select_by_value(state, target_value)

Selects an option by its value.

select_first(state)

Moves selection to the first item.

select_last(state)

Moves selection to the last item.

selected?(state, index)

Checks if an index is the selected one.

update_selection_state(state, index)

Updates the selection state with a new index.

Functions

get_selected_option(state)

@spec get_selected_option(Raxol.UI.Components.Input.SelectList.t()) :: any() | nil

Gets the currently selected option.

get_selected_value(state)

@spec get_selected_value(Raxol.UI.Components.Input.SelectList.t()) :: any() | nil

Gets the value of the currently selected option.

is_selected?(state, index)

This function is deprecated. Use selected?/2 instead.

move_down(state)

@spec move_down(Raxol.UI.Components.Input.SelectList.t()) ::
  {Raxol.UI.Components.Input.SelectList.t(), list()}

Moves selection down by one.

move_up(state)

@spec move_up(Raxol.UI.Components.Input.SelectList.t()) ::
  {Raxol.UI.Components.Input.SelectList.t(), list()}

Moves selection up by one.

select_by_value(state, target_value)

@spec select_by_value(Raxol.UI.Components.Input.SelectList.t(), any()) ::
  {Raxol.UI.Components.Input.SelectList.t(), list()}

Selects an option by its value.

select_first(state)

@spec select_first(Raxol.UI.Components.Input.SelectList.t()) ::
  {Raxol.UI.Components.Input.SelectList.t(), list()}

Moves selection to the first item.

select_last(state)

@spec select_last(Raxol.UI.Components.Input.SelectList.t()) ::
  {Raxol.UI.Components.Input.SelectList.t(), list()}

Moves selection to the last item.

selected?(state, index)

@spec selected?(Raxol.UI.Components.Input.SelectList.t(), non_neg_integer()) ::
  boolean()

Checks if an index is the selected one.

update_selection_state(state, index)

@spec update_selection_state(
  Raxol.UI.Components.Input.SelectList.t(),
  non_neg_integer()
) ::
  {Raxol.UI.Components.Input.SelectList.t(), list()}

Updates the selection state with a new index.