Adjusted naming of WizardStepObject to StepObject

This commit is contained in:
Jonas Kugelmann
2018-12-06 09:18:05 +01:00
parent 334c888710
commit 3458e059eb
2 changed files with 8 additions and 8 deletions

View File

@@ -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<WizardProps>;
export interface StepsProps {
step?: WizardStepObject;
step?: StepObject;
}
export const Steps: React.ComponentType<StepsProps>;
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 <Step> 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;
* }
* }

View File

@@ -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;
}
}