ExTeal v0.21.0

ExTeal.Fields.MultiSelect (ExTeal v0.21.0) View Source

The MultiSelect field may be used to generate a drop-down menu with multiple fields.

The select menu's options may be defined using the MultiSelect/with_options/2 function:

MultiSelect.make(:regions)
|> MultiSelect.with_options([%{value: 1, label: "USA"}, %{value: 2, label: "EU"}])

You can also return a list of maps with value, title, subtitle and thumbnail keys to use 'card' style taggables, useful when the multiselect represents a relationship.

Link to this section Summary

Types

card_option()
simple_option()
valid_option()
valid_options()

Functions

apply_options_for(field, model, conn, type)

Callback implementation for ExTeal.Field.apply_options_for/4.

as_html()
component()
default_sortable()

Callback implementation for ExTeal.Field.default_sortable/0.

field_name(name, label)
filterable_as()

Callback implementation for ExTeal.Field.filterable_as/0.

get(field, getter)
make(name, label \\ nil)

Callback implementation for ExTeal.Field.make/2.

options()
prefix_component()
sanitize_as()

Callback implementation for ExTeal.Field.sanitize_as/0.

show_on_detail()
show_on_edit()
show_on_index()
show_on_new()
value_for(field, model, method)

Callback implementation for ExTeal.Field.value_for/3.

with_options(field, options)

Link to this section Types

Link to this type

card_option()

View Source

Specs

card_option() :: %{
  :value => :integer | String.t(),
  :title => String.t(),
  optional(:subtitle) => String.t(),
  optional(:thumbnail) => String.t()
}
Link to this type

simple_option()

View Source

Specs

simple_option() :: %{value: :integer | String.t(), label: String.t()}
Link to this type

valid_option()

View Source

Specs

valid_option() :: simple_option() | card_option()
Link to this type

valid_options()

View Source

Specs

valid_options() :: [valid_option()]

Link to this section Functions

Link to this function

apply_options_for(field, model, conn, type)

View Source

Callback implementation for ExTeal.Field.apply_options_for/4.

Link to this function

as_html()

View Source
Link to this function

component()

View Source
Link to this function

default_sortable()

View Source

Callback implementation for ExTeal.Field.default_sortable/0.

Link to this function

field_name(name, label)

View Source
Link to this function

filterable_as()

View Source

Callback implementation for ExTeal.Field.filterable_as/0.

Link to this function

get(field, getter)

View Source
Link to this function

make(name, label \\ nil)

View Source

Callback implementation for ExTeal.Field.make/2.

Link to this function

options()

View Source
Link to this function

prefix_component()

View Source
Link to this function

sanitize_as()

View Source

Callback implementation for ExTeal.Field.sanitize_as/0.

Link to this function

show_on_detail()

View Source
Link to this function

show_on_edit()

View Source
Link to this function

show_on_index()

View Source
Link to this function

show_on_new()

View Source
Link to this function

value_for(field, model, method)

View Source

Callback implementation for ExTeal.Field.value_for/3.

Link to this function

with_options(field, options)

View Source

Specs

with_options(ExTeal.Field.t(), valid_options() | (() -> valid_options())) ::
  ExTeal.Field.t()