

<InteractiveDemo
  name="modal"
  controls="[
  {
    type: 'boolean',
    name: 'isDismissable',
    defaultValue: true,
  },
]"
/>

## Installation [#installation]

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npx shadcn@latest add @dotui/modal
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm dlx shadcn@latest add @dotui/modal
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn dlx shadcn@latest add @dotui/modal
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun x shadcn@latest add @dotui/modal
    ```
  </CodeBlockTab>
</CodeBlockTabs>

## Usage [#usage]

Use modals to display content in a layer that overlays the page content.

```tsx
import { Button } from '@/components/ui/button'
import { Dialog, DialogContent } from '@/components/ui/dialog'
import { Modal } from '@/components/ui/modal'
```

```tsx
<Dialog>
  <Button>Open Modal</Button>
  <Modal>
    <DialogContent>Modal content</DialogContent>
  </Modal>
</Dialog>
```

## Examples [#examples]

<Examples>
  <Example name="modal/demos/basic" />
</Examples>

## API Reference [#api-reference]

### Modal [#modal]

<Reference name="modal" />

### ModalOverlay [#modaloverlay]

<Reference name="modal-overlay" />

### ModalBackdrop [#modalbackdrop]

<Reference name="modal-backdrop" />

### ModalViewport [#modalviewport]

<Reference name="modal-viewport" />

### ModalContent [#modalcontent]

<Reference name="modal-content" />
