Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove unstable references, removed wrapper div and update dependencies #133

Merged
merged 11 commits into from
Feb 17, 2024
Merged

Remove unstable references, removed wrapper div and update dependencies #133

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2a4f2ca
Removed unstable references
erictompkins Feb 17, 2024
8464142
Updated packages
erictompkins Feb 17, 2024
c37d02c
Updated readme to fix md lint issues
erictompkins Feb 17, 2024
5f56d25
Updated package name, repository, and home page
erictompkins Feb 17, 2024
360b9f6
0.7.0
erictompkins Feb 17, 2024
f941578
Added note in readme about why it was updated
erictompkins Feb 17, 2024
22bfaa2
0.7.1
erictompkins Feb 17, 2024
503fc04
Removed “as” statements
erictompkins Feb 17, 2024
316783e
Reverted package.json changes
erictompkins Feb 17, 2024
8acc98f
Removed package-lock.json and use pnpm
erictompkins Feb 17, 2024
344ead9
Removed comment in the readme
erictompkins Feb 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 13 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# react-router-prompt 🚨

> A component for the react-router 6 `Prompt`. Allows to create more flexible dialogs.
Expand Down Expand Up @@ -47,25 +46,25 @@ yarn add react-router-prompt

### Props

1. `when`: `boolean` | `BlockerFunction`
1. `when`: `boolean` | `BlockerFunction`

```ts
BlockerFunction = (args: {
currentLocation: Location;
nextLocation: Location;
historyAction: HistoryAction;
}) => boolean;
```
```ts
BlockerFunction = (args: {
currentLocation: Location
nextLocation: Location
historyAction: HistoryAction
}) => boolean
```

2. `beforeConfirm()` : `Promise<unknown>` _(Optional)_
2. `beforeConfirm()` : `Promise<unknown>` _(Optional)_

3. `beforeCancel()` : `Promise<unknown>` _(Optional)_
3. `beforeCancel()` : `Promise<unknown>` _(Optional)_

### Return values

1. `isActive`: `Boolean`
2. `onConfirm()`: `void`
3. `onCancel()`: `void`
1. `isActive`: `Boolean`
2. `onConfirm()`: `void`
3. `onCancel()`: `void`

#### Note 🗒️

Expand All @@ -76,7 +75,6 @@ For react-router support `(v6 - v6.2.x)` please install v0.3.0

For react-router support (v6.7.x - v6.18.x) please install v0.5.4


_Skipped support in middle due to breaking changes on react-router apis_

## Contributing
Expand Down