KioskStep
ComplexMobile and kiosk
<co-kiosk-step>KioskStep is one step of front-desk tablet check-in: kiosk header with Help, step segments, big title, content and large Back and Continue buttons.
import { KioskStep } from 'health-components';
Examples
Showcase
Middle Step
Next Disabled
Usage
<KioskStep step={1} total={6} stepName="Find appointment" title="Find your appointment" onNext={find}>
<TextField label="Last name" size="lg" required />
</KioskStep>
When to use
- Self check-in tablets.
When not to use
- Patient phones: PhoneScaffold.
Variants and states
| Variant | What it is |
|---|---|
| first step | No Back. |
| next disabled | Until required fields are filled. |
Accessibility
- 48px controls; progress announced as Step N of 6.
Do and don't
- Do: Clear the screen after 30 seconds idle, with a warning first.
- Don't: Show other patients' names in results.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
step * | number | — | Current step, 1-based. Required |
total * | number | — | Number of steps. Required |
stepName * | string | — | Short step name in the header ("Find appointment"). Required |
title * | string | — | Big heading (h1) of the step. Required |
subtitle | ReactNode | none | Instruction under the heading |
practice | string | "Valley Family Clinic" | Practice name in the header |
nextLabel | string | "Continue" | Label of the main button |
nextDisabled | boolean | false | Disables the main button until required fields are filled |
onBack | () => void | none | Back button (shown from step 2) |
onNext | () => void | none | Main button |
onHelp | () => void | none | "I need help" in the header |
children | ReactNode | — | Fields of the step. |
Also accepts native attributes, including defaultChecked, defaultValue, autoFocus, plus className and event handlers on the root element.
Angular, Vue and HTML
Register the elements once (Angular guide), then use <co-kiosk-step>. Attributes take strings; arrays and objects are set as properties (Angular [prop], Vue :prop) or as JSON attributes. Callbacks are DOM events with the value in event.detail.
Angular template
<co-kiosk-step step="…" total="…" [defaultValue]="defaultValue" (co-back)="onBack($event.detail)">…</co-kiosk-step>
| Kind | Name | Description |
|---|---|---|
| attribute | step | Current step, 1-based. Required |
| attribute | total | Number of steps. Required |
| attribute | step-name / stepName | Short step name in the header ("Find appointment"). Required |
| attribute | title | Big heading (h1) of the step. Required |
| attribute | practice | Practice name in the header; default "Valley Family Clinic" |
| attribute | next-label / nextLabel | Label of the main button; default "Continue" |
| attribute | next-disabled / nextDisabled | Disables the main button until required fields are filled; default false |
| attribute | default-checked / defaultChecked | |
| property / JSON attribute | default-value / defaultValue | |
| attribute | auto-focus / autoFocus | |
| event | co-back | Back button (shown from step 2); default none (React: onBack) |
| event | co-next | Main button; default none (React: onNext) |
| event | co-help | "I need help" in the header; default none (React: onHelp) |
| slot | subtitle | Instruction under the heading; default none Plain text also works as the `subtitle` attribute. |
| slot | (default) | Fields of the step. |