View Source PlugLocale.Header (plug_locale v0.1.0)

Puts locale into assigns storage according to given HTTP request header.

By default, the used HTTP request header is x-client-locale. Although there's a standard HTTP header - accept-language, but it is better to use a custom header, because it is simpler and has no historical baggage to overcome.

Usage

First, we need to integrate this plug with other libraries, or this plug is useless. All you need is to construct a plug pipeline through Plug.Builder. For example:

defmodule DemoWeb.PlugMobileClientLocalization do
  use Plug.Builder

  plug PlugLocale.Header,
    default_locale: "en",
    locales: ["en", "zh"]

  plug :set_locale

  def set_locale(conn, _opts) do
    if locale conn.assigns[:locale] do
      # integrate with gettext
      Gettext.put_locale(locale)
    end

    conn
  end
end

Then, use it in router (following one is a Phoenix router, but Plug.Router is supported, too):

defmodule DemoWeb.Router do
  use DemoWeb, :router

  pipeline :api do
    plug :accepts, ["json"]

    # ...

    plug DemoWeb.PlugMobileClientLocalization

    # ...
  end

  scope "/", DemoWeb do
    pipe_through :api

    get "/", PageController, :index
    # ...
  end
end

Options

  • :default_locale - the default locale.
  • :locales - all the supported locales. Default to [].
  • :sanitize_locale - a function for sanitizing extracted or detected locales. Default to &PlugLocale.Sanitizer.sanitize/1 which does nothing. See PlugLocale.Sanitizer for more details.
  • :header_name - the header for getting locale. Default to "x-client-locale".
  • :assign_key - the key for putting value into assigns storage. Default to :locale.