@patternfly/react-core
Version:
This library provides a set of common React components for use with the PatternFly reference implementation.
31 lines • 1.56 kB
TypeScript
import * as React from 'react';
import { NavSelectClickHandler } from './Nav';
import { OUIAProps } from '../../helpers';
export interface NavItemProps extends Omit<React.HTMLProps<HTMLAnchorElement>, 'onClick'>, OUIAProps {
/** Content rendered inside the nav item. */
children?: React.ReactNode;
/** Whether to set className on children when React.isValidElement(children) */
styleChildren?: boolean;
/** Additional classes added to the nav item */
className?: string;
/** Target navigation link */
to?: string;
/** Flag indicating whether the item is active */
isActive?: boolean;
/** Group identifier, will be returned with the onToggle and onSelect callback passed to the Nav component */
groupId?: string | number | null;
/** Item identifier, will be returned with the onToggle and onSelect callback passed to the Nav component */
itemId?: string | number | null;
/** If true prevents the default anchor link action to occur. Set to true if you want to handle navigation yourself. */
preventDefault?: boolean;
/** Callback for item click */
onClick?: NavSelectClickHandler;
/** Component used to render NavItems if React.isValidElement(children) is false */
component?: React.ReactNode;
/** Flyout of a nav item. This should be a Menu component. */
flyout?: React.ReactElement;
/** Callback when flyout is opened or closed */
onShowFlyout?: () => void;
}
export declare const NavItem: React.FunctionComponent<NavItemProps>;
//# sourceMappingURL=NavItem.d.ts.map