KinoPhoenixLiveview.RootLive (kino_phoenix_live_view v0.1.1)

The default LiveView for KinoPhoenixLiveview, used both to verify LiveView interactions and to guide developers on how to customize the integration.

This LiveView displays a simple toggle button along with instructions on how to:

  • Replace the default LiveView with a custom one.
  • Override the layout by providing a custom module.
  • Override the router or endpoint.

Developers can use these instructions as a starting point to build their own LiveView experience.

Summary

Functions

handle_event(binary, params, socket)

Handles the "toggle" event by flipping the boolean state.

mount(params, session, socket)

Mounts the LiveView and initializes the socket with a default boolean state.

render(assigns)

Renders the default LiveView template.

Functions

handle_event(binary, params, socket)

Handles the "toggle" event by flipping the boolean state.

When the button is clicked, the LiveView toggles the value of :value.

Parameters

  • "toggle": The event name.
  • _params: The event parameters (unused).
  • socket: The LiveView socket.

Returns

  • {:noreply, socket} with the updated :value assign.

mount(params, session, socket)

Mounts the LiveView and initializes the socket with a default boolean state.

Parameters

  • _params: Request parameters (unused).
  • _session: Session data (unused).
  • socket: The LiveView socket.

Returns

  • {:ok, socket} with the assign :value set to true.

render(assigns)

Renders the default LiveView template.

The template includes:

  • A welcome header.
  • Instructions on how to replace or customize the default LiveView, layout, router, or endpoint.
  • A display of the current boolean state.
  • A button to toggle the state for testing interactivity.

Parameters

  • assigns: A map containing the LiveView assigns, including :value.

Example 

<h1>Welcome to KinoPhoenixLiveview!</h1>
<p>Current value: true</p>
<button phx-click="toggle">Toggle Value</button>