- 1.4.1

Input

Renders an input with label and error messages.

Read more Read less

A Phoenix.HTML.FormField may be passed as argument, which is used to retrieve the input name, id, and values. Otherwise all attributes may be passed explicitly.

Types

This function accepts all HTML input types, considering that:

  • You may also set type="select" to render a <select> tag

  • type="checkbox" is used exclusively to render boolean values

  • For live file uploads, see Phoenix.Component.live_file_input/1

See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input for more information. Unsupported types, such as hidden and radio, are best written directly in your templates.

Examples

<.input field={@form[:email]} type="email" />
<.input name="my-input" errors={["oh no!"]} />
Attribute Type Documentation Default Value
id :any
name :any
label :string
value :any
type :string "text"
field %FormField{}

a form field struct retrieved from the form, for example: @form[:email]
errors :list []
checked :boolean

the checked flag for checkbox inputs
prompt :string

the prompt for select inputs
options :list

the options to pass to Phoenix.HTML.Form.options_for_select/2
multiple :boolean

the multiple flag for select inputs
false
rest :global