office-ui-fabric-react

/// <reference types="react" /> import * as React from 'react'; import { IStyle, ITheme } from '../../Styling'; import { IRefObject, IRenderFunction, IStyleFunctionOrObject } from '../../Utilities'; import { IIconProps } from '../Icon/Icon.types'; export interface INav { /** * The meta 'key' property of the currently selected NavItem of the Nav. Can return * undefined if the currently selected nav item has no populated key property. Be aware * that in order for Nav to properly understand which key is selected all NavItems in * all groups of the Nav must have populated key properties. */ selectedKey: string | undefined; } export interface INavProps { /** * Optional callback to access the INav interface. Use this instead of ref for accessing * the public methods and properties of the component. */ componentRef?: IRefObject<INav>; /** * Call to provide customized styling that will layer on top of the variant rules */ styles?: IStyleFunctionOrObject<INavStyleProps, INavStyles>; /** * Theme provided by HOC. */ theme?: ITheme; /** * Additional css class to apply to the Nav * @defaultvalue undefined */ className?: string; /** * A collection of link groups to display in the navigation bar */ groups: INavLinkGroup[] | null; /** * Used to customize how content inside the link tag is rendered * @defaultvalue Default link rendering */ onRenderLink?: IRenderFunction<INavLink>; /** * Function callback invoked when a link in the navigation is clicked */ onLinkClick?: (ev?: React.MouseEvent<HTMLElement>, item?: INavLink) => void; /** * Function callback invoked when the chevron on a link is clicked */ onLinkExpandClick?: (ev?: React.MouseEvent<HTMLElement>, item?: INavLink) => void; /** * Indicates whether the navigation component renders on top of other content in the UI */ isOnTop?: boolean; /** * (Optional) The key of the nav item initially selected. */ initialSelectedKey?: string; /** * (Optional) The key of the nav item selected by caller. */ selectedKey?: string; /** * (Optional) The nav container aria label. */ ariaLabel?: string; /** * (Optional) The nav container aria label. */ expandButtonAriaLabel?: string; /** * Deprecated at v0.68.1 and will be removed at >= V1.0.0. * @deprecated **/ expandedStateText?: string; /** * Deprecated at v0.68.1 and will be removed at >= V1.0.0. * @deprecated **/ collapsedStateText?: string; } export interface INavLinkGroup { /** * Text to render as the header of a group */ name?: string; /** * Links to render within this group */ links: INavLink[]; /** * The name to use for functional automation tests */ automationId?: string; /** * If true, the group should render collapsed by default */ collapseByDefault?: boolean; /** * Callback invoked when a group header is clicked */ onHeaderClick?: (ev?: React.MouseEvent<HTMLElement>, isCollapsing?: boolean) => void; } export interface INavLink { /** * Text to render for this link */ name: string; /** * URL to navigate to for this link */ url: string; /** * Unique, stable key for the link, used when rendering the list of links and for tracking * the currently selected link. */ key?: string; /** * Child links to this link, if any */ links?: INavLink[]; /** * Callback invoked when this link is clicked. Providing this callback will cause the link * to render as a button (rather than an anchor) unless forceAnchor is set to true. */ onClick?: (ev?: React.MouseEvent<HTMLElement>, item?: INavLink) => void; /** * Name of an icon to render next to the link button. */ icon?: string; /** * Deprecated. Use iconProps.className instead. * @deprecated */ iconClassName?: string; /** * Props for an icon to render next to the link button. */ iconProps?: IIconProps; /** * Deprecated at v0.68.1 and will be removed at >= v1.0.0. * @deprecated */ engagementName?: string; /** * Deprecated at v0.68.1 and will be removed at >= v1.0.0. * @deprecated */ altText?: string; /** * The name to use for functional automation tests */ automationId?: string; /** * Whether or not the link is in an expanded state */ isExpanded?: boolean; /** * Aria label for nav link */ ariaLabel?: string; /** * Text for title tooltip and ARIA description. */ title?: string; /** * Link <a> target. */ target?: string; /** * @deprecated Not used in the Nav control or anywhere else in office-ui-fabric-react. */ parentId?: string; /** * (Optional) By default, any link with onClick defined will render as a button. * Set this property to true to override that behavior. (Links without onClick defined * will render as anchors by default.) */ forceAnchor?: boolean; /** * (Optional) Any additional properties to apply to the rendered links. */ [propertyName: string]: any; } export interface INavStyleProps { /** * Accept theme prop. */ theme: ITheme; /** * Accept custom classNames */ className?: string; /** * is element on top boolean */ isOnTop?: boolean; /** * is element a link boolean */ isLink?: boolean; /** * is element a group boolean */ isGroup?: boolean; /** * is element expanded boolean */ isExpanded?: boolean; /** * is element selected boolean */ isSelected?: boolean; /** * is button */ isButtonEntry?: boolean; /** * Nav height value */ navHeight?: number; /** * left padding value */ leftPadding?: number; /** * left padding when expanded value */ leftPaddingExpanded?: number; /** * right padding value */ rightPadding?: number; /** * position value */ position?: number; /** * Inherited from INavProps * A collection of link groups to display in the navigation bar */ groups: INavLinkGroup[] | null; } export interface INavStyles { /** * Style set for the root element. */ root: IStyle; /** * Style set for the link text container div element. */ linkText: IStyle; /** * Style set for the link element extending the * root style set for ActionButton component. */ link: IStyle; /** * Style set for the composite link container div element */ compositeLink: IStyle; /** * Style set for the chevron button inside the composite * link and group elements. */ chevronButton: IStyle; /** * Style set for the chevron icon inside the composite * link and group elements. */ chevronIcon: IStyle; /** * Style set for the nav links ul element. */ navItems: IStyle; /** * Style set for the nav links li element. */ navItem: IStyle; /** * Style set for the group root div. */ group: IStyle; /** * Style set for the group content div inside group. */ groupContent: IStyle; }