diff --git a/types/react-albus/index.d.ts b/types/react-albus/index.d.ts index 371a50cca7..ccc0ac8582 100644 --- a/types/react-albus/index.d.ts +++ b/types/react-albus/index.d.ts @@ -9,13 +9,13 @@ import * as React from "react"; import { History } from "history"; -export interface WizardStepObject { +export interface StepObject { id: string; } export interface WizardContext { - step: WizardStepObject; - steps: WizardStepObject[]; + step: StepObject; + steps: StepObject[]; history: History; next: () => void; previous: () => void; @@ -42,22 +42,22 @@ export interface WizardProps { export const Wizard: React.ComponentType; export interface StepsProps { - step?: WizardStepObject; + step?: StepObject; } export const Steps: React.ComponentType; -export type StepProps = WizardStepObject & ( +export type StepProps = StepObject & ( | { render?: (wizard: WizardContext) => React.ReactNode } | { children: (wizard: WizardContext) => React.ReactNode }); /** * In addition to id, any additional props added to will be available on each step object. * This can be used to add names, descriptions, or other metadata to each step. - * To use this feature generally you need to augment the WizardStepObject + * To use this feature globally in your project you need to augment the StepObject * @example * declare module "react-albus" { - * interface WizardStepObject { + * interface StepObject { * propName: string; * } * } diff --git a/types/react-albus/react-albus-tests.tsx b/types/react-albus/react-albus-tests.tsx index f03e57cc2e..57fe8147d1 100644 --- a/types/react-albus/react-albus-tests.tsx +++ b/types/react-albus/react-albus-tests.tsx @@ -2,7 +2,7 @@ import * as React from "react"; import { Wizard, Step, Steps, withWizard } from "react-albus"; declare module "react-albus" { - interface WizardStepObject { + interface StepObject { quote?: string; } }