@rmsjs/vue3-dialog-tw/README.md

A VueJs(Vue3) component library for creating confirm/notification dialog.

# rms-vue3-dialog-tw

A simple, customizable Vue 3 confirmation dialog component built with Vue 3 and Tailwind CSS.

# 📦 Installation

```
npm install @rmsjs/vue3-dialog-tw
```

# 📝 Usage Example

Here’s how to use both dialogs in your components:

## Confirmation Dialog Example

```vue
<script setup>
import { showConfirmDialog } from '@rmsjs/vue3-dialog-tw'

async function openConfirmDialog() {
  const result = await showConfirmDialog({
    title: 'Delete Item?',
    message: 'Are you sure you want to delete this item?',
    btnConfirmText: 'Yes, Delete',
    btnCancelText: 'Cancel',
    showCloseIcon: true,
  })
  console.log('User confirmed:', result)
}
</script>

<template>
  <button @click="openConfirmDialog">Open Confirm Dialog</button>
</template>
```

## Notification Dialog Example (Autoclose)

```vue
<script setup>
import { showNotificationDialog } from '@rmsjs/vue3-dialog-tw'

async function openNotificationDialog() {
  const result = await showNotificationDialog({
    title: 'Notification',
    message: 'This is a notification message.',
    timer: 5000, // closes after 5 seconds
    showCloseIcon: true,
    type: 'success', // success, warning, error
    position: 'top-right', // 'center', 'top-right', 'top-left', 'bottom-right', 'bottom-left'
  })
  console.log('Notification closed:', result)
}
</script>

<template>
  <button @click="openNotificationDialog">Open Notification Dialog</button>
</template>
```

## Notification Dialog Example (Manual Close)

```vue
<script setup>
import { showNotificationDialog } from '@rmsjs/vue3-dialog-tw'

async function openNotificationDialogManual() {
  const result = await showNotificationDialog({
    title: 'Manual Notification',
    message: 'This notification will not autoclose.',
    disableAutoClose: true,
    showCloseIcon: true,
    position: 'bottom-left', // Example position
  })
  console.log('Notification closed:', result)
}
</script>

<template>
  <button @click="openNotificationDialogManual">Open Manual Notification Dialog</button>
</template>
```

# 🧭 Notification Dialog Position

You can set the position of the notification dialog using the `position` prop:

- `center` (default)
- `top-right`
- `top-left`
- `bottom-right`
- `bottom-left`

Example:

```js
showNotificationDialog({
  title: 'Hello',
  message: 'Positioned top right!',
  position: 'top-right',
  type: 'success',
})
```

# 💡 How it works:

showConfirmDialog() opens the confirmation dialog.
The dialog returns a Promise. If the user clicks Confirm, the promise resolves with true. If they click Cancel or close the dialog, the promise resolve to null.
You can customize the title, message, and button text via props.

# 🔧 Props for showConfirmDialog

## Props

The following props are available for the `ConfirmDialog` component:

- **`title`** (String, default: `""`): The title displayed in the dialog.
- **`message`** (String, default: `""`): The message/content displayed in the dialog.
- **`titleClass`** (String, default: `""`): Custom CSS classes for the title.
- **`messageClass`** (String, default: `""`): Custom CSS classes for the message.
- **`btnConfirmText`** (String, default: `"OK"`): The text for the confirm button.
- **`btnCancelText`** (String, default: `"Cancel"`): The text for the cancel button.
  // The following two props are handled internally by the library and do not need to be provided by users unless you want custom output:
  // **`onConfirm`** (Function): Callback for confirm action (internal use).
  // **`onCancel`** (Function): Callback for cancel action (internal use).
- **`dialogBoxMinWidth`** (String, default: `"300px"`): Minimum width for the dialog box.
- **`dialogBoxClasses`** (String, default: ""): Custom CSS classes for the dialog box.
- **`btnConfirmClasses`** (String, default: `"bg-green-500 hover:bg-green-600 text-white font-bold py-2 px-4 rounded"`): Custom CSS classes for the confirm button.
- **`btnCancelClasses`** (String, default: `"bg-gray-300 hover:bg-gray-400 text-gray-800 font-bold py-2 px-4 rounded"`): Custom CSS classes for the cancel button.
- **`closeIconClasses`** (String, default: ""): Custom CSS classes for the close icon.
- **`showCloseIcon`** (Boolean, default: `true`): If `true`, a close button will be shown in the top-right corner of the dialog.
- **`btnConfirmRes`** (String|Boolean, default: `true`): The response for the confirm button.
- **`btnCancelRes`** (String|Boolean, default: `false`): The response for the cancel button.
- **`timer`** (Number, default: `0`): Time in milliseconds before the dialog auto-closes. If `0`, dialog will not auto-close.
- **`disableAutoClose`** (Boolean, default: `false`): If `true`, disables auto-close behavior.

# 🔧 Props for showNotificationDialog

The following props are available for the NotificationDialog component:

## Props

- **`title`** (String, default: ""): The title displayed in the dialog.
- **`message`** (String, default: ""): The message/content displayed in the dialog.
- **`type`** (String, default: `'success'`): The type of notification. Options: `'success'`, `'warning'`, `'error'`. Determines the icon and color of the notification.
- **`position`** (String, default: `'top-right'`): The position of the notification on the screen. Options: `'top-right'`, `'top-left'`, `'center'`, `'bottom-right'`, `'bottom-left'`.
- **`timer`** (Number, default: `null`): Time in milliseconds before the dialog auto-closes. If not set, dialog will not auto-close unless `disableAutoClose` is false.
- **`disableAutoClose`** (Boolean, default: `false`): If `true`, disables auto-close behavior.
- **`showCloseIcon`** (Boolean, default: `true`): If `true`, a close button will be shown in the top-right corner of the dialog.
- **`closeIconClasses`** (String, default: ""): Custom CSS classes for the close icon (for styling the close button/icon).
- **`dialogBoxMinWidth`** (String, default: "300px"): Minimum width for the dialog box.
- **`dialogBoxClasses`** (String, default: ""): Custom CSS classes for the dialog box.

# 📌 Styling

The library is styled with Tailwind CSS. Make sure Tailwind is installed and configured in your project. Also, include the confirmation dialog's CSS:

```
import '@rmsjs/vue3-dialog-tw/dist/rms-vue3-dialog-tw.css';
```

# 💻 Customize the Dialog

You can customize the dialog appearance and button styles using props like btnConfirmText, btnCancelText, and additional classes (btnConfirmClasses, btnCancelClasses, etc.).

Example:

```
const result = await showConfirmDialog({
  title: 'Confirm Action',
  message: 'Are you sure you want to continue?',
  btnConfirmText: 'Save',
  btnCancelText: 'Cancel',
  btnConfirmClasses: 'bg-green-600 text-white',  // Tailwind classes
  btnCancelClasses: 'bg-red-600 text-white'      // Tailwind classes
});
```

# 🔧 API

showConfirmDialog(props) — Opens the dialog and returns a promise.