Add :on_mount to router documentation (#436)

phoenixframework · Jan 3, 2024 · a39af07 · a39af07
1 parent 54239fd
commit a39af07
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/phoenix/live_dashboard/router.ex b/lib/phoenix/live_dashboard/router.ex
@@ -44,6 +44,10 @@ defmodule Phoenix.LiveDashboard.Router do
       If not set, metrics will start out empty/blank and only display
       data that occurs while the browser page is open.
 
+    * `:on_mount` - Declares a custom list of `Phoenix.LiveView.on_mount/1`
+      callbacks to add to the dashboard's `Phoenix.LiveView.Router.live_session/3`.
+      A single value may also be declared.
+
     * `:request_logger` - By default the Request Logger page is enabled. Passing
        `false` will disable this page.