API Reference PhoenixKitBoards v#0.4.3

Copy Markdown View Source

Modules

Collaborative infinite-canvas boards for PhoenixKit.

A collaborative infinite-canvas board.

Context for collaborative infinite-canvas boards.

Turn a pasted URL into a preview card image.

Versioned migration coordinator for phoenix_kit_boards — the module returned from PhoenixKitBoards.migration_module/0.

Centralized path helpers. Every link/redirect goes through PhoenixKit.Utils.Routes.path/1 so the host's URL prefix + locale are applied — never hardcode PhoenixKit paths.

Route macros for the two board admin pages: the list (/admin/boards) and a single board (/admin/boards/:id). Returned from PhoenixKitBoards.route_module/0; PhoenixKit injects these inside the admin live_session (auth + admin layout applied automatically).

Serves this module's collaboration hook bundle.

Relays a board's ephemeral traffic between the people looking at it.

A single collaborative board (/admin/boards/:id).

Carries a board's ephemeral traffic — where people's cursors are, and where a shape is while it is still being dragged.

The boards list (/admin/boards): create a board, open one, or delete it. PhoenixKit applies the admin layout automatically.

Delivers this module's LiveView hooks without the host wiring anything.