LiveSvelte

https://hexdocs.pm/live_svelte/
Admin
LiveSvelte extends Phoenix LiveView to enable end-to-end reactivity and server-side rendering for...
Tokens:3,815
Snippets:22
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### LiveSvelte Setup Task

Source: https://hexdocs.pm/live_svelte/Mix.Tasks.LiveSvelte

The `mix live_svelte.setup` task runs all necessary setup procedures for LiveSvelte. It ensures the project is configured correctly for Svelte integration.

```APIDOC
mix live_svelte.setup
  Runs all setup tasks for LiveSvelte.
  This task is essential for initializing LiveSvelte in a Phoenix project.
```

--------------------------------

### LiveSvelte Mix Tasks

Source: https://hexdocs.pm/live_svelte/api-reference

Provides essential Mix tasks for configuring and setting up LiveSvelte within a Phoenix project. These tasks handle esbuild configuration, Phoenix integration, npm dependency installation, and overall project setup.

```elixir
mix live_svelte.configure_esbuild
mix live_svelte.configure_phoenix
mix live_svelte.install_npm_deps
mix live_svelte.setup
```

--------------------------------

### LiveSvelte Mix Tasks

Source: https://hexdocs.pm/live_svelte/LiveSvelte

Provides commands for configuring Esbuild, Phoenix, installing NPM dependencies, and setting up the LiveSvelte project.

```bash
mix live_svelte.configure_esbuild
mix live_svelte.configure_phoenix
mix live_svelte.install_npm_deps
mix live_svelte.setup
```

--------------------------------

### LiveSvelte NPM Dependency Installation Task

Source: https://hexdocs.pm/live_svelte/Mix.Tasks.LiveSvelte

The `mix live_svelte.install_npm_deps` task handles the installation of necessary Node.js dependencies for LiveSvelte. This is crucial for the Svelte compiler and other frontend assets.

```APIDOC
mix live_svelte.install_npm_deps
  Installs the required npm dependencies for LiveSvelte.
  Ensure you have Node.js and npm installed before running this task.
```

--------------------------------

### LiveSvelte ESBuild Configuration Task

Source: https://hexdocs.pm/live_svelte/Mix.Tasks.LiveSvelte

The `mix live_svelte.configure_esbuild` task assists in configuring ESBuild for LiveSvelte projects. ESBuild is used for efficient JavaScript bundling.

```APIDOC
mix live_svelte.configure_esbuild
  Configures ESBuild for use with LiveSvelte.
  This task helps set up the build process for Svelte components.
```

--------------------------------

### LiveSvelte Phoenix Configuration Task

Source: https://hexdocs.pm/live_svelte/Mix.Tasks.LiveSvelte

The `mix live_svelte.configure_phoenix` task helps integrate LiveSvelte with your Phoenix project. It sets up the necessary configurations within the Phoenix framework.

```APIDOC
mix live_svelte.configure_phoenix
  Configures the Phoenix project to work with LiveSvelte.
  This task ensures seamless integration between LiveView and Svelte components.
```

--------------------------------

### LiveSvelte Components Module

Source: https://hexdocs.pm/live_svelte/api-reference

Handles the management and usage of Svelte components within the LiveSvelte framework. Includes functions for component registration and retrieval.

```elixir
def __using__(opts)

def get_svelte_components()
```

--------------------------------

### LiveSvelte Components Module

Source: https://hexdocs.pm/live_svelte/Mix.Tasks.LiveSvelte

Handles the management and usage of Svelte components within the LiveSvelte framework. Includes functions for component registration and retrieval.

```elixir
def __using__(opts)

def get_svelte_components()
```

--------------------------------

### LiveSvelte Components Module

Source: https://hexdocs.pm/live_svelte/LiveSvelte

Handles the management and usage of Svelte components within the LiveSvelte framework. Includes functions for component registration and retrieval.

```elixir
def __using__(opts)

def get_svelte_components()
```

--------------------------------

### LiveSvelte Components Macros

Source: https://hexdocs.pm/live_svelte/api-reference

Macros designed to enhance the developer experience when bridging the gap between Phoenix LiveView and Svelte components.

```elixir
defmodule LiveSvelte.Components do
  @moduledoc """
  Macros to improve the developer experience of crossing the Liveview/Svelte boundary.
  """
  # Macros would be defined here
end
```

--------------------------------

### LiveSvelte Core Functions

Source: https://hexdocs.pm/live_svelte/api-reference

Provides core functions for rendering Svelte components within LiveView. Includes functions for rendering components with assigns and for managing Svelte component integration.

```elixir
def render(assigns)

def svelte(assigns)
```

--------------------------------

### LiveSvelte Core Functions

Source: https://hexdocs.pm/live_svelte/LiveSvelte

Provides core functions for rendering Svelte components within LiveView. Includes functions for rendering components with assigns and for managing Svelte component integration.

```elixir
def render(assigns)

def svelte(assigns)
```

--------------------------------

### LiveSvelte Core Functions

Source: https://hexdocs.pm/live_svelte/Mix.Tasks.LiveSvelte

Provides core functions for rendering Svelte components within LiveView. Includes functions for rendering components with assigns and for managing Svelte component integration.

```elixir
def render(assigns)

def svelte(assigns)
```

--------------------------------

### LiveSvelte Server-Side Rendering (SSR)

Source: https://hexdocs.pm/live_svelte/api-reference

Defines types and callbacks for server-side rendering of Svelte components using LiveSvelte. This module facilitates rendering Svelte components on the server before sending them to the client.

```APIDOC
LiveSvelte.SSR:
  Types:
    component_name(): The name of the Svelte component.
    props(): The properties to pass to the Svelte component.
    render_response(): The response structure after rendering.
    slots(): The slots to be rendered within the Svelte component.

  Callbacks:
    render(component_name, props, slots)
      Renders a Svelte component on the server.

  Functions:
    render(name, props, slots)
      Renders a Svelte component with the given name, properties, and slots.
```

--------------------------------

### LiveSvelte Sigil DSL

Source: https://hexdocs.pm/live_svelte/api-reference

Provides a sigil as an alternative Domain Specific Language (DSL) for interacting with LiveView, simplifying component integration.

```elixir
use LiveSvelte

# Example usage of the sigil
~s"<MySvelteComponent prop={value} />"
```

--------------------------------

### LiveSvelte Server-Side Rendering (SSR)

Source: https://hexdocs.pm/live_svelte/LiveSvelte

Defines types and callbacks for server-side rendering of Svelte components using LiveSvelte. This module facilitates rendering Svelte components on the server before sending them to the client.

```APIDOC
LiveSvelte.SSR:
  Types:
    component_name(): The name of the Svelte component.
    props(): The properties to pass to the Svelte component.
    render_response(): The response structure after rendering.
    slots(): The slots to be rendered within the Svelte component.

  Callbacks:
    render(component_name, props, slots)
      Renders a Svelte component on the server.

  Functions:
    render(name, props, slots)
      Renders a Svelte component with the given name, properties, and slots.
```

--------------------------------

### LiveSvelte Server-Side Rendering (SSR)

Source: https://hexdocs.pm/live_svelte/Mix.Tasks.LiveSvelte

Defines types and callbacks for server-side rendering of Svelte components using LiveSvelte. This module facilitates rendering Svelte components on the server before sending them to the client.

```APIDOC
LiveSvelte.SSR:
  Types:
    component_name(): The name of the Svelte component.
    props(): The properties to pass to the Svelte component.
    render_response(): The response structure after rendering.
    slots(): The slots to be rendered within the Svelte component.

  Callbacks:
    render(component_name, props, slots)
      Renders a Svelte component on the server.

  Functions:
    render(name, props, slots)
      Renders a Svelte component with the given name, properties, and slots.
```

--------------------------------

### LiveSvelte LiveJson Component

Source: https://hexdocs.pm/live_svelte/LiveSvelte

Documentation for the LiveJson component, used to pass LiveJSON props to Svelte components. It accepts a map of props and has an inner_block slot.

```APIDOC
LiveSvelte.LiveJson:
  live_json(assigns)
    Attributes:
      live_json_props (:map) - LiveJSON props to pass to the svelte component. Defaults to %{}.
    Slots:
      inner_block
```

--------------------------------

### LiveSvelte SSR Behavior

Source: https://hexdocs.pm/live_svelte/api-reference

Defines a behavior for rendering Svelte components server-side using LiveSvelte. This is crucial for server-side rendering (SSR) capabilities.

```elixir
defmodule LiveSvelte.SSR do
  @moduledoc """
A behaviour for rendering Svelte components server-side.
"""
  @doc """
  Renders a Svelte component server-side.
  """
  @callback render(component :: atom(), assigns :: keyword()) :: {:ok, String.t()} | {:error, any()}
end
```

--------------------------------

### LiveSvelte LiveJson Function

Source: https://hexdocs.pm/live_svelte/api-reference

A utility function for handling JSON data within LiveSvelte, likely for passing data between LiveView and Svelte components.

```elixir
def live_json(assigns)
```

--------------------------------

### LiveSvelte LiveJson Function

Source: https://hexdocs.pm/live_svelte/LiveSvelte

A utility function for handling JSON data within LiveSvelte, likely for passing data between LiveView and Svelte components.

```elixir
def live_json(assigns)
```

--------------------------------

### LiveSvelte LiveJson Function

Source: https://hexdocs.pm/live_svelte/Mix.Tasks.LiveSvelte

A utility function for handling JSON data within LiveSvelte, likely for passing data between LiveView and Svelte components.

```elixir
def live_json(assigns)
```
Tokens:
Raw