# @fayegram-ai/faye-ui/patterns/shell

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

## Import

```tsx
import { AppShell } from '@fayegram-ai/faye-ui/patterns/shell';
```

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

This entry has no declared client boundary; individual exported behavior still follows its rendering contract.

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `AppShell` | value | `({ sidebar, header, footer, sidebarLabel, mainAs: Main, mainId, mainLabel, height, scroll, className, children, ...props }: AppShellProps) => import("react").JSX.Element` |
| `AppShellProps` | type | `AppShellProps` |

## AppShell

Use a Drawer for narrow-screen navigation. Never hide the only navigation path.

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 |
|---|---|---|---|
| `footer` | No | `ReactNode` | See the usage contract and declaration. |
| `header` | No | `ReactNode` | See the usage contract and declaration. |
| `height` | No | `"content" \| "parent" \| "viewport" \| undefined` | Viewport preserves the original default. Content is for embedded examples. |
| `mainAs` | No | `"div" \| "main" \| "section" \| undefined` | See the usage contract and declaration. |
| `mainId` | No | `string \| undefined` | See the usage contract and declaration. |
| `mainLabel` | No | `string \| undefined` | See the usage contract and declaration. |
| `scroll` | No | `"document" \| "workspace" \| undefined` | Workspace gives the main region its own scroll container in a bounded shell. |
| `sidebar` | Yes | `ReactNode` | See the usage contract and declaration. |
| `sidebarLabel` | No | `string \| 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/shell.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.