View Source LiveNavigator.Component (live_navigator v0.1.7)
LiveNavigator functionality for Phoenix.LiveComponent
Link to this section Summary
Link to this section Types
@type action() :: LiveNavigator.action()
@type url() :: LiveNavigator.url()
@type view() :: LiveNavigator.view()
Link to this section Functions
@spec assign_page(Phoenix.LiveView.Socket.t(), keyword() | map()) :: Phoenix.LiveView.Socket.t()
@spec assign_page(Phoenix.LiveView.Socket.t(), atom(), any()) :: Phoenix.LiveView.Socket.t()
Assigns value to page session
WARNING!
assign_page/3
does nothing with local live component assigns. It just updates page session.
@spec clear_page(Phoenix.LiveView.Socket.t(), atom() | [atom()]) :: Phoenix.LiveView.Socket.t()
@spec current_url(Phoenix.LiveView.Socket.t()) :: binary() | nil
@spec history(Phoenix.LiveView.Socket.t()) :: LiveNavigator.History.t()
@spec push_patch( Phoenix.LiveView.Socket.t(), keyword() ) :: Phoenix.LiveView.Socket.t()
This function is deprecated. Use push_navigate/2 instead.
@spec push_redirect( Phoenix.LiveView.Socket.t(), keyword() ) :: Phoenix.LiveView.Socket.t()
@spec put_history(Phoenix.LiveView.Socket.t(), LiveNavigator.History.spec()) :: Phoenix.LiveView.Socket.t()
@spec put_history( Phoenix.LiveView.Socket.t(), LiveNavigator.History.spec(), keyword() ) :: Phoenix.LiveView.Socket.t()
@spec put_history(Phoenix.LiveView.Socket.t(), url(), view()) :: Phoenix.LiveView.Socket.t()
@spec put_history(Phoenix.LiveView.Socket.t(), url(), view(), action() | keyword()) :: Phoenix.LiveView.Socket.t()
@spec put_history(Phoenix.LiveView.Socket.t(), url(), view(), action(), keyword()) :: Phoenix.LiveView.Socket.t()
@spec redirect( Phoenix.LiveView.Socket.t(), keyword() ) :: Phoenix.LiveView.Socket.t()