@razzusharma/accent-theme 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 +46 -9
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
<<<<<<< HEAD
|
|
2
|
+
# @razzu/accent-theme
|
|
3
|
+
=======
|
|
4
|
+
# @razzusharma/accent-theme
|
|
5
|
+
>>>>>>> a4f8ab5 (updating readme)
|
|
2
6
|
|
|
3
7
|
A React hook and provider for dynamic accent color theming. Perfect for adding customizable color themes to your React applications.
|
|
4
8
|
|
|
@@ -15,11 +19,20 @@ A React hook and provider for dynamic accent color theming. Perfect for adding c
|
|
|
15
19
|
## Installation
|
|
16
20
|
|
|
17
21
|
```bash
|
|
18
|
-
|
|
22
|
+
<<<<<<< HEAD
|
|
23
|
+
npm install @razzu/accent-theme
|
|
19
24
|
# or
|
|
20
|
-
yarn add @
|
|
25
|
+
yarn add @razzu/accent-theme
|
|
21
26
|
# or
|
|
22
|
-
pnpm add @
|
|
27
|
+
pnpm add @razzu/accent-theme
|
|
28
|
+
=======
|
|
29
|
+
npm install @razzusharma/accent-theme
|
|
30
|
+
# or
|
|
31
|
+
yarn add @razzusharma/accent-theme
|
|
32
|
+
# or
|
|
33
|
+
pnpm add @razzusharma/accent-theme
|
|
34
|
+
|
|
35
|
+
>>>>>>> a4f8ab5 (updating readme)
|
|
23
36
|
```
|
|
24
37
|
|
|
25
38
|
## Quick Start
|
|
@@ -27,8 +40,12 @@ pnpm add @tourgasm/accent-theme
|
|
|
27
40
|
### 1. Wrap your app with the provider
|
|
28
41
|
|
|
29
42
|
```tsx
|
|
30
|
-
|
|
43
|
+
<<<<<<< HEAD
|
|
44
|
+
import { AccentThemeProvider } from '@razzu/accent-theme';
|
|
31
45
|
|
|
46
|
+
=======
|
|
47
|
+
import { AccentThemeProvider } from '@razzusharma/accent-theme';
|
|
48
|
+
>>>>>>> a4f8ab5 (updating readme)
|
|
32
49
|
function App() {
|
|
33
50
|
return (
|
|
34
51
|
<AccentThemeProvider>
|
|
@@ -36,12 +53,17 @@ function App() {
|
|
|
36
53
|
</AccentThemeProvider>
|
|
37
54
|
);
|
|
38
55
|
}
|
|
56
|
+
|
|
39
57
|
```
|
|
40
58
|
|
|
41
59
|
### 2. Use the hook in your components
|
|
42
60
|
|
|
43
61
|
```tsx
|
|
44
|
-
|
|
62
|
+
<<<<<<< HEAD
|
|
63
|
+
import { useAccentTheme, useAccentColor } from '@razzu/accent-theme';
|
|
64
|
+
=======
|
|
65
|
+
import { useAccentTheme, useAccentColor } from '@razzusharma/accent-theme';
|
|
66
|
+
>>>>>>> a4f8ab5 (updating readme)
|
|
45
67
|
|
|
46
68
|
function MyComponent() {
|
|
47
69
|
const { accentColor, setAccentColor } = useAccentTheme();
|
|
@@ -56,12 +78,17 @@ function MyComponent() {
|
|
|
56
78
|
</div>
|
|
57
79
|
);
|
|
58
80
|
}
|
|
81
|
+
|
|
59
82
|
```
|
|
60
83
|
|
|
61
84
|
### 3. Use the built-in color picker
|
|
62
85
|
|
|
63
86
|
```tsx
|
|
64
|
-
|
|
87
|
+
<<<<<<< HEAD
|
|
88
|
+
import { AccentColorPicker } from '@razzu/accent-theme';
|
|
89
|
+
=======
|
|
90
|
+
import { AccentColorPicker } from '@razzusharma/accent-theme';
|
|
91
|
+
>>>>>>> a4f8ab5 (updating readme)
|
|
65
92
|
|
|
66
93
|
function Settings() {
|
|
67
94
|
return (
|
|
@@ -71,6 +98,7 @@ function Settings() {
|
|
|
71
98
|
</div>
|
|
72
99
|
);
|
|
73
100
|
}
|
|
101
|
+
|
|
74
102
|
```
|
|
75
103
|
|
|
76
104
|
## Configuration
|
|
@@ -87,7 +115,11 @@ function Settings() {
|
|
|
87
115
|
### Custom Colors
|
|
88
116
|
|
|
89
117
|
```tsx
|
|
90
|
-
|
|
118
|
+
<<<<<<< HEAD
|
|
119
|
+
import { AccentThemeProvider } from '@razzu/accent-theme';
|
|
120
|
+
=======
|
|
121
|
+
import { AccentThemeProvider } from '@razzusharma/accent-theme';
|
|
122
|
+
>>>>>>> a4f8ab5 (updating readme)
|
|
91
123
|
|
|
92
124
|
const customColors = {
|
|
93
125
|
coral: {
|
|
@@ -110,6 +142,7 @@ function App() {
|
|
|
110
142
|
</AccentThemeProvider>
|
|
111
143
|
);
|
|
112
144
|
}
|
|
145
|
+
|
|
113
146
|
```
|
|
114
147
|
|
|
115
148
|
## CSS Variables
|
|
@@ -198,4 +231,8 @@ module.exports = {
|
|
|
198
231
|
|
|
199
232
|
## License
|
|
200
233
|
|
|
201
|
-
|
|
234
|
+
<<<<<<< HEAD
|
|
235
|
+
MIT © razzu
|
|
236
|
+
=======
|
|
237
|
+
MIT © razzusharma
|
|
238
|
+
>>>>>>> a4f8ab5 (updating readme)
|
package/package.json
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@razzusharma/accent-theme",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Dynamic accent color theming for React apps",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
7
7
|
"types": "dist/index.d.ts",
|
|
8
|
-
"files": [
|
|
8
|
+
"files": [
|
|
9
|
+
"dist"
|
|
10
|
+
],
|
|
9
11
|
"scripts": {
|
|
10
12
|
"build": "tsup",
|
|
11
13
|
"dev": "tsup --watch",
|