V Vaylan UI
Data input

Input

Render labelled inputs with descriptions and errors.

Preview

Change the example value; the preview reports the current state.

We will only use this for account notices.

  • must be at least 8 characters

Example

<.input field={@form[:email]} type="email" label="Email" required />

API contract

input/1 uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.

AttributeTypeRequiredDefault Accepted values
field {:struct, Phoenix.HTML.FormField} No nil Any value matching the declared type
id :string No nil Any value matching the declared type
name :string No nil Any value matching the declared type
label :string Yes — Any value matching the declared type
type :string No "text" Any value matching the declared type
value :any No nil Any value matching the declared type
description :string No nil Any value matching the declared type
errors :list No [] Any value matching the declared type
color :atom No nil [nil, :neutral, :primary, :secondary, :accent, :info, :success, :warning, :error]
size :atom No nil [:xs, :sm, :md, :lg, :xl, nil]
class :any No nil Any value matching the declared type
rest :global No — global includes ["accept", "autocomplete", "capture", "disabled", "form", "list", "max", "maxlength", "min", "minlength", "multiple", "pattern", "placeholder", "readonly", "required", "step"]

States and behavior

Default, disabled, described, and server-invalid states are supported. Text-like fields also pass applicable native read-only and required attributes.

Keyboard and accessibility

Behavioral tests

These automated checks are applied to this component by the package and documentation test suites.

  • ExUnit

    Accessible input state

    Passes native field attributes and connects labels, descriptions, validation errors, aria-invalid, and aria-describedby.

    test/vaylan_ui/primereact_adapted_contracts_test.exs
  • Adapted

    PrimeReact scenario adaptation

    Applies independently written Phoenix assertions derived from the documented PrimeReact 10.9.9 behavior group.

    test/vaylan_ui/primereact_adapted_contracts_test.exs
  • Docs

    Preview behavior contract

    Classified as input. Change the example value; the preview reports the current state.

    examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs
  • Docs

    Stable public component page

    Renders the component name, example, API contract, accepted values, and keyboard and accessibility guidance at its stable URL.

    examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs