@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
74 lines (73 loc) • 2.39 kB
TypeScript
import React from 'react';
import type { OnStepChange, StepIndex } from '../Context/types';
import { ComponentProps } from '../../types';
export type Props = ComponentProps & {
id?: string;
/**
* The mode of the wizard.
*/
mode?: 'static' | 'strict' | 'loose';
/**
* If set to `true`, the wizard will not scroll to the first step when the user clicks on the next button.
*/
omitScrollManagement?: boolean;
/**
* If set to `true`, the wizard will not focus on the next step when the user clicks on the next button.
*/
omitFocusManagement?: boolean;
/**
* The index of the first step to be rendered.
*/
initialActiveIndex?: StepIndex;
/**
* The callback function that will be called when the user clicks on the next button.
*/
onStepChange?: OnStepChange;
/**
* The sidebar variant.
* @deprecated there is only one variant available. This props has no effect
*/
variant?: 'sidebar' | 'drawer';
/**
* @deprecated there is no longer a sidebar. This prop does nothing.
*/
sidebarId?: string;
/**
* If set to `true`, the wizard will not animate the steps.
*/
noAnimation?: boolean;
/**
* Set to `true` to have the list be expanded initially. Defaults to `false`.
*/
expandedInitially?: boolean;
/**
* If set to `true`, the wizard will not unmount the steps when navigating back and forth.
*/
keepInDOM?: boolean;
/**
* Whether or not to break out (using negative margins) on larger screens. Defaults to `true`.
*/
outset?: boolean;
/**
* If set to `true`, the wizard pre-render all steps so the props of each field is available in the data context.
* Defaults to `true`.
*/
prerenderFieldProps?: boolean;
/**
* Determines if and how the validation will be bypassed.
*/
validationMode?: 'bypassOnNavigation';
/**
* The children of the wizard container.
*/
children: React.ReactNode;
/**
* @deprecated Is enabled by default. You can disable it with "omitScrollManagement"
*/
scrollTopOnStepChange?: boolean;
};
declare function WizardContainer(props: Props): import("react/jsx-runtime").JSX.Element;
declare namespace WizardContainer {
var _supportsSpacingProps: boolean;
}
export default WizardContainer;