API Reference ExLiveUrl v0.2.0

modules

Modules

ExLiveUrl is just some simple Phoenix LiveView lifecycle hooks and helper functions. It helps you store the live view's current query params and path in your assigns. Additionally, it exposes ways to work with those values both synchronously (only from the root live view) and asynchronously (from anywhere).

ExLiveUrl.Operation structs represent url operations. An operation consists of a :url which the operation targets, a :mode which indicates how the server should get to the target (updating the current view, mounting a new view, or going to an external url), and a :stack_operation which indicates how applying the operation should update the browser's history stack (pushing a history entry, replacing the current history entry, or updating window.location entirely).

ExLiveUrl.Url structs represent fully qualified urls. You can think of them as bespoke URI structs.