# @fayegram-ai/faye-ui/patterns/navigation-drawer

Public exports and dependency-resolved component properties, with usage and rendering guidance.

## Import

```tsx
import { NavigationDrawer } from '@fayegram-ai/faye-ui/patterns/navigation-drawer';
```

[Usage and behavior guide](/docs/patterns/) · [API JSON](/api/packages/patterns/navigation-drawer.json)

This entry declares a client boundary. Follow the rendering guide for framework integration.

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `NavigationDrawer` | value | `({ open, onOpenChange, title, navigation, miniNavigation, mode, edge, toggleLabel, closeLabel, triggerProps, closeProps, desktopTriggerProps, desktopCloseProps, className, children, ...props }: NavigationDrawerProps) => import("react").JSX.Element` |
| `NavigationDrawerProps` | type | `NavigationDrawerProps` |

## NavigationDrawer

Desktop navigation pushes content; below 48rem the same navigation uses a modal drawer.

Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.

### Properties

| Property | Required | Type | Meaning |
|---|---|---|---|
| `closeLabel` | No | `string \| undefined` | See the usage contract and declaration. |
| `closeProps` | No | `(Omit<DialogCloseProps, "ref"> & RefAttributes<HTMLButtonElement> & { variants?: { readonly size?: import("packages/faye-ui/dist/contracts/visual-variants").VisualVariant<"dialog", "size"> \| undefined; readonly tone?: import("packages/faye-ui/dist/contracts/visual-variants").VisualVariant<"dialog", "tone"> \| undefined; } \| undefined; }) \| undefined` | See the usage contract and declaration. |
| `desktopCloseProps` | No | `Partial<IconButtonProps> \| undefined` | See the usage contract and declaration. |
| `desktopTriggerProps` | No | `ButtonProps \| undefined` | See the usage contract and declaration. |
| `edge` | No | `"start" \| "end" \| undefined` | See the usage contract and declaration. |
| `miniNavigation` | No | `ReactNode` | See the usage contract and declaration. |
| `mode` | No | `"persistent" \| "mini" \| undefined` | See the usage contract and declaration. |
| `navigation` | Yes | `ReactNode` | See the usage contract and declaration. |
| `onOpenChange` | Yes | `(open: boolean) => void` | See the usage contract and declaration. |
| `open` | Yes | `boolean` | See the usage contract and declaration. |
| `title` | Yes | `ReactNode` | See the usage contract and declaration. |
| `toggleLabel` | No | `string \| undefined` | Accessible name for the opening control; the actual render element stays configurable. |
| `triggerProps` | No | `(DialogTriggerProps<unknown> & RefAttributes<HTMLElement> & { variants?: { readonly size?: import("packages/faye-ui/dist/contracts/visual-variants").VisualVariant<"dialog", "size"> \| undefined; readonly tone?: import("packages/faye-ui/dist/contracts/visual-variants").VisualVariant<"dialog", "tone"> \| undefined; } \| undefined; }) \| undefined` | See the usage contract and declaration. |



## Defaults and customization

Defaults and native behavior are documented in the linked family guide. This reference does not infer a default from an optional property.

Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.

## State, events and accessibility

For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.

## Declaration authority

Generated from `packages/faye-ui/dist/patterns/navigation-drawer.d.ts` after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. [React DOM attributes](https://react.dev/reference/react-dom/components/common) and [Base UI component contracts](https://base-ui.com/react/overview/quick-start) describe the inherited foundations.