@san-siva/stylekit 1.0.1 → 1.0.2
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 +28 -16
- package/package.json +19 -11
- /package/{animations.module.scss → styles/animations.module.scss} +0 -0
- /package/{colors.module.scss → styles/colors.module.scss} +0 -0
- /package/{dimensions.module.scss → styles/dimensions.module.scss} +0 -0
- /package/{globals.scss → styles/globals.scss} +0 -0
- /package/{index.module.scss → styles/index.module.scss} +0 -0
- /package/{typography.module.scss → styles/typography.module.scss} +0 -0
- /package/{utils.module.scss → styles/utils.module.scss} +0 -0
package/README.md
CHANGED
|
@@ -5,7 +5,11 @@ A comprehensive SCSS module library providing colors, typography, animations, ut
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @
|
|
8
|
+
npm install @san-siva/stylekit
|
|
9
|
+
# or
|
|
10
|
+
yarn add @san-siva/stylekit
|
|
11
|
+
# or
|
|
12
|
+
pnpm add @san-siva/stylekit
|
|
9
13
|
```
|
|
10
14
|
|
|
11
15
|
## Usage
|
|
@@ -13,7 +17,7 @@ npm install @portfolio/stylekit
|
|
|
13
17
|
### Import All Styles
|
|
14
18
|
|
|
15
19
|
```scss
|
|
16
|
-
@use '@
|
|
20
|
+
@use '@san-siva/stylekit' as styles;
|
|
17
21
|
|
|
18
22
|
.my-element {
|
|
19
23
|
color: styles.$color--primary;
|
|
@@ -24,9 +28,9 @@ npm install @portfolio/stylekit
|
|
|
24
28
|
### Import Individual Modules
|
|
25
29
|
|
|
26
30
|
```scss
|
|
27
|
-
@use '@
|
|
28
|
-
@use '@
|
|
29
|
-
@use '@
|
|
31
|
+
@use '@san-siva/stylekit/colors' as colors;
|
|
32
|
+
@use '@san-siva/stylekit/typography' as typography;
|
|
33
|
+
@use '@san-siva/stylekit/utils' as utils;
|
|
30
34
|
|
|
31
35
|
.my-element {
|
|
32
36
|
color: colors.$color--primary;
|
|
@@ -116,7 +120,7 @@ Helper functions and spacing utilities.
|
|
|
116
120
|
|
|
117
121
|
Example:
|
|
118
122
|
```scss
|
|
119
|
-
@use '@
|
|
123
|
+
@use '@san-siva/stylekit/utils' as utils;
|
|
120
124
|
|
|
121
125
|
.element {
|
|
122
126
|
padding: utils.space(3); // 24px = 1.5rem
|
|
@@ -164,7 +168,7 @@ Keyframe animations for common UI patterns.
|
|
|
164
168
|
|
|
165
169
|
Example:
|
|
166
170
|
```scss
|
|
167
|
-
@use '@
|
|
171
|
+
@use '@san-siva/stylekit/animations';
|
|
168
172
|
|
|
169
173
|
.my-element {
|
|
170
174
|
animation: fadeInDown 0.3s ease-out;
|
|
@@ -176,21 +180,29 @@ Example:
|
|
|
176
180
|
Global styles and resets to be imported once in your application.
|
|
177
181
|
|
|
178
182
|
```scss
|
|
179
|
-
@use '@
|
|
183
|
+
@use '@san-siva/stylekit/globals';
|
|
180
184
|
```
|
|
181
185
|
|
|
182
186
|
## Package Exports
|
|
183
187
|
|
|
184
188
|
The package provides the following export paths:
|
|
185
189
|
|
|
186
|
-
- `@
|
|
187
|
-
- `@
|
|
188
|
-
- `@
|
|
189
|
-
- `@
|
|
190
|
-
- `@
|
|
191
|
-
- `@
|
|
192
|
-
- `@
|
|
190
|
+
- `@san-siva/stylekit` - All styles (index)
|
|
191
|
+
- `@san-siva/stylekit/colors` - Colors only
|
|
192
|
+
- `@san-siva/stylekit/typography` - Typography only
|
|
193
|
+
- `@san-siva/stylekit/utils` - Utilities only
|
|
194
|
+
- `@san-siva/stylekit/dimensions` - Dimensions only
|
|
195
|
+
- `@san-siva/stylekit/animations` - Animations only
|
|
196
|
+
- `@san-siva/stylekit/globals` - Global styles
|
|
197
|
+
|
|
198
|
+
## Works Great With
|
|
199
|
+
|
|
200
|
+
Stylekit works seamlessly with [@san-siva/blogkit](https://www.npmjs.com/package/@san-siva/blogkit) for building beautiful blog interfaces!
|
|
201
|
+
|
|
202
|
+
## Contributing
|
|
203
|
+
|
|
204
|
+
Contributions are welcome! Open an issue or submit a pull request on [GitHub](https://github.com/san-siva/stylekit).
|
|
193
205
|
|
|
194
206
|
## License
|
|
195
207
|
|
|
196
|
-
MIT
|
|
208
|
+
MIT © [Santhosh Siva](https://santhoshsiva.dev)
|
package/package.json
CHANGED
|
@@ -1,20 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@san-siva/stylekit",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "A modular SCSS design system with utilities, colors, typography, and animations",
|
|
5
|
-
"main": "index.module.scss",
|
|
5
|
+
"main": "styles/index.module.scss",
|
|
6
6
|
"exports": {
|
|
7
|
-
".": "./index.module.scss",
|
|
8
|
-
"./index.module.scss": "./index.module.scss",
|
|
9
|
-
"./animations.module.scss": "./animations.module.scss",
|
|
10
|
-
"./colors.module.scss": "./colors.module.scss",
|
|
11
|
-
"./dimensions.module.scss": "./dimensions.module.scss",
|
|
12
|
-
"./typography.module.scss": "./typography.module.scss",
|
|
13
|
-
"./utils.module.scss": "./utils.module.scss",
|
|
14
|
-
"./globals.scss": "./globals.scss"
|
|
7
|
+
".": "./styles/index.module.scss",
|
|
8
|
+
"./index.module.scss": "./styles/index.module.scss",
|
|
9
|
+
"./animations.module.scss": "./styles/animations.module.scss",
|
|
10
|
+
"./colors.module.scss": "./styles/colors.module.scss",
|
|
11
|
+
"./dimensions.module.scss": "./styles/dimensions.module.scss",
|
|
12
|
+
"./typography.module.scss": "./styles/typography.module.scss",
|
|
13
|
+
"./utils.module.scss": "./styles/utils.module.scss",
|
|
14
|
+
"./globals.scss": "./styles/globals.scss",
|
|
15
|
+
"./styles/*.scss": "./styles/*.scss",
|
|
16
|
+
"./styles/index.module.scss": "./styles/index.module.scss",
|
|
17
|
+
"./styles/animations.module.scss": "./styles/animations.module.scss",
|
|
18
|
+
"./styles/colors.module.scss": "./styles/colors.module.scss",
|
|
19
|
+
"./styles/dimensions.module.scss": "./styles/dimensions.module.scss",
|
|
20
|
+
"./styles/typography.module.scss": "./styles/typography.module.scss",
|
|
21
|
+
"./styles/utils.module.scss": "./styles/utils.module.scss",
|
|
22
|
+
"./styles/globals.scss": "./styles/globals.scss"
|
|
15
23
|
},
|
|
16
24
|
"files": [
|
|
17
|
-
"
|
|
25
|
+
"styles/**/*.scss"
|
|
18
26
|
],
|
|
19
27
|
"keywords": [
|
|
20
28
|
"styles",
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|