Toddy.Iced.Widget.TextInput (Toddy v0.3.0)

Copy Markdown View Source

Text input field -- single-line editable text.

Emits %Widget{type: :input, id: id, value: value} on every keystroke.

Props

  • value (string) -- current text content. Required for controlled input.
  • placeholder (string) -- placeholder text shown when value is empty.

  • padding (number | map) -- internal padding. See Toddy.Iced.Padding.

  • width (length) -- input width. Default: fill. See Toddy.Iced.Length.
  • size (number) -- font size in pixels.

  • font (string | map) -- font specification. See Toddy.Iced.Font.

  • line_height (number | map) -- line height. Number is a relative multiplier; map with %{relative: n} or %{absolute: n} for explicit control.

  • align_x (atom) -- text horizontal alignment: :left, :center, :right. See Toddy.Iced.Alignment.
  • on_submit (any) -- when present (any truthy value), enables submit on Enter. Emits %Widget{type: :submit, id: id, value: value}.
  • id (string) -- widget ID for programmatic focus via Toddy.Command.focus/1.
  • style (atom) -- named style. Currently only :default.
  • icon (map) -- display an icon inside the input field. Map with keys:
    • code_point (string) -- single character to render as the icon. Required.
    • size (number) -- icon font size in pixels. Optional.
    • spacing (number) -- pixels between icon and text. Default: 4.0.
    • side (string) -- "left" or "right". Default: "left".

    • font (string | map) -- icon font. Default: system default.

  • on_paste (boolean) -- when true, emits %Widget{type: :paste, id: id, value: text} when user pastes text. Default: false.
  • secure (boolean) -- mask input as password dots. Default: false.
  • ime_purpose (string) -- IME input purpose hint: "normal", "secure", "terminal". Overrides the default derived from secure. Default: nil (auto from secure).
  • placeholder_color (color) -- placeholder text color. See Toddy.Iced.Color.
  • selection_color (color) -- text selection highlight color. See Toddy.Iced.Color.
  • a11y (map) -- accessibility overrides. See Toddy.Iced.A11y.

Events

  • %Widget{type: :input, id: id, value: value} -- emitted on every text change.
  • %Widget{type: :submit, id: id, value: value} -- emitted on Enter (requires on_submit prop).
  • %Widget{type: :paste, id: id, value: text} -- emitted on paste (requires on_paste prop).

Summary

Types

option()
style()
t()

Functions

a11y(ti, a11y)

Sets accessibility annotations.

align_x(ti, align_x)

Sets the horizontal text alignment.

build(ti)

Converts this text input struct to a ui_node() map via the Toddy.Iced.Widget protocol.

font(ti, font)

Sets the font.

icon(ti, icon)

Sets the icon displayed inside the input field.

ime_purpose(ti, ime_purpose)

Sets the IME input purpose hint. Overrides the default derived from secure.

line_height(ti, line_height)

Sets the line height.

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

Creates a new text input struct with the given value and optional keyword opts.

on_paste(ti, on_paste)

Enables or disables paste event emission.

on_submit(ti, on_submit)

Enables or disables submit on Enter.

padding(ti, padding)

Sets the internal padding.

placeholder(ti, placeholder)

Sets the placeholder text.

placeholder_color(ti, color)

Sets the placeholder text color. Accepts any form Color.cast/1 supports.

secure(ti, secure)

Sets whether input is masked as a password.

selection_color(ti, color)

Sets the text selection highlight color. Accepts any form Color.cast/1 supports.

size(ti, size)

Sets the font size in pixels.

style(ti, style)

Sets the input style.

width(ti, width)

Sets the input width.

with_options(ti, opts)

Applies keyword options to an existing text input struct.

Types

option()

@type option() ::
  {:placeholder, String.t()}
  | {:padding, Toddy.Iced.Padding.t()}
  | {:width, Toddy.Iced.Length.t()}
  | {:size, number()}
  | {:font, Toddy.Iced.Font.t()}
  | {:line_height, number() | map()}
  | {:align_x, Toddy.Iced.Alignment.t()}
  | {:icon, map()}
  | {:on_submit, boolean()}
  | {:on_paste, boolean()}
  | {:secure, boolean()}
  | {:ime_purpose, String.t()}
  | {:style, style()}
  | {:placeholder_color, Toddy.Iced.Color.input()}
  | {:selection_color, Toddy.Iced.Color.input()}
  | {:a11y, Toddy.Iced.A11y.t()}

style()

@type style() :: :default | Toddy.Iced.StyleMap.t()

t()

@type t() :: %Toddy.Iced.Widget.TextInput{
  a11y: Toddy.Iced.A11y.t() | nil,
  align_x: Toddy.Iced.Alignment.t() | nil,
  font: Toddy.Iced.Font.t() | nil,
  icon: map() | nil,
  id: String.t(),
  ime_purpose: String.t() | nil,
  line_height: number() | map() | nil,
  on_paste: boolean() | nil,
  on_submit: boolean() | nil,
  padding: Toddy.Iced.Padding.t() | nil,
  placeholder: String.t() | nil,
  placeholder_color: Toddy.Iced.Color.t() | nil,
  secure: boolean() | nil,
  selection_color: Toddy.Iced.Color.t() | nil,
  size: number() | nil,
  style: style() | nil,
  value: String.t(),
  width: Toddy.Iced.Length.t() | nil
}

Functions

a11y(ti, a11y)

@spec a11y(text_input :: t(), a11y :: Toddy.Iced.A11y.t()) :: t()

Sets accessibility annotations.

align_x(ti, align_x)

@spec align_x(text_input :: t(), align_x :: Toddy.Iced.Alignment.t()) :: t()

Sets the horizontal text alignment.

build(ti)

@spec build(text_input :: t()) :: Toddy.Iced.ui_node()

Converts this text input struct to a ui_node() map via the Toddy.Iced.Widget protocol.

font(ti, font)

@spec font(text_input :: t(), font :: Toddy.Iced.Font.t()) :: t()

Sets the font.

icon(ti, icon)

@spec icon(text_input :: t(), icon :: map()) :: t()

Sets the icon displayed inside the input field.

ime_purpose(ti, ime_purpose)

@spec ime_purpose(text_input :: t(), ime_purpose :: String.t()) :: t()

Sets the IME input purpose hint. Overrides the default derived from secure.

line_height(ti, line_height)

@spec line_height(text_input :: t(), line_height :: number() | map()) :: t()

Sets the line height.

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

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

Creates a new text input struct with the given value and optional keyword opts.

on_paste(ti, on_paste)

@spec on_paste(text_input :: t(), on_paste :: boolean()) :: t()

Enables or disables paste event emission.

on_submit(ti, on_submit)

@spec on_submit(text_input :: t(), on_submit :: boolean()) :: t()

Enables or disables submit on Enter.

padding(ti, padding)

@spec padding(text_input :: t(), padding :: Toddy.Iced.Padding.t()) :: t()

Sets the internal padding.

placeholder(ti, placeholder)

@spec placeholder(text_input :: t(), placeholder :: String.t()) :: t()

Sets the placeholder text.

placeholder_color(ti, color)

@spec placeholder_color(text_input :: t(), color :: Toddy.Iced.Color.input()) :: t()

Sets the placeholder text color. Accepts any form Color.cast/1 supports.

secure(ti, secure)

@spec secure(text_input :: t(), secure :: boolean()) :: t()

Sets whether input is masked as a password.

selection_color(ti, color)

@spec selection_color(text_input :: t(), color :: Toddy.Iced.Color.input()) :: t()

Sets the text selection highlight color. Accepts any form Color.cast/1 supports.

size(ti, size)

@spec size(text_input :: t(), size :: number()) :: t()

Sets the font size in pixels.

style(ti, style)

@spec style(text_input :: t(), style :: style()) :: t()

Sets the input style.

width(ti, width)

@spec width(text_input :: t(), width :: Toddy.Iced.Length.t()) :: t()

Sets the input width.

with_options(ti, opts)

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

Applies keyword options to an existing text input struct.