reblend-ui
Version:
Utilities for creating robust overlay components
39 lines (38 loc) • 1.13 kB
TypeScript
import * as Reblend from 'reblendjs';
import { EventKey, DynamicComponent } from './types';
import Button from './Button';
export interface NavItemProps extends Reblend.HTMLAttributes<HTMLElement> {
/**
* Highlight the NavItem as active.
*/
active?: boolean;
/**
* Element used to render the component.
*/
as?: Reblend.ElementType;
/**
* Disable the NavItem, making it unselectable.
*/
disabled?: boolean;
/**
* Value passed to the `onSelect` handler, useful for identifying the selected NavItem.
*/
eventKey?: EventKey;
/**
* HTML `href` attribute corresponding to `a.href`.
*/
href?: string;
}
export interface UseNavItemOptions {
key?: string | null;
onClick?: Reblend.MouseEventHandler;
active?: boolean;
disabled?: boolean;
id?: string;
role?: string;
}
export declare function useNavItem({ key, onClick, active, id, role, disabled, }: UseNavItemOptions): readonly [any, {
readonly isActive: boolean | undefined;
}];
declare const NavItem: DynamicComponent<typeof Button, NavItemProps>;
export default NavItem;