@atlaskit/side-navigation
Version:
A highly composable side navigation component that supports nested views.
44 lines (43 loc) • 1.92 kB
TypeScript
/**
* @deprecated `@atlaskit/side-navigation` is deprecated. Use `@atlaskit/navigation-system` instead.
*/
export interface SideNavigationProps {
/**
* Describes the specific role of this navigation component for people viewing the page with assistive technology.
* This differentiates the navigation from other navigation components on a page.
*/
label: string;
/**
* Child navigation elements.
* You'll want to compose children from [navigation header](/packages/navigation/side-navigation/docs/navigation-header),
* [navigation content](/packages/navigation/side-navigation/docs/navigation-content) or [nestable navigation content](/packages/navigation/side-navigation/docs/nestable-navigation-content),
* and [navigation footer](/packages/navigation/side-navigation/docs/navigation-footer).
*/
children: JSX.Element[] | JSX.Element;
/**
* A `testId` prop is provided for specified elements,
* which is a unique string that appears as a data attribute `data-testid` in the rendered code,
* serving as a hook for automated tests.
*/
testId?: string;
/**
* Whether nav is rendered on the server.
*/
isServer?: boolean;
/**
* Whether to enable SSR placeholder replacement.
*/
isSSRPlaceholderEnabled?: boolean;
}
/**
* __Side navigation__
*
* A highly composable side navigation component that supports nested views.
*
* - [Examples](https://atlassian.design/components/side-navigation/examples)
* - [Code](https://atlassian.design/components/side-navigation/code)
* - [Usage](https://atlassian.design/components/side-navigation/usage)
*
* @deprecated `@atlaskit/side-navigation` is deprecated. Use `@atlaskit/navigation-system` instead.
*/
export declare const SideNavigation: React.ForwardRefExoticComponent<React.PropsWithoutRef<SideNavigationProps> & React.RefAttributes<HTMLElement>>;