PhoenixKit.Install.BrowserPipelineIntegration (phoenix_kit v1.6.16)

View Source

Handles automatic integration of PhoenixKit plugs into the browser pipeline.

This module provides functionality to:

  • Add PhoenixKitWeb.Plugs.Integration to the :browser pipeline automatically
  • Handle cases where the plug already exists (idempotent)
  • Provide clear error messages if browser pipeline is not found

Extensibility

The Integration plug acts as a single entry point for all PhoenixKit plugs. New features can be added to the Integration plug without modifying the parent application's pipeline.

Summary

Functions

add_integration_to_browser_pipeline(igniter)

Adds the PhoenixKit Integration plug to the :browser pipeline in the Phoenix router.

Functions

add_integration_to_browser_pipeline(igniter)

Adds the PhoenixKit Integration plug to the :browser pipeline in the Phoenix router.

This plug coordinates all PhoenixKit features that need to run in the browser pipeline, including maintenance mode, and any future features.

Parameters

  • igniter - The igniter context

Returns

Updated igniter with integration plug added or warning if router/pipeline not found.