API
Browse Scalive's supported public API by package or use Filter symbols in the
API browser. Symbols inherited or exported through import scalive.* appear
under that public import path.
Packages
scalivecontains the core LiveView, component, HTML, form, routing, upload, and runtime APIs.scalive.codecscontains codecs used at browser and route boundaries.scalive.testingcontains disconnected rendering, page queries, and typed form test utilities.
Find a symbol
Use the API browser to explore packages and nested owners. Global documentation
search (Ctrl K) searches API declarations and members alongside guides and
examples.
Core abstraction
Start with LiveViewtrait LiveView[Msg, Model]Defines a server-rendered view with typed messages and model state., the typed boundary for mounting
state, handling messages, and rendering HTML.
Forms
Start structured browser input with
FormRootclass FormRootDeclares a root-level form schema namespace. and combine fields into a
FormDefinitionclass FormDefinition[Owner, Domain]One coherent schema responsible for projection, validation, events, and rebuilding.. The definition
owns its Formclass Form[Owner, Schema, Domain]Immutable current semantic values, validation result, and interaction state. values and typed
FormEventclass FormEvent[Owner, Schema, Domain]A definition-backed event containing an already rebuilt, internally consistent form. messages. See the
typed forms guide for the
complete path, then use the profile,
repeated rows, and
save workflow examples in order.
Advanced entry points include
PhoenixNestedParamsAdapterclass PhoenixNestedParamsAdapter[Owner, Schema, Domain, Group, Row]Bounded Phoenix indexed nested-parameter translation into stable keyed core rows.
for indexed compatibility payloads,
FormWorkflowclass FormWorkflow[Owner, Schema, Domain, Failure]Pure baseline, revision, reset, and one-in-flight-save state. for coordinated
persistence, and HttpFormDecoderobject HttpFormDecoderConstructors and typed rejection categories for ordinary HTTP form decoders.
for bounded CSRF-validated POST bodies.
Lifecycle capabilities include
ConnectedResourcestrait ConnectedResourcesAcquisition and finalization owned by one connected LiveView lifecycle. for
non-message acquisition and finalization during connected mount. The
lifecycle-owned work guide
compares it with managed async tasks and subscriptions.
Route-wide operational capabilities include
LifecycleObservertrait LifecycleObserverReceives structured operational events from LiveView lifecycles. and the
LifecycleMetricsobject LifecycleMetricsBuilt-in ZIO Metrics instrumentation for LifecycleEvent. adapter. The
lifecycle observability guide
defines their coverage and fixed metric contract.