---
title: "Home Module"
url: "https://developer.incode.com/sdk-reference/web-sdk-2-module-home/"
section: "sdk-reference"
group: "Incode Web SDK 2 Reference / Web SDK 2 Individual Modules"
version: "v1.1"
status: "live"
---
# Home Module

:::note
This guide is specific to Web SDK 2.0. If you are still using 1.x, you can find documentation [here](/sdk-reference/web-sdk-reference).  Contact your Incode Representative for upgrade information and check if you are a candidate for this upgrade. <br /><br />Full rollout to all clients still TBD.
:::

The Home module renders the SDK's built-in welcome screen. This is an 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](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules) — 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:

```typescript
type HomeConfig = EmptyConfig; // no options
```

## State 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.               |

## API methods

| Method       | Purpose                                                             | Callable when |
| ------------ | ------------------------------------------------------------------- | ------------- |
| `load()`     | Show the home screen.                                               | `idle`        |
| `complete()` | Dismiss the home screen so the flow starts. Advances to `finished`. | `main`        |

Plus the universal lifecycle: `subscribe`, `getState`.

## See also

- [IncodeFlow Component → enableHome](/sdk-reference/web-sdk-2-incodeflow-component/): the recommended way to use this module
- [Module Patterns → composite](/sdk-reference/web-sdk-2-module-patterns/#5-composite--orchestrator-modules)
- [Individual Modules](/sdk-reference/web-sdk-2-individual-modules/)