hrnet-modal-react-dark 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +13 -3
  3. package/package.json +18 -2
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 nwyux
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -9,14 +9,19 @@ Accessible React confirmation modal, built for **HRnet** (WealthHealth) to repla
9
9
  - `role="dialog"` and `aria-modal="true"`; the title is the accessible name
10
10
  - Dark theme, styles shipped as one small CSS file (works with or without Tailwind)
11
11
 
12
+ ## Prerequisites
13
+
14
+ - [Node.js](https://nodejs.org/) **20.19 or later** (22 LTS recommended) and npm
15
+ - A React project using **React 18 or later**
16
+ - A bundler that handles CSS imports (Vite, Next.js, webpack…)
17
+ - Recommended editor: [Visual Studio Code](https://code.visualstudio.com/)
18
+
12
19
  ## Installation
13
20
 
14
21
  ```bash
15
22
  npm install hrnet-modal-react-dark
16
23
  ```
17
24
 
18
- Requires React 18 or later.
19
-
20
25
  ## Usage
21
26
 
22
27
  Import the component **and its stylesheet** once (for example in `main.tsx`):
@@ -59,12 +64,17 @@ The modal is **controlled**: the parent keeps the `isOpen` state and `onClose` u
59
64
 
60
65
  ## Development
61
66
 
62
- The source lives in `src/`. The build (Vite library mode + TypeScript declarations) outputs to `dist/`:
67
+ Source code: [github.com/nwyux/hrnet-modal](https://github.com/nwyux/hrnet-modal)
63
68
 
64
69
  ```bash
70
+ git clone https://github.com/nwyux/hrnet-modal.git
71
+ cd hrnet-modal
72
+ npm install
65
73
  npm run build
66
74
  ```
67
75
 
76
+ The source lives in `src/`. The build (Vite library mode + TypeScript declarations) outputs to `dist/`.
77
+
68
78
  `dist/index.js` is an ES module, `dist/style.css` holds the styles, `dist/*.d.ts` the types.
69
79
 
70
80
  ## License
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hrnet-modal-react-dark",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Accessible React confirmation modal for HRnet (replacement for the jQuery jquery.modal plugin).",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -28,9 +28,25 @@
28
28
  "react",
29
29
  "modal",
30
30
  "dialog",
31
- "hrnet"
31
+ "popup",
32
+ "confirmation",
33
+ "hrnet",
34
+ "jquery-modal",
35
+ "typescript"
32
36
  ],
37
+ "author": "nwyux",
33
38
  "license": "MIT",
39
+ "repository": {
40
+ "type": "git",
41
+ "url": "git+https://github.com/nwyux/hrnet-modal.git"
42
+ },
43
+ "homepage": "https://github.com/nwyux/hrnet-modal#readme",
44
+ "bugs": {
45
+ "url": "https://github.com/nwyux/hrnet-modal/issues"
46
+ },
47
+ "engines": {
48
+ "node": ">=20.19.0"
49
+ },
34
50
  "peerDependencies": {
35
51
  "react": ">=18.0.0",
36
52
  "react-dom": ">=18.0.0"