Kino.Input (Kino v0.4.1) View Source
Various input elements for entering data.
Examples
First, create an input and make sure it is rendered,
either by placing it at the end of a code cell or by
explicitly rendering it with Kino.render/1
.
input = Kino.Input.text("Name")
Then read the value at any later point:
name = Kino.Input.read(input)
Link to this section Summary
Functions
Creates a new checkbox.
Creates a new color input.
Creates a new number input.
Creates a new password input.
Creates a new slider input.
Synchronously reads the current input value.
Creates a new select input.
Subscribes the calling process to input changes.
Creates a new text input.
Creates a new multiline text input.
Unsubscribes the calling process from input events.
Creates a new URL input.
Link to this section Types
Specs
t() :: %Kino.Input{attrs: Kino.Output.input_attrs()}
Link to this section Functions
Specs
Creates a new checkbox.
The input value can be either true
or false
.
Options
:default
- the initial input value. Defaults tofalse
Specs
Creates a new color input.
The input value can be a hex color string.
Options
:default
- the initial input value. Defaults to#6583FF
Specs
Creates a new number input.
The input value is can be either a number or nil
.
Options
:default
- the initial input value. Defaults tonil
Specs
Creates a new password input.
This is similar to text input, except the content is not visible by default.
Options
:default
- the initial input value. Defaults to""
Specs
Creates a new slider input.
The input value can be either float in the configured range.
Options
:default
- the initial input value. Defaults to the minimum value:min
- the minimum value:max
- the maximum value:step
- the slider increment
Specs
Synchronously reads the current input value.
Note that to retrieve the value, the input must be rendered first, otherwise an error is raised.
Examples
input = Kino.Input.text("Name")
Kino.Input.read(input)
Specs
Creates a new select input.
The input expects a list of options in the form [{value, label}]
,
where value
is an arbitrary term and label
is a descriptive
string.
Options
:default
- the initial input value. Defaults to the first value from the given list of options
Examples
Kino.Input.select("Language", [en: "English", fr: "Français"])
Kino.Input.select("Language", [{1, "One"}, {2, "Two"}, {3, "Three"}])
Specs
Subscribes the calling process to input changes.
The events are sent as {tag, info}
.
See Kino.Control.subscribe/2
for more details.
Specs
Creates a new text input.
Options
:default
- the initial input value. Defaults to""
Specs
Creates a new multiline text input.
Options
:default
- the initial input value. Defaults to""
Specs
unsubscribe(t()) :: :ok
Unsubscribes the calling process from input events.
Specs
Creates a new URL input.
The input value can be either a valid URL string or nil
.
Options
:default
- the initial input value. Defaults tonil