Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/phoenixframework/phoenix_live_view/llms.txt

Use this file to discover all available pages before exploring further.

Helpers for rendering LiveViews from a controller.

​
Overview

The Phoenix.LiveView.Controller module provides functions for rendering LiveViews from within traditional Phoenix controllers. This is useful when you need to render a LiveView as part of a regular controller action rather than through the router.

​
Functions

​
live_render/3

Renders a live view from a Plug request and sends an HTML response from within a controller. 
live_render(conn, view, opts \\ [])
​
conn
Plug.Conn.t()
required
The connection struct from the controller
​
view
module
required
The LiveView module to render
​
opts
keyword
Options for rendering the LiveView. See Phoenix.Component.live_render/3 for all supported options.Common options include:
  • :session - Session data to pass to the LiveView’s mount callback
  • :container - HTML container configuration
  • :id - The DOM ID for the LiveView
​
conn
Plug.Conn.t()
The connection with the rendered LiveView response
Automatically sets the @live_module assign with the value of the LiveView being rendered.

​
Examples

Basic usage: 
defmodule MyAppWeb.ThermostatController do
  use MyAppWeb, :controller
  import Phoenix.LiveView.Controller

  def show(conn, %{"id" => thermostat_id}) do
    live_render(conn, MyAppWeb.ThermostatLive, session: %{
      "thermostat_id" => thermostat_id,
      "current_user_id" => get_session(conn, :user_id)
    })
  end
end
With custom container: 
def dashboard(conn, _params) do
  live_render(conn, MyAppWeb.DashboardLive,
    session: %{"user_id" => conn.assigns.current_user.id},
    container: {:div, class: "dashboard-container"}
  )
end
Passing session data: 
def show(conn, %{"id" => id}) do
  live_render(conn, MyAppWeb.ShowLive, session: %{
    "resource_id" => id,
    "user_token" => get_session(conn, :user_token),
    "locale" => get_session(conn, :locale)
  })
end

​
Behavior

The function handles different scenarios:
  1. Successful render: Returns the rendered HTML content with proper assigns
  2. Redirect: If the LiveView redirects during mount, follows the redirect appropriately
  3. Live redirect: Handles live navigation redirects with flash messages

​
Integration

To use this module in your controllers, import it in your controller base: 
defmodule MyAppWeb do
  def controller do
    quote do
      use Phoenix.Controller
      import Phoenix.LiveView.Controller
      # ... other imports
    end
  end
end
Then it will be available in all controllers: 
defmodule MyAppWeb.PageController do
  use MyAppWeb, :controller

  def index(conn, _params) do
    live_render(conn, MyAppWeb.PageLive)
  end
end

Build docs developers (and LLMs) love

Get started for freeTalk to us