@virastack/password 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.
- package/README.md +25 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,34 +1,35 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<img src="./public/password.jpg" alt="Vira Stack Password" />
|
|
3
|
-
</div>
|
|
4
2
|
|
|
5
|
-
<
|
|
3
|
+
<a href="https://github.com/virastack/password" target="_blank" rel="noreferrer">
|
|
4
|
+
<picture>
|
|
5
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/virastack/password/main/assets/logo-dark.png">
|
|
6
|
+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/virastack/password/main/assets/logo-light.png">
|
|
7
|
+
<img src="https://raw.githubusercontent.com/virastack/password/main/assets/logo-light.png" alt="ViraStack Password" height="120" style="max-width: 100%;" />
|
|
8
|
+
</picture>
|
|
9
|
+
</a>
|
|
6
10
|
|
|
7
|
-
|
|
8
|
-
<a href="https://www.npmjs.com/package/@virastack/password">
|
|
9
|
-
<img src="https://img.shields.io/npm/v/@virastack/password" alt="npm version" />
|
|
10
|
-
</a>
|
|
11
|
-
<a href="https://www.npmjs.com/package/@virastack/password">
|
|
12
|
-
<img src="https://img.shields.io/npm/dt/@virastack/password" alt="npm downloads" />
|
|
13
|
-
</a>
|
|
14
|
-
<a href="https://bundlephobia.com/package/@virastack/password">
|
|
15
|
-
<img src="https://img.shields.io/bundlephobia/minzip/@virastack/password" alt="bundle size" />
|
|
16
|
-
</a>
|
|
17
|
-
</div>
|
|
11
|
+
*Fully accessible and customizable password visibility hook for React.*
|
|
18
12
|
|
|
19
|
-
|
|
13
|
+
[](https://virastack.com/password/)
|
|
14
|
+
[](https://www.npmjs.com/package/@virastack/password)
|
|
15
|
+
[](https://www.npmjs.com/package/@virastack/password)
|
|
16
|
+
[](https://bundlephobia.com/package/@virastack/password)
|
|
17
|
+
[](https://github.com/virastack/password/blob/main/LICENSE)
|
|
18
|
+
[](https://x.com/virastack)
|
|
19
|
+
|
|
20
|
+
</div>
|
|
20
21
|
|
|
21
|
-
|
|
22
|
+
---
|
|
22
23
|
|
|
23
|
-
|
|
24
|
+
### [Read the full documentation →](https://virastack.com/password/)
|
|
24
25
|
|
|
25
|
-
|
|
26
|
-
- 🧩 **Framework Agnostic:** Logic is separated from React state, making it adaptable and clean.
|
|
27
|
-
- 🎨 **Smart Defaults:** Includes minimal SVG icons by default, so you can start using it immediately.
|
|
28
|
-
- 🔄 **Prop Merging:** Safely merges user props with hook-generated props to prevent overrides.
|
|
29
|
-
- 🔒 **State Sync:** Automatically handles `disabled` and `readOnly` states for a consistent UX.
|
|
26
|
+
## Why ViraStack Password?
|
|
30
27
|
|
|
31
|
-
|
|
28
|
+
- **Accessibility First:** Fully ARIA compliant out of the box for better screen reader support.
|
|
29
|
+
- **Framework Agnostic:** Logic is separated from React state, making it adaptable and clean.
|
|
30
|
+
- **Smart Defaults:** Includes minimal SVG icons by default, so you can start using it immediately.
|
|
31
|
+
- **Prop Merging:** Safely merges user props with hook-generated props to prevent overrides.
|
|
32
|
+
- **State Sync:** Automatically handles `disabled` and `readOnly` states for a consistent UX.
|
|
32
33
|
|
|
33
34
|
## Quick Start
|
|
34
35
|
|
|
@@ -57,7 +58,7 @@ Discover all ViraStack tools, libraries, and boilerplates at [**virastack.com**]
|
|
|
57
58
|
|
|
58
59
|
## License
|
|
59
60
|
|
|
60
|
-
Licensed under the
|
|
61
|
+
Licensed under the [MIT License](https://github.com/virastack/password/blob/main/LICENSE).
|
|
61
62
|
|
|
62
63
|
## Maintainer
|
|
63
64
|
|