LiveReact.SSR behaviour (live_react v1.0.0)

View Source

A behaviour for rendering React components server-side.

To define a custom renderer, change the application config in config.exs:

config :live_react, ssr_module: MyCustomSSRModule

Exposes a telemetry span for each render under key [:live_react, :ssr]

Summary

Types

A render response which should have shape

Types

component_name()

@type component_name() :: String.t()

props()

@type props() :: %{optional(String.t() | atom()) => any()}

render_response()

@type render_response() :: %{optional(String.t() | atom()) => any()}

A render response which should have shape

%{ html: string, }

slots()

@type slots() :: %{optional(String.t()) => any()}

Callbacks

render(component_name, props, slots)

@callback render(component_name(), props(), slots()) :: render_response() | no_return()

Functions

render(name, props, slots)

@spec render(component_name(), props(), slots()) :: render_response() | no_return()