Phoenix Live Head
Provides commands for manipulating the HTML Head of Phoenix Live View applications while minimizing data over the wire.
The available command actions support a variety of utility operations useful for HTML Head manipulation. Such as setting or removing tag attributes and adding or removing CSS classes for vector (SVG) favicons.
Note
This lib is not meant to be used directly. Have a look at
Phx.Live.Favicon
andPhx.Live.Metadata
. Those libs provide a cleaner syntax and specific documentation for their intended usage.
installation
Installation
If available in Hex, the package can be installed
by adding phoenix_live_head
to your list of dependencies in mix.exs
:
def deps do
[
{:phoenix_live_head, "~> 0.1.1"}
]
end
To include the necessary client side Javascript, import the module in assets/js/app.js
import "phoenix_html"
// Establish Phoenix Socket and LiveView configuration.
import { Socket } from "phoenix"
import { LiveSocket } from "../vendor/phoenix_live_view/"
import topbar from "../vendor/topbar"
import "phoenix_live_head" // <-- ADD HERE.
Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/phoenix_live_head.