Home Module
The Home module renders the SDK's built-in home / welcome screen — the optional intro screen that runs before a flow starts. Wired automatically by
This guide is specific to Web SDK 2.0. If you are still using 1.x, you can find documentation here. We strongly recommend upgrading - contact your Incode Representative for upgrade information.
The Home module renders the SDK's built-in home / welcome screen — the optional intro screen that runs before a flow starts. Wired automatically by <incode-flow> when enableHome: true; rarely needed standalone.
Effectively a composite / utility module — the orchestrator drives it as part of the larger flow lifecycle. Ships no user inputs of its own.
Availability
This module is headless-only — there is no public <incode-home> web component. Drive it with createHomeManager from @incodetech/core/home. Most consumers don't need to: pass enableHome: true in FlowConfig and <incode-flow> mounts the home screen for you.
Configuration
The module takes no configuration:
type HomeConfig = EmptyConfig; // no optionsState machine
HomeState is minimal:
| Status | Description |
|---|---|
idle | Initial state. |
main | Home screen visible. User can dismiss to start the flow. |
finished | Terminal — user dismissed; flow continues. |
See also
- IncodeFlow Component → enableHome: the recommended way to use this module
- Module Patterns → composite
- Individual Modules
Updated 1 day ago