rsuite
Version:
A suite of react components
32 lines (31 loc) • 1.19 kB
TypeScript
import React from 'react';
import { RsRefForwardingComponent, WithAsProps } from '../internals/types';
import { IconProps } from '@rsuite/icons/Icon';
export interface NavItemProps<T = string | number> extends WithAsProps, Omit<React.HTMLAttributes<HTMLElement>, 'onSelect'> {
/** Activation status */
active?: boolean;
/** Disabled status */
disabled?: boolean;
/** divier for nav item */
divider?: boolean;
/** display panel */
panel?: boolean;
/** Sets the icon for the component */
icon?: React.ReactElement<IconProps>;
/** The value of the current option */
eventKey?: T;
/** Providing a `href` will render an `<a>` element */
href?: string;
/** Select the callback function that the event triggers. */
onSelect?: (eventKey: T | undefined, event: React.SyntheticEvent) => void;
}
/**
* The `Nav.Item` component is used to create navigation links.
*
* - When used as direct child of `<Nav>`, render the NavItem
* - When used within a `<Nav.Menu>`, render the NavDropdownItem
* @see https://rsuitejs.com/components/nav
*
*/
declare const NavItem: RsRefForwardingComponent<'a', NavItemProps>;
export default NavItem;