@sinchsmb/ui-kit
Version:
UI kit for SinchSMB frontend
34 lines (33 loc) • 1.27 kB
TypeScript
import { ReactNode } from 'react';
import { CommonProps } from '../../types';
/** Props for {@link NavigationBar} */
export interface NavigationBarProps extends CommonProps {
/**
* Array of {@link NavigationBarItem}, {@link NavigationBarList} and custom React nodes.
* Each will be wrapped into `li` tag with `presentation` role
*/
children: ReactNode;
/**
* Logo, it's possible to use here {@link NavigationBarLogo} or any custom component
*/
logo?: ReactNode;
}
/**
* The First Level of navigation.
*
* Mostly visible on the top level of an Application. It shrinks the content part as part of the body.
*
* ```tsx
* <NavigationBar logo={<NavigationBarLogo label="Lorem" src={logoSrc} to="/" />}>
* <NavigationBarItem label={ItemComponent} title="Lorem" to="/" />
* <NavigationBarList label={ItemComponent} title="Lorem">
* <NavigationBarListItem label="Label" to="/" />
* <NavigationBarListItem label="Label" to="/" />
* <NavigationBarListItem label="Label" to="/" />
* </NavigationBarList>
* <NavigationBarSpacer />
* <NavigationBarItem label={ItemComponent} title="Lorem" to="/" />
* </NavigationBar>
* ```
*/
export declare function NavigationBar(props: NavigationBarProps): JSX.Element;