zidanezidane-ui/
import { … } from 'zidane-ui/onboarding/testing'ui/src/onboarding/testing/index.ts
Functions#
createFixtureOnboardingHostFunction#
Builds an OnboardingHost over demo data and scripted behaviour.
function createFixtureOnboardingHost(options?: FixtureOnboardingOptions): OnboardingHostParameters
| Name | Type | Default | Description |
|---|---|---|---|
| options? | FixtureOnboardingOptions | {} | The surface, mode, demo data and script. |
Returns
OnboardingHostThe host.
demoOnboardingModelsFunction#
The models a demo provider offers.
function demoOnboardingModels(key: string): readonly OnboardingModelInfo[]Parameters
| Name | Type | Description |
|---|---|---|
| key | string | Provider key. |
Returns
readonly OnboardingModelInfo[]Constants#
DEMO_IMPORT_PREVIEWConstant#
What an import from that Claude Code setup brings over.
const DEMO_IMPORT_PREVIEW: OnboardingImportPreviewDEMO_ONBOARDING_DETECTIONConstant#
A machine with an Anthropic key in the environment, Claude Code, the GitHub CLI and Ollama.
const DEMO_ONBOARDING_DETECTION: OnboardingDetectionDEMO_ONBOARDING_PROVIDERSConstant#
The built-in providers and the provider extensions, as Connect lists them on a fresh machine, each with its logo.
const DEMO_ONBOARDING_PROVIDERS: readonly OnboardingProvider[]DEMO_SKILL_LISTINGSConstant#
The skills of the recommended sources, as browseSkillSource lists them, cut
to a few each: what the fixture host's skills.browse answers.
const DEMO_SKILL_LISTINGS: Readonly<Record<string, SkillSourceListing>>Interfaces#
FixtureOnboardingOptionsInterface#
Options of createFixtureOnboardingHost.
interface FixtureOnboardingOptionsProperties
| Name | Type | Default | Description |
|---|---|---|---|
| appearance? | OnboardingAppearance | The look in effect. Defaults to the system's mode on the default dark and light themes. | |
| appIconNote? | string | The line under the app icons. | |
| appIcons? | readonly OnboardingAppIcon[] | The app icons Look offers, the first one the default and the one in use. Absent: Look offers no icon. | |
| delayMs? | number | 600 | Milliseconds between scripted steps. |
| detection? | OnboardingDetection | What was found. Defaults to | |
| failing? | readonly string[] | Provider keys, connector ids, extension names and skill sources whose sign-in, test, listing or install fails. | |
| githubToken? | string | null | 'gho_demo' | The GitHub token "Use my gh login" takes. |
| importPreview? | OnboardingImportPreview | null | What an import brings over. | |
| installedConnectors? | readonly string[] | Connector ids already installed. | |
| installedExtensions? | readonly string[] | Native extensions already installed. | |
| installedSkills? | readonly string[] | Skills already installed, by name. | |
| mode? | OnboardingMode | 'full' | How much of it runs. |
| models? | (key: string) => readonly OnboardingModelInfo[] | The models Connect offers for a provider. Defaults to | |
| onCommit? | (result: OnboardingResult) => void | Called with the result when the run finishes. | |
| settings? | Partial<Settings> | The stored settings. Defaults to none. | |
| signIn? | 'url' | 'device' | 'prompt' | 'url' | What a browser sign-in shows after it starts: the page ( |
| skillImages? | SkillSourceImages | Where the skill browser finds avatars and previews. Absent: GitHub. | |
| skillListings? | Readonly<Record<string, SkillSourceListing>> | The skill sources a browse lists, by what the user typed. Defaults to | |
| surface? | OnboardingSurface | 'desktop' | The app the wizard runs in. |
| themes? | readonly Theme[] | The themes Look offers. Defaults to the built-in ones. |