@saas-ui/modals/README.md

A modal manager for Chakra UI

# @saas-ui/modal

Chakra UI modals manager.

Build in modal types:

- Modal
- Drawer
- Form
- Dialog
- ConfirmDialog
- MenuDialog

## Installation

```sh
$ yarn add @saas-ui/modals

#or

$ npm i @saas-ui/modals  --save
```

## Usage

### Add the ModalProvider to your app.

```ts
import { ModalsProvider } from '@saas-ui/modals'

export default App() {
  return (
    <ModalsProvider>
      {children}
    </ModalsProvider>
  )
}
```

### Open a modal

```ts
import { useModals } from '@saas-ui/modals'

function MyComponent() {
  const modals = useModals()

  modals.open({
    title: 'My modal',
    body: <>My modal body</>,
  })
}
```

### Open a drawer

```ts
import { useModals } from '@saas-ui/modals'

function MyComponent() {
  const modals = useModals()

  modals.drawer({
    title: 'My drawer',
    body: <>My drawer body</>,
  })
}
```

### Open a confirm dialog

```ts
import { useModals } from '@saas-ui/modals'

function MyComponent() {
  const modals = useModals()

  modals.confirm({
    title: 'Delete user',
    body: 'Are you sure you want to delete this user?'
    onConfirm: () => //delete user
  })
}
```

## Docs

https://www.saas-ui.dev/docs/overlay/modals-manager

## Source

https://github.com/saas-js/saas-ui/tree/next/packages/saas-ui-modals

## License

MIT - Appulse Software