Skip to content
Rich, real-time user experiences with server-rendered HTML
Branch: master
Clone or download
Latest commit 90d240f May 15, 2019

Phoenix LiveView

Build Status

Phoenix LiveView enables rich, real-time user experiences with server-rendered HTML. For more information, see the initial announcement.

Note: Currently LiveView is under active development and we are focused on getting a stable and solid initial version out. For this reason, we will be accepting only bug reports in the issues tracker for now. We will open the issues tracker for features after the current milestone is ironed out.


As official guides are being developed, see our existing comprehensive docs and examples to get up to speed:


Currently LiveView is only available from GitHub. To use it, add to your mix.exs and run mix deps.get:

def deps do
    {:phoenix_live_view, github: "phoenixframework/phoenix_live_view"}

Once installed, update your endpoint's configuration to include a signing salt. You can generate a signing salt by running mix phx.gen.secret 32.

# config/config.exs

config :my_app, MyAppWeb.Endpoint,
   live_view: [
     signing_salt: "SECRET_SALT"

Next, add the LiveView flash plug to your browser pipeline, after :fetch_flash:

# lib/my_app_web/router.ex

pipeline :browser do
  plug :fetch_flash
  plug Phoenix.LiveView.Flash

Then add the following imports to your web file in lib/my_app_web.ex:

# lib/my_app_web.ex

def controller do
  quote do
    import Phoenix.LiveView.Controller, only: [live_render: 3]

def view do
  quote do
    import Phoenix.LiveView, only: [live_render: 2, live_render: 3]

def router do
  quote do
    import Phoenix.LiveView.Router

Next, expose a new socket for LiveView updates in your app's endpoint module.

# lib/my_app_web/endpoint.ex

defmodule MyAppWeb.Endpoint do
  use Phoenix.Endpoint

  socket "/live", Phoenix.LiveView.Socket

  # ...

Add LiveView NPM dependencies in your assets/package.json.

  "dependencies": {
    "phoenix": "file:../deps/phoenix",
    "phoenix_html": "file:../deps/phoenix_html",
    "phoenix_live_view": "file:../deps/phoenix_live_view"

Then install the new npm dependency.

npm install --prefix assets

If you had previously installed phoenix_live_view and want to get the latest javascript, then force an install.

(cd assets && npm install --force phoenix_live_view)

Enable connecting to a LiveView socket in your app.js file.

// assets
import LiveSocket from "phoenix_live_view"

let liveSocket = new LiveSocket("/live")

Finally, by convention live views are saved in a lib/my_app_web/live/ directory. For live page reload support, add the following pattern to your config/dev.exs:

# config/dev.exs
config :demo, MyAppWeb.Endpoint,
  live_reload: [
    patterns: [

You can also optionally import the style for the default CSS classes in your app.css file.

/* assets/css/app.css */
@import "../../deps/phoenix_live_view/assets/css/live_view.css";

Browser Support

All current Chrome, Safari, Firefox, and MS Edge are supported. IE11 support is available with the following polyfills:

$ npm install --save --prefix assets mdn-polyfills url-search-params-polyfill formdata-polyfill
import "mdn-polyfills/NodeList.prototype.forEach"
import "mdn-polyfills/Element.prototype.closest"
import "mdn-polyfills/Element.prototype.matches"
import "url-search-params-polyfill"
import "formdata-polyfill"

import {LiveSocket} from "phoenix_live_view"
You can’t perform that action at this time.