jobiqo-cl
Version:
[](https://circleci.com/gh/jobiqo/jobiqo-cl)
52 lines (51 loc) • 1.21 kB
TypeScript
/**
* @file index.tsx
*
* @fileoverview Renders a multi-step wizard.
*/
import React from 'react';
export interface WizardProps {
/**
* The children for the wizard object.
*/
children: React.ReactNode;
/**
* Next label
*/
nextLabel: React.ReactNode;
/**
* Previous label
*/
previousLabel: React.ReactNode;
/**
* Next label
*/
finishLabel: React.ReactNode;
/**
* Total number of steps.
*/
numberSteps: number;
/**
* Title for each step.
*/
steps?: React.ReactNode[] | string[];
/**
* Handles the finish callback.
*/
onFinish?: (e: any) => void;
/**
* Handles the next callback.
*/
onNext?: () => void;
/**
* Handles the previous callback.
*/
onPrevious?: () => void;
}
/**
* A multistep wizard that can be used for long forms or things that need a lot of
* input from a user and where detailed information
* about each information group is important.
*/
export declare const Wizard: ({ children, nextLabel, previousLabel, numberSteps, steps, finishLabel, onFinish, onNext, onPrevious }: WizardProps) => JSX.Element;
export default Wizard;