Skip to content

Commit

Permalink
chore: rename package
Browse files Browse the repository at this point in the history
  • Loading branch information
TimMikeladze committed Dec 28, 2023
1 parent 00122ba commit 6a16036
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# joy-ui-confirm
# mui-joy-confirm

Confirmation dialogs built on top of @mui/joy and react hooks. The source-code is a port of the [material-ui-confirm](https://github.com/jonatanklosko/material-ui-confirm) package and is slightly rewritten to support [@mui/joy](https://mui.com/joy-ui/).

Checkout this [Example Storybook](https://TimMikeladze.github.io/joy-ui-confirm/) for a live demo or [read the code](https://github.com/TimMikeladze/joy-ui-confirm/blob/master/src/stories/index.stories.tsx).
Checkout this [Example Storybook](https://TimMikeladze.github.io/mui-joy-confirm/) for a live demo or [read the code](https://github.com/TimMikeladze/mui-joy-confirm/blob/master/src/stories/index.stories.tsx).

## 📡 Install

```console
npm install joy-ui-confirm
npm install mui-joy-confirm

yarn add joy-ui-confirm
yarn add mui-joy-confirm

pnpm add joy-ui-confirm
pnpm add mui-joy-confirm
```

> 👋 Hello there! Follow me [@linesofcode](https://twitter.com/linesofcode) or visit [linesofcode.dev](https://linesofcode.dev) for more cool projects like this one.
Expand All @@ -21,7 +21,7 @@ pnpm add joy-ui-confirm
First, render a `ConfirmProvider` near the root of your application. This will provide the `useConfirm` hook to all children.

```tsx
import { ConfirmProvider } from 'joy-ui-confirm';
import { ConfirmProvider } from 'mui-joy-confirm';

export default () => {
return (
Expand All @@ -36,7 +36,7 @@ Now use the `useConfirm` hook to show confirmation dialogs.

```tsx
import { Button } from '@mui/joy';
import { useConfirm } from 'joy-ui-confirm';
import { useConfirm } from 'mui-joy-confirm';

export default () => {
const confirm = useConfirm();
Expand All @@ -63,7 +63,7 @@ export default () => {
You can also customize the dialog by passing `defaultOptions` to the `ConfirmProvider` or directly to the `confirm` function.

```tsx
import { ConfirmProvider } from 'joy-ui-confirm';
import { ConfirmProvider } from 'mui-joy-confirm';

export default () => {
return (
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "joy-ui-confirm",
"name": "mui-joy-confirm",
"description": "✅ Confirmation dialogs built on top of @mui/joy and react hooks.",
"version": "1.0.1",
"author": "Tim Mikeladze <tim.mikeladze@gmail.com>",
Expand All @@ -14,7 +14,7 @@
],
"repository": {
"type": "git",
"url": "git@github.com:TimMikeladze/joy-ui-confirm.git"
"url": "git@github.com:TimMikeladze/mui-joy-confirm.git"
},
"scripts": {
"dev": "concurrently \"yarn build --watch\" \"yarn storybook\" \"yarn test\" ",
Expand Down

0 comments on commit 6a16036

Please sign in to comment.