@konstructio/ui
Version:
A set of reusable and customizable React components built for konstruct.io
29 lines (28 loc) • 1.15 kB
TypeScript
import { FC } from 'react';
import { Footer, Label, Logo, Navigation, NavigationGroup, NavigationOption, NavigationSeparator } from './components';
import { SidebarChildrenProps, Props as SidebarProps } from './Sidebar.types';
/**
* A compound component for building application sidebars.
* Includes sub-components for logo, navigation, groups, options, and footer.
*
* @example
* ```tsx
* <Sidebar canResize minWith={200} maxWith={400} theme="dark">
* <Sidebar.Logo>
* <img src="/logo.svg" alt="Logo" />
* </Sidebar.Logo>
* <Sidebar.Navigation>
* <Sidebar.NavigationGroup label="Menu">
* <Sidebar.NavigationOption href="/" icon={<Home />}>
* Home
* </Sidebar.NavigationOption>
* </Sidebar.NavigationGroup>
* </Sidebar.Navigation>
* <Sidebar.Footer>Version 1.0</Sidebar.Footer>
* </Sidebar>
* ```
*
* @see {@link https://konstructio.github.io/konstruct-ui/?path=/docs/components-sidebar--docs Storybook}
*/
declare const Sidebar: FC<SidebarProps> & SidebarChildrenProps;
export { Footer, Label, Logo, Navigation, NavigationGroup, NavigationOption, NavigationSeparator, Sidebar, };