LiveSvelte.SSR behaviour (LiveSvelte v0.16.0)

View Source

A behaviour for rendering Svelte components server-side.

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

config :live_svelte, ssr_module: MyCustomSSRModule

Summary

Types

A render response which should take the shape

Types

component_name()

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

props()

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

render_response()

@type render_response() :: %{
  required(String.t()) =>
    %{required(String.t()) => String.t() | nil} | String.t()
}

A render response which should take the shape:

%{
  "css" => %{
    "code" => String.t | nil,
    "map" => String.t | nil
  },
  "head" => String.t,
  "html" => String.t
}

slots()

@type slots() :: %{optional(String.t() | atom()) => 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()

server_path()

This function is deprecated. Use LiveSvelte.SSR.NodeJS.server_path/0 instead..