Skip to main content

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​

Storybook

Middle Step​

Storybook

Next Disabled​

Storybook

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​

VariantWhat it is
first stepNo Back.
next disabledUntil 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​

PropTypeDefaultDescription
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
subtitleReactNodenoneInstruction under the heading
practicestring"Valley Family Clinic"Practice name in the header
nextLabelstring"Continue"Label of the main button
nextDisabledbooleanfalseDisables the main button until required fields are filled
onBack() => voidnoneBack button (shown from step 2)
onNext() => voidnoneMain button
onHelp() => voidnone"I need help" in the header
childrenReactNode—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>
KindNameDescription
attributestepCurrent step, 1-based. Required
attributetotalNumber of steps. Required
attributestep-name / stepNameShort step name in the header ("Find appointment"). Required
attributetitleBig heading (h1) of the step. Required
attributepracticePractice name in the header; default "Valley Family Clinic"
attributenext-label / nextLabelLabel of the main button; default "Continue"
attributenext-disabled / nextDisabledDisables the main button until required fields are filled; default false
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
eventco-backBack button (shown from step 2); default none (React: onBack)
eventco-nextMain button; default none (React: onNext)
eventco-help"I need help" in the header; default none (React: onHelp)
slotsubtitleInstruction under the heading; default none Plain text also works as the `subtitle` attribute.
slot(default)Fields of the step.