@patternfly/react-core
Version:
This library provides a set of common React components for use with the PatternFly reference implementation.
37 lines • 1.95 kB
TypeScript
/// <reference types="react" />
import { OUIAProps } from '../../helpers';
export interface WizardNavItemProps extends Omit<React.HTMLProps<HTMLLIElement>, 'onClick' | 'id' | 'content' | 'type'>, OUIAProps {
/** Additional classes spread to the wizard nav item */
className?: string;
/** Can nest a WizardNav component for substeps */
children?: React.ReactNode;
/** The content to display in the navigation item */
content?: React.ReactNode;
/** Whether the navigation item is the currently active item */
isCurrent?: boolean;
/** Whether the navigation item is disabled */
isDisabled?: boolean;
/** Whether the navigation item has been visited */
isVisited?: boolean;
/** The step index passed into the onNavItemClick callback */
stepIndex: number;
/** Callback for when the navigation item is clicked */
onClick?: (event: React.MouseEvent<HTMLButtonElement> | React.MouseEvent<HTMLAnchorElement>, index: number) => any;
/** Component used to render WizardNavItem */
component?: 'button' | 'a';
/** An optional url to use for when using an anchor component */
href?: string;
/** Where to display the linked URL when using an anchor component */
target?: React.HTMLAttributeAnchorTarget;
/** Flag indicating that this NavItem has child steps and is expandable */
isExpandable?: boolean;
/** The id for the navigation item */
id?: string | number;
/** Used to determine the icon displayed next to content. Default has no icon. */
status?: 'default' | 'error' | 'success';
}
export declare const WizardNavItem: {
({ children, content, isCurrent, isDisabled, isVisited, stepIndex, onClick, component: NavItemComponent, href, isExpandable, id, status, target, ouiaId, ouiaSafe, className, ...props }: WizardNavItemProps): import("react/jsx-runtime").JSX.Element;
displayName: string;
};
//# sourceMappingURL=WizardNavItem.d.ts.map