---
url: /inertia-modal/docs/introduction.md
---
# Introduction

Inertia Modal is part of [Inertia UI](https://inertiaui.com), a suite of packages designed for Laravel, Inertia.js, and Tailwind CSS. With Inertia Modal, you can easily open any route in a Modal or Slideover without having to change anything about your existing routes or controllers.

::: tip Version Compatibility
You are reading the docs for **Inertia Modal 3.x**, which requires **Inertia.js v3**. If you're using Inertia.js v2, use [Inertia Modal 2.x](/v2/introduction) instead. See [Requirements](/requirements) for details.
:::

Here's a summary of the features:

* Supports React and Vue
* Zero backend configuration
* Super simple frontend API
* Support for Base Route / URL
* Modal and slideover support
* Headless support
* Nested/stacked modals support
* Reusable modals
* Multiple sizes and positions
* Reload props in modals
* Easy communication between nested/stacked modals
* Highly configurable
* Prefetch support for faster modal loading
* Native HTML dialog support for better accessibility
* TypeScript type definitions included
* Local modals with prop passing

## Example

The package comes with two components: `Modal` and `ModalLink`. `ModalLink` is very similar to Inertia's [built-in `Link` component](https://inertiajs.com/links), but it opens the linked route in a modal instead of a full page load. So, if you have a link that you want to open in a modal, you can simply replace `Link` with `ModalLink`.

```vue
<script setup>
import { ModalLink } from '@inertiaui/modal-vue'
</script>

<template>
    <ModalLink href="/users/create">Create User</ModalLink>
</template>
```

The page you linked can then use the `Modal` component to wrap its content in a modal.

```vue
<script setup>
import { Modal } from '@inertiaui/modal-vue'
</script>

<template>
    <Modal>
        <h1>Create User</h1>
        <form>
            <!-- Form fields -->
        </form>
    </Modal>
</template>
```

That's it! There is no need to change anything about your routes or controllers!