Sidebar Package

A compound component for building navigation sidebars with collapsible sections, nested items, and responsive behavior.

Usage

``jsx
import { useTheme } from '@emotion/react';
import { Sidebar, useSidebar } from '@dt-dds/react-sidebar';
import { Icon } from '@dt-dds/react-icon';

export const App = () => {
const theme = useTheme();

const { isExpanded, toggleSidebar } = useSidebar({ isExpanded: true });

return (

(max-width: ${theme.breakpoints.mq3}px)}>


App Name



(max-width: ${theme.breakpoints.mq3}px)} />





Menu Item



Menu Item

Nested Menu Item
Nested Menu Item








Settings



(max-width: ${theme.breakpoints.mq3}px)} />

(max-width: ${theme.breakpoints.mq3}px)}>


Collapse



);
};
`

API

$3

| Property | Type | Default | Description |
| ------------ | ----------------------------- | -------- | --------------------------------- |
| isExpanded | boolean | required | Controls expanded/collapsed state |
| onToggle | (expanded: boolean) => void | - | Callback when toggle is triggered |
| placement | 'left' \| 'right' | 'left' | Desktop sidebar position |
| offsetTop | number | 0 | Top offset in pixels |
| ariaLabel | string | - | Accessibility label |

$3

| Property | Type | Default | Description |
| ----------------- | ----------------------------- | ------- | --------------------------------- |
| href | string | - | Navigation URL |
| defaultExpanded | boolean | false | Initial expanded state (SubList) |
| expanded | boolean | - | Controlled expanded state |
| onToggle | (expanded: boolean) => void | - | Callback when item is toggled |
| children | ReactNode | - | Item content and optional SubList |

$3

| Property | Type | Default | Description |
| ---------- | ----------- | ------- | ------------- |
| title | string | - | Section title |
| children | ReactNode | - | Section items |

$3

Wrapper for nested Sidebar.Item elements. Auto-expands when a child item is active.

$3

Fixed position sections at top/bottom of the sidebar.

$3

Scrollable content area between header and footer.

$3

Button that triggers onToggle.

$3

Visual separator between sections.

Hooks

$3

Standalone state management hook.

`jsx
const { isExpanded, setIsExpanded, toggleSidebar } = useSidebar({
isExpanded: true,
});
`

Custom Link Components

Supports custom link components (React Router, Next.js, etc.):

`jsx



Dashboard


`

Stack

- TypeScript for static type checking
- React — JavaScript library for user interfaces
- Emotion — for writing css styles with JavaScript
- Storybook — UI component environment powered by Vite
- Jest - JavaScript Testing Framework
- React Testing Library - to test UI components in a user-centric way
- ESLint for code linting
- Prettier for code formatting
- Tsup — TypeScript bundler powered by esbuild
- Yarn from managing packages

Commands

- yarn build - Build the package
- yarn dev - Run the package locally
- yarn lint - Lint all files within this package
- yarn test - Run all unit tests
- yarn test:report - Open the test coverage report
- yarn test:update:snapshot - Run all unit tests and update the snapshot

Compilation

Running yarn build from the root of the package will use tsup to compile the raw TypeScript and React code to plain JavaScript.

The /dist folder contains the compiled output.

`bash
sidebar
└── dist
├── index.d.ts <-- Types
├── index.js <-- CommonJS version
└── index.mjs <-- ES Modules version
...
``

Versioning

Follows semantic versioning

© License

Licensed under MIT License