Rekindle.Phoenix (Rekindle v0.1.2)

Copy Markdown View Source

Connects Rekindle's Web artifacts to a Phoenix endpoint.

The installer adds the development endpoint plug, static delivery, and the selected integration's host and module script to the Phoenix root layout. web_entry_path/1 selects the development runtime while code reloading is enabled and resolves the production entry module through the application's Phoenix static-path implementation otherwise. web_host/1 supplies the host markup required by the selected UI integration when a custom layout needs it.

Summary

Types

integration()

Functions

web_entry_path(endpoint)

Returns the Web entry module path for a Phoenix endpoint.

web_host(integration)

Returns the trusted Web host markup for a built-in integration.

Types

integration()

@type integration() :: :gpui | :egui | :slint

Functions

web_entry_path(endpoint)

@spec web_entry_path(module()) :: String.t()

Returns the Web entry module path for a Phoenix endpoint.

During code-reloading development, loading this path as a JavaScript module starts the current development generation and follows successful rebuilds. Otherwise it starts the immutable generation selected by mix rekindle.build web --release.

web_host(integration)

@spec web_host(integration()) :: String.t()

Returns the trusted Web host markup for a built-in integration.

GPUI does not require a host element. egui and Slint return their required canvas elements. The returned markup is fixed by Rekindle and can be rendered with Phoenix.HTML.raw/1.