@k8ordo/ui

Stepper

手順のステップを順に並べ、完了したステップと現在のステップを示します。複数の画面に分かれたフォームの進み具合に使います。

インポート

ts
import { Stepper } from '@k8ordo/ui';

使い方

valueは現在のステップの位置で、0から数えます。完了したステップにはチェックが付き、読み上げでは「完了」と添えます。現在のステップはaria-current="step"で伝えます。

  1. PlanPick what fits完了
  2. PaymentCard or invoice
  3. ReviewCheck and send
tsx
const steps = [
  { label: 'Plan', description: 'Pick what fits' },
  { label: 'Payment', description: 'Card or invoice' },
  { label: 'Review', description: 'Check and send' },
];

<Stepper aria-label="Sign-up" steps={steps} value={1} />

完了したステップへの移動

interactiveを付けると、完了したステップがボタンになります。押すとonChangeがその位置を受け取ります。先のステップへは飛べません。

  1. ReviewCheck and send
tsx
const [step, setStep] = useState(2);

<Stepper
  aria-label="Sign-up"
  interactive
  onChange={setStep}
  steps={steps}
  value={step}
/>

縦並び

  1. PlanPick what fits完了
  2. PaymentCard or invoice
  3. ReviewCheck and send
tsx
<Stepper
  aria-label="Sign-up"
  orientation="vertical"
  steps={steps}
  value={1}
/>

Props

steps
Type: readonly StepperStep[]
Default: -
defaultValue?
Type: number
Default: -
interactive?
Type: boolean
Default: false
onChange?
Type: (value: number) => void
Default: -
orientation?
Type: 'horizontal'|'vertical'
Default: 'horizontal'
ref?
Type: Ref<HTMLOListElement>
Default: -
value?
Type: number
Default: -
PropTypeDefault
stepsreadonly StepperStep[]-
defaultValue?number-
interactive?booleanfalse
onChange?(value: number) => void-
orientation?'horizontal'|'vertical''horizontal'
ref?Ref<HTMLOListElement>-
value?number-

継承する属性(内部で固定するものを除く): OlHTMLAttributes<HTMLOListElement>

ラベルやプレースホルダーなど、このコンポーネントが描く文言は、propsで指定しないと文言辞書から読まれます。差し替え方は次を見てください: コンポーネントの文言

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。