react-router-prompt - npm Package Compare versions

Comparing version 0.3.1-beta to 0.4.0

dist/hooks/use-confirm.d.ts

@@ -0,11 +1,8 @@
+import { unstable_BlockerFunction as BlockerFunction } from "react-router-dom";
 declare interface InitialStateType {
     isActive: boolean;
-    proceed: (value: unknown) => void;
-    cancel: (value: unknown) => void;
+    onConfirm(): void;
+    resetConfirmation(): void;
 }
-declare interface ConfirmLeaveReturnType extends InitialStateType {
-    onConfirm: () => Promise<boolean>;
-    resetConfirmation: () => void;
-}
-declare const useConfirm: () => ConfirmLeaveReturnType;
+declare const useConfirm: (when: boolean | BlockerFunction) => InitialStateType;
 export default useConfirm;

dist/index.d.ts

 import React from "react";
-declare type ReactRouterPromptProps = {
-    when: boolean;
+import { unstable_BlockerFunction as BlockerFunction } from "react-router-dom";
+type ReactRouterPromptProps = {
+    when: boolean | BlockerFunction;
     children: (data: {
         isActive: boolean;
-        onCancel: (value: unknown) => void;
-        onConfirm: (value: unknown) => void;
+        onCancel(): void;
+        onConfirm(): void;
     }) => React.ReactNode;
 };
-declare const Main: React.FC<ReactRouterPromptProps>;
-export default Main;
+/**
+ * A replacement component for the react-router `Prompt`.
+ * Allows for more flexible dialogs.
+ *
+ * @example
+ * <ReactRouterPrompt when={isDirty}>
+ *   {({isActive, onConfirm, onCancel}) => (
+ *     <Modal show={isActive}>
+ *       <div>
+ *         <p>Do you really want to leave?</p>
+ *         <button onClick={onCancel}>Cancel</button>
+ *         <button onClick={onConfirm}>Ok</button>
+ *       </div>
+ *     </Modal>
+ *   )}
+ * </ReactRouterPrompt>
+ */
+declare function ReactRouterPrompt({ when, children }: ReactRouterPromptProps): JSX.Element | null;
+export default ReactRouterPrompt;

package.json

 {
   "name": "react-router-prompt",
-  "version": "0.3.1-beta",
+  "version": "0.4.0",
   "description": "React Router Navigation Prompt for v6",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/react-router-prompt.umd.cjs",
+  "module": "./dist/react-router-prompt.js",
+  "exports": {
+    ".": {
+      "import": "./dist/react-router-prompt.js",
+      "require": "./dist/react-router-prompt.umd.cjs"
+    }
+  },
   "author": "Shyam Gupta ([e-mail])",
@@ -23,31 +33,56 @@ "license": "MIT",
   "scripts": {
-    "clean": "rimraf dist",
-    "start": "tsdx watch",
-    "build": "yarn clean && tsdx build",
-    "test": "tsdx test",
-    "lint": "tsdx lint src",
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint src --ext .js,.jsx,.ts,.tsx",
+    "lint:fix": "eslint src --ext .js,.jsx,.ts,.tsx --fix",
+    "format": "prettier \"src/**/*.{js,jsx,ts,tsx,css,scss}\" --write",
+    "compile": "tsc",
+    "preview": "vite preview",
+    "test": "vitest",
     "size": "size-limit",
-    "prepublishOnly": "yarn build"
+    "prepublishOnly": "yarn build",
+    "prepare": "husky install",
+    "coverage": "vitest run --coverage"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "tsdx lint src"
+      "pre-commit": "pnpm lint"
     }
   },
+  "dependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
   "devDependencies": {
-    "@size-limit/preset-small-lib": "^8.1.0",
-    "@types/react": "^18.0.15",
-    "@types/react-dom": "^18.0.6",
-    "esbuild": "^0.14.49",
+    "@size-limit/preset-small-lib": "^8.1.2",
+    "@types/react": "^18.0.27",
+    "@types/react-dom": "^18.0.10",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "@vitejs/plugin-react-swc": "^3.1.0",
+    "@vitest/coverage-c8": "^0.28.4",
+    "eslint": "^8.34.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "happy-dom": "^8.2.6",
     "history": "^5.3.0",
-    "husky": "^8.0.1",
+    "husky": "^8.0.3",
+    "path": "^0.12.7",
+    "prettier": "^2.8.4",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-error-boundary": "^3.1.4",
-    "react-router-dom": "^6.4.1",
-    "rimraf": "^3.0.2",
-    "size-limit": "^8.1.0",
-    "tsdx": "^0.14.1",
-    "tslib": "^2.4.0",
-    "typescript": "^4.7.4"
+    "react-router-dom": "^6.8.1",
+    "size-limit": "^8.1.2",
+    "tslib": "^2.5.0",
+    "typescript": "^4.9.5",
+    "vite": "^4.1.1",
+    "vite-plugin-dts": "^1.7.2",
+    "vite-tsconfig-paths": "^4.0.5",
+    "vitest": "^0.28.4"
   },
@@ -57,14 +92,4 @@ "peerDependencies": {
     "react-router": ">=6.x",
-    "react-router-dom": ">=6.x"
+    "react-router-dom": ">=6.7"
   },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "prettier": {
-    "printWidth": 80,
-    "semi": true,
-    "singleQuote": false,
-    "trailingComma": "es5"
-  },
   "size-limit": [
@@ -79,4 +104,3 @@ {
     }
-  ],
-  "dependencies": {}
+  ]
 }

README.md

@@ -20,2 +20,6 @@ <h1 align="center">react-router-prompt 🚨</h1>
 ```sh
+pnpm add react-router-prompt
+```
+
+```sh
 yarn add react-router-prompt
@@ -40,2 +44,6 @@ ```
 
+## Note:
+
+This version works with react-router-dom >=v6.7
+
 ## 🤝 Contributing
@@ -42,0 +50,0 @@

New alerts

Unpublished package

Supply chain risk

Package version was not found on the registry. It may exist on a different registry and need to be configured to pull from that registry.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

74

increased by12.12%

Is type module

Yes

Worsened metrics

Total package byte prevSize

45855

decreased by-47.43%

Dependency count

5

increased by66.67%

Dev dependency count

31

increased by106.67%

Number of package files

9

decreased by-50%

Lines of code

789

decreased by-39.35%

Number of low supply chain risk alerts

4

increased by300%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedreact@^18.2.0

• + Addedreact-dom@^18.2.0

• + Addedjs-tokens@4.0.0(transitive)

• + Addedloose-envify@1.4.0(transitive)

• + Addedreact@18.3.1(transitive)

• + Addedreact-dom@18.3.1(transitive)

• + Addedscheduler@0.23.2(transitive)

• - Removedreact@19.0.0(transitive)

• - Removedreact-dom@19.0.0(transitive)

• - Removedscheduler@0.25.0(transitive)