stone-kit 0.0.14 → 0.0.16

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.
Files changed (2) hide show
  1. package/README.md +50 -21
  2. package/package.json +4 -3
package/README.md CHANGED
@@ -1,30 +1,59 @@
1
- # React + TypeScript + Vite
1
+ # Stone-kit
2
2
 
3
- This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3
+ Uikit for stone redesign 2.0
4
4
 
5
- Currently, two official plugins are available:
5
+ ## Installation
6
6
 
7
- - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8
- - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7
+ Package installation:
9
8
 
10
- ## Expanding the ESLint configuration
9
+ ```bash
10
+ npm i stone-kit@latest
11
+ ```
11
12
 
12
- If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
13
+ ## Usage
13
14
 
14
- - Configure the top-level `parserOptions` property like this:
15
+ For Next.js page router in App.tsx:
15
16
 
16
- ```js
17
- export default {
18
- // other rules...
19
- parserOptions: {
20
- ecmaVersion: 'latest',
21
- sourceType: 'module',
22
- project: ['./tsconfig.json', './tsconfig.node.json'],
23
- tsconfigRootDir: __dirname,
24
- },
25
- }
17
+ ```bash
18
+ import 'stone-kit/dist/style.css'
26
19
  ```
27
20
 
28
- - Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
29
- - Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
30
- - Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
21
+ and then:
22
+
23
+ ```bash
24
+ import {Button} from 'stone-kit'
25
+ ```
26
+
27
+ For other projects u can immediately:
28
+
29
+ ```bash
30
+ import {Button} from 'stone-kit'
31
+ ```
32
+
33
+ ## Docs
34
+
35
+ ### ButtonProps
36
+
37
+ size: optional, size of button. types : 'large' | 'medium' | 'small' | 'tiny'
38
+
39
+ pre: optional, insert icon/text before button text. type: ReactNode
40
+
41
+ post: optional, insert icon/text after button text. type: ReactNode
42
+
43
+ variant: optional, color variants of button. type:
44
+ 'blue',
45
+ 'gray',
46
+ 'whiteStroke',
47
+ 'sokolniki',
48
+ 'black',
49
+ 'whiteFilled'
50
+
51
+ width: optional, width of button. type: 'auto' | 'full'
52
+
53
+ additionalClass: optional, add your custom class to button. type: 'string'
54
+
55
+ as: optional, u can convert button to link. type: 'button' | 'link'. 'button' by default.
56
+
57
+ ### MobileButtonProps
58
+
59
+ ### Tag
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "stone-kit",
3
+ "description": "uikit for redesign",
3
4
  "private": false,
4
- "version": "0.0.14",
5
+ "version": "0.0.16",
5
6
  "author": "Mollycodd1e",
6
7
  "license": "ISC",
7
8
  "type": "module",
@@ -34,7 +35,8 @@
34
35
  "typescript": "^5.2.2",
35
36
  "vite": "^5.2.0",
36
37
  "vite-plugin-dts": "^3.9.1",
37
- "vite-plugin-lib-inject-css": "^2.1.1"
38
+ "vite-plugin-lib-inject-css": "^2.1.1",
39
+ "vite-plugin-svgr": "^4.2.0"
38
40
  },
39
41
  "main": "dist/main.js",
40
42
  "types": "dist/main.d.ts",
@@ -44,7 +46,6 @@
44
46
  "sideEffects": [
45
47
  "**/*.css"
46
48
  ],
47
- "description": "This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.",
48
49
  "directories": {
49
50
  "lib": "lib"
50
51
  },