CircleCI

Formulator

Formulator is part of the thoughtbot Elixir family of projects.

Usage

Formulator is a library for Phoenix to give you:

  • A label for your input, based on the attribute name
  • An error label
  • A class around the input if there is an error for the attribute. This allows you to easily style inputs that have errors.

You can replace the following:

  <%= label form, :email %>
  <%= text_input form, :email %>
  <%= error_tag form, :email %>

with this:

  <%= input form, :email %>

You also get the added benefit of having a class of has-error on the input when there is an error associated with the attribute.

By default, Formulator assumes that you want a standard text input but if you prefer, you can also specify the input type:

  <%= input form, :description, as: :textarea %>

Installation

Add formulator to your list of dependencies in mix.exs:

  def deps do
    [
      {:formulator, "~> 0.0.6"},
    ]
  end
  $ mix deps.get

Formulator needs to know what module to use for the translate_error/1 function. This is commonly defined by Phoenix either in web/views/error_helper.ex or web/gettext.ex.

  # config/config.exs
  config :formulator, translate_error_module: YourAppName.ErrorHelpers

You can import the package into all your views or individually as it makes sense:

  # web/web.ex
  def view do
    quote do
      ...
      import Formulator
      ...
    end
  end

Contributing

See the CONTRIBUTING document. Thank you, contributors!

License

Formulator is Copyright (c) 2015 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

thoughtbot

Formulator is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software, Elixir, and Phoenix. See our other Elixir projects, or hire our Elixir/Phoenix development team to design, develop, and grow your product.