Corpora UI
Blocks

Onboarding

Multi-step profile onboarding driven by a declared steps config: progress-tracked forms with back/forward navigation, per-step validation, draft restore and a single completion signal.

Preview and props

Expand Props below the centered preview to change the component’s properties.

Examples

Explore the configured steps, branding and completion states.

Profile
How you appear to collaborators on a manuscript.

Profile

Example controls

Usage

import { OnboardingBlock } from "@exegia/corpora-ui"

<OnboardingBlock steps={steps} onComplete={saveProfile} />

API notes

PropTypeDefaultDescription
stepsIOnboardingStepConfig[]DEFAULT_ONBOARDING_STEPSDeclared steps; each holds text, textarea, url, select and checkbox fields with optional required + validate rules.
logoReact.ReactNode—Brand mark rendered above the title. Omitted leaves no logo row at all.
accent"corpora" | "exegia"—Brand accent for the primary action — corpora is a solid #E8B124, exegia a purple gradient. Omit to keep the default primary.
onStepSubmit(stepId, values) => Promise<void&gt—Fires per step. Reject (or throw) to keep the user on the step and show the error.
onComplete(profile) => Promise<void&gt—Fires once, after the final step is accepted, with the merged profile.
showCompleteScreenbooleantrueBrief success screen once onboarding completes. false renders nothing instead.

autoFocus defaults to true and moves focus to step headings. Set it to false for embedded previews that should preserve the surrounding page’s focus.

Last updated on

On this page