Per-page metadata for Phoenix LiveView apps: breadcrumbs, active-link state, SEO meta tag rendering.

Setup

In your project's PageMeta module:

defmodule MyAppWeb.PageMeta do
  use PhoenixPageMeta

  @enforce_keys [:title, :path]
  defstruct [
    :title,
    :path,
    :breadcrumb_title,
    :parent,
    :description,
    :og_image,
    :json_ld,
    :canonical_path,
    :icon,
    :skip_breadcrumb,
    og_type: "website",
    noindex: false,
    supported_locales: [:en, :es]
  ]
end

That's it. No config.exs entry. The macro provides default implementations of base_url/0 (auto-detected from the module's namespace, e.g. MyAppWeb.PageMeta → MyAppWeb.Endpoint.url()) and lang_path/2 (locale-prefix swap on :path). Both are defoverridable if you need a different scheme.

use options

• :base_url — accepts a string ("https://example.com") or a 0-arity function capture (&MyAppWeb.Endpoint.url/0). When omitted, the macro guesses the Endpoint module from your PageMeta's namespace.

In LiveViews

In MyAppWeb.live_view/0:

def live_view do
  quote do
    use Phoenix.LiveView, layout: ...
    @behaviour PhoenixPageMeta.LiveView
    import PhoenixPageMeta.LiveView, only: [assign_page_meta: 1]
  end
end

In each LiveView:

defmodule MyAppWeb.SomeLive do
  use MyAppWeb, :live_view

  @impl PhoenixPageMeta.LiveView
  def page_meta(_socket, _action) do
    %MyAppWeb.PageMeta{title: "Hello", path: "/hello"}
  end

  def mount(_params, _session, socket) do
    {:ok, assign_page_meta(socket)}
  end
end

See PhoenixPageMeta.Breadcrumb, PhoenixPageMeta.Components.Breadcrumbs, PhoenixPageMeta.Components.MetaTags, PhoenixPageMeta.Site, and PhoenixPageMeta.LiveView.