# @fayegram-ai/faye-ui/overlays/modal

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

## Import

```tsx
import { Modal } from '@fayegram-ai/faye-ui/overlays/modal';
```

[Usage and behavior guide](/docs/dialogs/) · [API JSON](/api/packages/overlays/modal.json)

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

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `Modal` | value | `(input: ModalProps) => import("react").JSX.Element` |
| `ModalProps` | type | `ModalProps` |

## Modal

Public component; use the linked family guide for complete composition and behavior.

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 |
|---|---|---|---|
| `children` | Yes | `ReactNode` | See the usage contract and declaration. |
| `closeLabel` | No | `string \| undefined` | Accessible label for the close control; localizable through modal/root settings. |
| `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` | Override the default icon, events, styling or render element. |
| `description` | No | `ReactNode` | See the usage contract and declaration. |
| `footer` | No | `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. |
| `size` | No | `"sm" \| "md" \| "lg" \| undefined` | See the usage contract and declaration. |
| `title` | Yes | `ReactNode` | See the usage contract and declaration. |
| `trigger` | No | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| undefined` | Associate an opening control with the dialog for dismissal and focus restoration. |



## 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/overlays/modal.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.