Elixir Phoenix поле формы один лайнер


Необходимость — мать изобретения.

Существует несколько способов абстрагировать стилизацию формы, но я лично считаю, что самый простой способ сделать поля формы — это создать свои собственные вспомогательные функции, и мне нравятся результаты такой работы.

Что вы хотите сделать.

  • Я хочу иметь возможность писать каждое поле формы в одной строке.
  • Я хочу автоматически применять общие классы CSS.

Например, у меня есть следующие поля формы, созданные командой mix phx.gen.auth.

<%= label f, :email %>
<%= email_input f, :email, required: true %>
<%= error_tag f, :email %>
Войдите в полноэкранный режим Выход из полноэкранного режима

Мы хотим описать его в одной лаконичной строке, включая общие классы CSS, вот так

<%= bulma_input f, :email %>
Войдите в полноэкранный режим Выход из полноэкранного режима

Операционная среда

elixir          1.13.4-otp-24
erlang          24.3.4
Войдите в полноэкранный режим Выход из полноэкранного режима
❯ mix phx.new --version
Phoenix installer v1.6.8
Войдите в полноэкранный режим Выход из полноэкранного режима

Идеи

Знания и идеи, необходимые для написания пользовательских помощников представления, подробно описаны Хосе Валимом, автором языка Elixir, в этой статье (Динамические формы с Phoenix).
Так что вы можете получить общее представление, прочитав это.

Кроме того, сам Phoenix имеет множество встроенных вспомогательных функций, таких как Phoenix.HTML.Form, поэтому важно использовать их в полной мере.

Попробуйте.

Создайте файл lib/my_app_web/views/input_helpers.ex.

defmodule MyAppWeb.InputHelpers do
  use Phoenix.HTML

  # TODO: define my custom view helper functions
end
Войдите в полноэкранный режим Выход из полноэкранного режима

Не забудьте импортировать его с помощью функции view_helpers в lib/my_app_web.ex.

   defp view_helpers do
     quote do
       # Use all HTML functionality (forms, tags, etc)
       use Phoenix.HTML

       # Import LiveView and .heex helpers (live_render, live_patch, <.form>, etc)
       import Phoenix.LiveView.Helpers
       import MyAppWeb.LiveHelpers

       # Import basic rendering functionality (render, render_layout, etc)
       import Phoenix.View

+      import MyAppWeb.InputHelpers
       import MyAppWeb.ErrorHelpers
       import MyAppWeb.Gettext
       alias MyAppWeb.Router.Helpers, as: Routes
     end
   end
Войдите в полноэкранный режим Выход из полноэкранного режима

Затем просто определите вспомогательные функции в MyAppWeb.InputHelpers по своему усмотрению.
На днях я случайно играл с фреймворком Bulma CSS и сделал один для него.
Это может быть пример кода.

defmodule MyAppWeb.InputHelpers do
  use Phoenix.HTML

  def bulma_input(form, field, opts \ []) do
    label_opts = Keyword.take(opts, ~w[required label]a)
    input_opts = Keyword.drop(opts, ~w[required label]a)

    content_tag :div, class: "field" do
      [
        build_label(form, field, label_opts),
        build_input(form, field, input_opts),
        MyAppWeb.ErrorHelpers.error_tag(form, field)
      ]
    end
  end

  def bulma_checkbox(form, field, opts \ []) do
    content_tag :label, class: "checkbox" do
      [
        checkbox(form, field, opts),
        ' ',
        opts[:label] || field |> to_string() |> Phoenix.Naming.humanize()
      ]
    end
  end

  defp build_label(form, field, opts) do
    required = opts[:required] || Keyword.get(input_validations(form, field), :required)
    label_text = (opts[:label] || humanize(field)) <> if required, do: " *", else: ""

    Phoenix.HTML.Form.label(form, field, label_text, class: "label")
  end

  defp build_input(form, field, opts) do
    input_fun_name = opts[:using] || Phoenix.HTML.Form.input_type(form, field)
    permitted_attributes = Keyword.drop(opts, [:using])

    input_class =
      case input_fun_name do
        :textarea -> "textarea "
        _ -> "input "
      end <> form_state_class(form, field)

    input_opts =
      [{:class, input_class} | permitted_attributes]
      |> Enum.reject(&is_nil(elem(&1, 1)))

    content_tag :div, class: "control" do
      apply(Phoenix.HTML.Form, input_fun_name, [form, field, input_opts])
    end
  end

  defp form_state_class(form, field) do
    cond do
      # Some forms may not use a Map as a source. E.g., :user
      !is_map(form.source) -> ""
      # Ignore Conn-based form.
      Map.get(form.source, :__struct__) == Plug.Conn -> ""
      # The form is not yet submitted.
      !Map.get(form.source, :action) -> ""
      # This field has an error.
      form.errors[field] -> "is-danger"
      true -> "is-success"
    end
  end
end
Войдите в полноэкранный режим Выход из полноэкранного режима

В lib/my_app_web/views/error_helpers.ex есть сгенерированный Фениксом error_tag, поэтому при необходимости измените CSS-класс там.

   def error_tag(form, field) do
     Enum.map(Keyword.get_values(form.errors, field), fn error ->
       content_tag(:span, translate_error(error),
-       class: "invalid-feedback",
+       class: "invalid-feedback help is-danger",
         phx_feedback_for: input_name(form, field)
       )
     end)
Войдите в полноэкранный режим Выход из полноэкранного режима

Теперь у вас есть функция bulma_input, которая генерирует поле формы в стиле Bulma.

bulma_input f, :email
Войдите в полноэкранный режим Выход из полноэкранного режима

У вас также есть возможность переключить функцию Phoenix.HTML.Form для использования.

# Phoenix.HTML.Form.text_input/3の代わりにPhoenix.HTML.Form.textarea/3を使用したい場合
bulma_input f, :email, using: :textarea
Войдите в полноэкранный режим Выход из полноэкранного режима

Позволяет добавлять дополнительные атрибуты HTML, если это необходимо.

bulma_input f, :email, placeholder: "E-mail", autocomplete: "off"
Войдите в полноэкранный режим Выход из полноэкранного режима

Валидация на IEx

Было бы быстрее реализовать форму на шаблоне, но мне было интересно найти способ запустить ее на IEx.

Я нашел подсказку в тесте исходного кода Phoenix, поэтому я использовал эти знания, чтобы сгенерировать форму соответствующим образом.

iex

alias MyAppWeb.Accounts
alias MyAppWeb.Accounts.User

changeset = Accounts.change_user_registration(%User{})
form = Phoenix.HTML.Form.form_for(changeset, "/registration", [])

bulma_input(form, :email, placeholder: "E-mail", autocomplete: "off")
|> Phoenix.HTML.Safe.to_iodata()
|> to_string()
|> IO.puts()
Войдите в полноэкранный режим Выход из полноэкранного режима
<div class="field">
  <label class="label" for="user_email">Email *</label>
  <div class="control">
    <input autocomplete="off" class="input " id="user_email" name="user[email]" placeholder="E-mail" type="email">
  </div>
</div>
Войдите в полноэкранный режим Выход из полноэкранного режима

🎉

Если вы новичок в сообществе Elixir, мы рекомендуем следующее

Как пройтись по сообществу Elixir — отечественная онлайн-версия

https://speakerdeck.com/elijo/elixirkomiyunitei-falsebu-kifang-guo-nei-onrainbian

В Японии существует 28 сообществ Elixir

Календарь событий Elixir 📆 для поиска событий по дате.

** Календарь событий ** Эликсир

https://elixir-jp-calendar.fly.dev/

Оцените статью
Procodings.ru
Добавить комментарий