@cimpress/react-components
Version:
React components to support the MCP styleguide
32 lines • 1.39 kB
TypeScript
import { DetailedHTMLProps, HTMLAttributes, ReactElement } from 'react';
import { PublicComponentProps } from './types';
export interface StepperProps extends DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, PublicComponentProps {
typeName?: string;
/**
* Tells the stepper which step should be active. Pass either the index of the step which should be active or its name.
*/
activeStep?: number | string;
/**
* Tells the stepper which validation state colors to use for the active step.
*/
status: 'success' | 'warning' | 'error' | 'info';
/**
* Children of the stepper should be `<Step>` elements.
*/
children: ReactElement[];
/**
* Tells the stepper that the currently active step is only partially complete - will display a half-filled circle.
* Avoid using unless you have a compelling UX reason.
*/
partial?: boolean;
/**
* Condenses stepper padding for small steppers. Additional children of Step components will not be shown on small steppers.
*/
small?: boolean;
/**
* Inline styles to be applied to the root stepper div.
*/
vertical?: boolean;
}
export declare const Stepper: ({ typeName, children, activeStep, small, color, partial, vertical, className, style, status, ...rest }: StepperProps) => JSX.Element;
//# sourceMappingURL=Stepper.d.ts.map