@ui5/webcomponents-react/dist/webComponents/WizardStep/index.d.ts

React Wrapper for UI5 Web Components and additional components

import '@ui5/webcomponents-fiori/dist/WizardStep.js';
import type { ReactNode } from 'react';
import type { CommonProps, Ui5DomRef } from '../../types/index.js';
interface WizardStepAttributes {
    /**
     * When `branching` is enabled a dashed line would be displayed after the step,
     * meant to indicate that the next step is not yet known and depends on user choice in the current step.
     *
     * **Note:** It is recommended to use `branching` on the last known step
     * and later add new steps when it becomes clear how the wizard flow should continue.
     * @default false
     */
    branching?: boolean;
    /**
     * Defines if the step is `disabled`. When disabled the step is displayed,
     * but the user can't select the step by clicking or navigate to it with scrolling.
     *
     * **Note:** Step can't be `selected` and `disabled` at the same time.
     * In this case the `selected` property would take precedence.
     * @default false
     */
    disabled?: boolean;
    /**
     * Defines the `icon` of the step.
     *
     * **Note:** The icon is displayed in the `Wizard` navigation header.
     *
     * The SAP-icons font provides numerous options.
     * See all the available icons in the [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).
     * @default undefined
     */
    icon?: string | undefined;
    /**
     * Defines the step's `selected` state - the step that is currently active.
     *
     * **Note:** Step can't be `selected` and `disabled` at the same time.
     * In this case the `selected` property would take precedence.
     * @default false
     */
    selected?: boolean;
    /**
     * Defines the `subtitleText` of the step.
     *
     * **Note:** the text is displayed in the `Wizard` navigation header.
     * @default undefined
     */
    subtitleText?: string | undefined;
    /**
     * Defines the `titleText` of the step.
     *
     * **Note:** The text is displayed in the `Wizard` navigation header.
     * @default undefined
     */
    titleText?: string | undefined;
}
interface WizardStepDomRef extends Required<WizardStepAttributes>, Ui5DomRef {
}
interface WizardStepPropTypes extends WizardStepAttributes, Omit<CommonProps, keyof WizardStepAttributes | 'children'> {
    /**
     * Defines the step content.
     */
    children?: ReactNode | ReactNode[];
}
/**
 * A component that represents a logical step as part of the `Wizard`.
 * It is meant to aggregate arbitrary HTML elements that form the content of a single step.
 *
 * ### Structure
 *
 * - Each wizard step has arbitrary content.
 * - Each wizard step might have texts - defined by the `titleText` and `subtitleText` properties.
 * - Each wizard step might have an icon - defined by the `icon` property.
 * - Each wizard step might display a number in place of the `icon`, when it's missing.
 *
 * ### Usage
 * The `WizardStep` component should be used only as slot of the `Wizard` component
 * and should not be used standalone.
 *
 * __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/)
 * @abstract
 */
declare const WizardStep: import("react").ForwardRefExoticComponent<WizardStepPropTypes & import("../../internal/withWebComponent.js").WithWebComponentPropTypes & import("react").RefAttributes<WizardStepDomRef>>;
export { WizardStep };
export type { WizardStepDomRef, WizardStepPropTypes };