@glazeen/react-watermark 0.0.4 → 0.0.5
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 +54 -0
- package/package.json +9 -1
package/README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# @glazeen/react-watermark
|
|
2
|
+
|
|
3
|
+
A lightweight, customizable React watermark component built exclusively for the Glazeen software house.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @glazeen/react-watermark
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { GlazeenWatermark } from '@glazeen/react-watermark';
|
|
15
|
+
|
|
16
|
+
function App() {
|
|
17
|
+
return (
|
|
18
|
+
<div style={{ position: 'relative', width: '100%', height: '100vh' }}>
|
|
19
|
+
<h1>My Application</h1>
|
|
20
|
+
<p>Content goes here.</p>
|
|
21
|
+
|
|
22
|
+
{/* Render the watermark */}
|
|
23
|
+
<GlazeenWatermark />
|
|
24
|
+
</div>
|
|
25
|
+
);
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- **Modern & Lightweight:** Built using React, TypeScript, and Tailwind CSS v4.
|
|
32
|
+
- **Namespaced Styles:** All component styles are prefixed to prevent collisions with the host application.
|
|
33
|
+
- **Dual Support:** Ships with both CommonJS and ESM support, properly typed via `.d.ts` files.
|
|
34
|
+
|
|
35
|
+
## Development
|
|
36
|
+
|
|
37
|
+
This component library uses Vite for bundling and Storybook for isolated component development.
|
|
38
|
+
|
|
39
|
+
To get started with development:
|
|
40
|
+
|
|
41
|
+
1. **Install dependencies:**
|
|
42
|
+
```bash
|
|
43
|
+
npm install
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
2. **Run Storybook (Recommended for UI work):**
|
|
47
|
+
```bash
|
|
48
|
+
npm run storybook
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
3. **Build the library:**
|
|
52
|
+
```bash
|
|
53
|
+
npm run build
|
|
54
|
+
```
|
package/package.json
CHANGED
|
@@ -1,7 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@glazeen/react-watermark",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.5",
|
|
4
4
|
"author": "Glazeen",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "git+https://github.com/Glazeen/glazeen-react-watermark.git"
|
|
8
|
+
},
|
|
9
|
+
"bugs": {
|
|
10
|
+
"url": "https://github.com/Glazeen/glazeen-react-watermark/issues"
|
|
11
|
+
},
|
|
12
|
+
"homepage": "https://github.com/Glazeen/glazeen-react-watermark#readme",
|
|
5
13
|
"type": "module",
|
|
6
14
|
"main": "./dist/glazeen-watermark.cjs",
|
|
7
15
|
"module": "./dist/glazeen-watermark.mjs",
|