@new-ui/colors 2.2.5 → 3.0.0
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 +14 -7
- package/dist/index.css +1105 -1
- package/dist/index.css.map +1 -1
- package/dist/index.min.css +2 -0
- package/dist/index.min.css.map +1 -0
- package/package.json +26 -8
package/README.md
CHANGED
|
@@ -2,31 +2,38 @@
|
|
|
2
2
|
|
|
3
3
|
## Install
|
|
4
4
|
|
|
5
|
-
Install New UI Colors from your terminal
|
|
5
|
+
Install New UI Colors from your terminal with npm:
|
|
6
6
|
|
|
7
7
|
```
|
|
8
8
|
npm i -D @new-ui/colors
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
You can also load the minified build from a CDN in your HTML `<head>`:
|
|
12
12
|
|
|
13
13
|
```html
|
|
14
|
-
<!-- Place this at the html head -->
|
|
15
14
|
<link
|
|
16
15
|
rel="stylesheet"
|
|
17
|
-
href="https://cdn.jsdelivr.net/npm/@new-ui/colors@latest/dist/index.css"
|
|
16
|
+
href="https://cdn.jsdelivr.net/npm/@new-ui/colors@latest/dist/index.min.css"
|
|
18
17
|
/>
|
|
19
18
|
```
|
|
20
19
|
|
|
21
20
|
## Usage
|
|
22
21
|
|
|
22
|
+
Import the compiled CSS in a React app or bundler:
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
import '@new-ui/colors/css';
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
For SCSS projects, load the package with `@use`:
|
|
29
|
+
|
|
23
30
|
```scss
|
|
24
|
-
|
|
25
|
-
@use '@new-ui/colors'; // Use `@import` for CSS
|
|
31
|
+
@use '@new-ui/colors/scss';
|
|
26
32
|
```
|
|
27
33
|
|
|
34
|
+
Add the `data-new-ui-theme` attribute to your `html` wrapper element:
|
|
35
|
+
|
|
28
36
|
```html
|
|
29
|
-
<!-- Add this attribute to html wrapper -->
|
|
30
37
|
<html data-new-ui-theme="light"></html>
|
|
31
38
|
```
|
|
32
39
|
|