@sinchsmb/ui-kit
Version:
UI kit for SinchSMB frontend
33 lines (32 loc) • 1.09 kB
TypeScript
import { ReactNode } from 'react';
import { CommonProps } from '../../types';
/** Props for {@link NavigationPanel} */
export interface NavigationPanelProps extends CommonProps {
/**
* Array of {@link NavigationPanelItem} and custom React nodes.
* Each will be wrapped into `li` tag with `presentation` role
*/
children: ReactNode;
/**
* Menu header
*/
title: ReactNode;
/**
* Logo, it's possible to use here {@link NavigationPanelLogo} or any custom component
*/
logo?: ReactNode;
}
/**
* The Third Level of navigation.
*
* It lives without the First Level and shrinks content as part of the body. It also has a back home button.
* We use it for sections that should be isolated from the main application.
*
* ```tsx
* <NavigationPanel logo={<NavigationPanelLogo label="Home label" src="/logo.svg" to="/" />}>
* <NavigationPanelItem title="Label" to="/" />
* <NavigationPanelItem title="Label" to="/" />
* </NavigationPanel>
* ```
*/
export declare function NavigationPanel(props: NavigationPanelProps): JSX.Element;