@furystack/shades-common-components
Version:
Common UI components for FuryStack Shades
44 lines • 1.38 kB
TypeScript
import type { ChildrenList, ViewTransitionConfig } from '@furystack/shades';
export interface WizardStepProps {
/**
* The current page number
*/
currentPage: number;
/**
* Total count of the wizard pages
*/
maxPages: number;
/**
* Callback that will be executed when the user navigates to the next page
*/
onNext?: () => void;
/**
* Callback that will be executed when the user navigates to the previous page
*/
onPrev?: () => void;
}
export interface WizardProps {
/**
* An array of Shade<WizardStepProps> components
*/
steps: Array<(props: WizardStepProps, children: ChildrenList) => JSX.Element<any>>;
/**
* A callback that will be executed when the wizard is completed
*/
onFinish?: () => void;
/**
* Optional labels for each step. When provided, a step indicator is shown above the content.
*/
stepLabels?: string[];
/**
* When true, a progress bar is shown above the content.
*/
showProgress?: boolean;
viewTransition?: boolean | ViewTransitionConfig;
}
export declare const Wizard: (props: WizardProps & Omit<Partial<HTMLElement>, "style"> & {
style?: Partial<CSSStyleDeclaration>;
} & {
ref?: import("@furystack/shades").RefObject<Element>;
}, children?: ChildrenList) => JSX.Element;
//# sourceMappingURL=index.d.ts.map