Behaviour for form field type renderers.

A field type is a module that knows how to render an input, sanitize and parse incoming params, validate the resulting value, and supply a default UI configuration. The DSL accepts either a built-in token (:text, :textarea, :select, …) or a module implementing this behaviour.

Example

defmodule MyApp.FieldTypes.Color do
  @behaviour MishkaGervaz.Form.Behaviours.FieldType
  use Phoenix.Component

  @impl true
  def render(assigns, _config) do
    ~H"""
    <input type="color" name={@name} value={@value} />
    """
  end

  @impl true
  def sanitize(value, _config), do: value

  @impl true
  def parse_params(value, _config), do: value

  @impl true
  def validate(value, _config), do: {:ok, value}

  @impl true
  def default_ui, do: %{type: :color}
end

Then use in DSL:

field :background_color, MyApp.FieldTypes.Color

Built-in implementations live under MishkaGervaz.Form.Types.Field.* (e.g. MishkaGervaz.Form.Types.Field.Hidden, MishkaGervaz.Form.Types.Field.Relation) and serve as reference implementations.

See MishkaGervaz.Form.Behaviours.Template, MishkaGervaz.Form.Entities.Field, and the MishkaGervaz.Form.Types.Field directory.