@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
43 lines (42 loc) • 1.45 kB
TypeScript
import type { JSX, ReactNode } from 'react';
import type { ComponentProps } from '../../types';
import type { FlexContainerAllProps as FlexContainerProps } from '../../../../components/flex/Container';
import type { VisibleWhen } from '../../Form/Visibility';
export type WizardStepProps = ComponentProps & FlexContainerProps & {
/**
* A unique title of the step.
*/
title?: ReactNode;
/**
* Will treat the step as non-navigable if set to `true`.
*/
inactive?: boolean;
/**
* To determine if the step should be rendered.
* Used internally by the WizardContainer.
*/
index?: number;
/**
* Will make all nested form fields required.
*/
required?: boolean;
/**
* If set to `false`, the step will not be rendered.
*/
include?: boolean;
/**
* Provide a `path` or `itemPath` together with `hasValue` or `isValid` in order to enable the step. `hasValue` can be a value or a function that returns a boolean. `isValid` uses the validation state of the referenced field.
*/
includeWhen?: VisibleWhen;
/**
* Determines if the step should be kept in the DOM. Defaults to `false`.
*/
keepInDOM?: boolean;
/**
* If set to `true`, the step will always be rendered.
* For internal use only.
*/
prerenderFieldProps?: boolean;
};
declare function Step(props: WizardStepProps): JSX.Element;
export default Step;