## Intro
React Promise Confirmation Dialog is a simple and easy-to-use package that allows you to create dynamic and customizable confirmation dialogs. You can easily handle user confirmation and rejection responses using promises.
This package is customizable, allowing you to easily tailor the look and feel of your dialogs to match the style of your application.
### ✨ [Live Demo](https://gentrithalili1.github.io/react-promise-confirmation-dialog/)
##
## Install
Install `react-promise-confirmation-dialog` via `yarn` or `npm`
```sh
yarn add react-promise-confirmation-dialog
```
```sh
npm i react-promise-confirmation-dialog
```
## Usage
```js
import { PromiseConfirmationContextProvider } from 'react-promise-confirmation-dialog'
```
```jsx
function Index() {
return (
);
}
```
```jsx
function App() {
const handleConfirmClick = async () => {
try {
await confirmation.confirm()
// Your code after confirmation is resolved ...
} catch (rejectReason) {
// Your code after confirmation is declined ...
}
};
return (
);
}
```
## Props and Configurations
You can provide default configuration to PromiseConfirmationContextProvider
```jsx
function Index() {
return (
);
}
```
| name | type | default | description |
|-------------------| --------- |---------------|-------------------------------------------------|
| `portalElementId` | `string` | undefined | Custom element to render the confirmation modal |
| `text` | `string` | Are you sure? | Modal title. |
| `confirmButtonLabel` | `string` | `Confirm` | Confirm button text |
| `cancelButtonLabel`| `string` | Cancel | Decline button text | |
---
You can also provide custom params everytime you open a confirmation dialog
```jsx
function App() {
const handleConfirmClick = async () => {
try {
await confirmation.confirm({
text: '',
confirmButtonLabel: '',
cancelButtonLabel: '',
customData: '',
customComponent: ''
})
// Your code after confirmation is resolved ...
} catch (rejectReason) {
// Your code after confirmation is declined ...
}
};
return (
);
}
```
| name | type | default | description |
|----------------------|--------|-------------|----------------------------------------|
| `text` | `string` | Are you sure? | Modal title |
| `confirmButtonLabel` | `string` | Confirm | Confirm button text |
| `cancelButtonLabel` | `string` | Cancel | Decline button text | |
| `customData` | `any` | undefined | Custom data when using custom components | |
| `customComponent` | `(params: Omit) => ReactNode` | undefined | Custom component | |
---
## Todos
- [ ] Default custom component support
## Author
- Github: [@gentrithalili1](https://github.com/gentrithalili1)
---
_Source: https://npm.io/package/react-promise-confirmation-dialog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
