API Reference live_view_native v0.0.9-rc.1
modules
Modules
LiveViewNative keeps the contexts that define your domain and business logic.
Upgrades a Live Component to a Native Live Component when inherited
with use LiveViewNative.Component
like so
A GenServer that provides additional services in development environments. It supports multicast addressing over UDP to provide visibility between LiveView Native development servers and clients running on the same network.
This macro is largely responsible for upgrading a LiveView or Live Component
to a module that supports LiveView Native. This macro should not be directly
inherited by a LiveView or Live Component via use
; instead, those modules
should use LiveViewNative.LiveView
or LiveViewNative.LiveComponent
respectively.
LiveView Native extension that enables inline-rendering of templates for LiveView
Native platforms within a LiveView or Live Component. Using this macro causes
a module to inherit a LVN/2
sigil that can be used to render templates inline
by suffixing it with the platform's platform_id
LiveView Native extension for platform-specific modifiers. Modifiers refer to properties that affect the behavior and visual presentation of native components, such as alignment, visibility, styling, and so on. Each platform library defines its own set of supported modifiers as well as how to encode those modifiers before they are returned from the LiveView server to the client.
LiveView Native extension for swapping the render/1
function when rendering
for specific platforms from a LiveView or Live Component. Using this macro causes
a module to inherit a render_native/1
function which takes a map of assigns and
calls render/1
on the render module for the calling platform as defined by the
LiveViewNativePlatform.Env
struct set to the :native
assign. The module
where that platform-specific render/1
function lives is derived by concatenating
the LiveView or LiveComponent's module name with the platform context struct's
template_namespace
and should be automatically generated from a LiveView or Live
Component that uses LiveViewNative.LiveView
or LiveViewNative.LiveComponent
respectively.
TODO: Write docs
LiveView Native extension for rendering platform-specific templates.
Takes the following parameters which are typically derived from a Macro.Env
struct
Upgrades a Live Component to a Native Live Component when inherited
with use LiveViewNative.LiveComponent
like so
Ensures common assigns
are applied to all LiveViews attaching this hook.
Upgrades a LiveView to a Native LiveView when inherited with
use LiveViewNative.LiveView
like so
Provides configuration constants about all platforms supported by an
application that uses LiveView Native. This module is a dependency
of various LiveView Native systems, such as LiveViewNative.LiveSession
which is responsible for determining which platform (web, iOS, etc.) a
session originates from.