indicator-ui 0.0.8 → 0.0.9
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 +11 -57
- package/dist/index.js.map +1 -1
- package/dist/types/ui/InputFields/FlexField/types/FlexFieldTypes.d.ts +15 -0
- package/docs/CSSVariables/CSSVariables.md +63 -0
- package/docs/CSSVariables/CSSVariablesCalifornia.md +62 -0
- package/docs/ForDev.md +106 -0
- package/docs/FormBuilderDocs.md +205 -0
- package/docs/SCSSVariables.md +28 -0
- package/docs/imgs/img.png +0 -0
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -1,67 +1,21 @@
|
|
|
1
|
-
# **
|
|
1
|
+
# **Indicator UI**
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**Indicator UI** — это библиотека компонентов и миксинов на основе **TypeScript** и **SCSS**.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### ⚠️ **Дисклеймер**
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Много текста, написанного автором, было закинуто в нейронку (какую — не скажу, а то еще булить будете 😜), поэтому все свисто-перделки, цветочки и вежливость — это от неё 🌸. Также этот гопник мог что-то неправильно исправить, так что если вдруг что-то не так, не вините автора — это нейрока виновата 🤖, кроме тех случаев, когда сам автор это говорит (или нейрока за него 🤔, восстание машин? Думайте!!!).
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
Добавляем сюда все модули, которые должны быть доступны через:
|
|
14
|
-
```ts
|
|
15
|
-
import {} from 'indicator-ui';
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
#### 🎨 `src/index.scss` (scss модули)
|
|
19
|
-
|
|
20
|
-
Добавляем сюда все стили, которые должны быть доступны через:
|
|
21
|
-
```scss
|
|
22
|
-
@use 'indicator-ui' as *;
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
---
|
|
26
|
-
|
|
27
|
-
### ⚙️ Сборка проекта
|
|
28
|
-
|
|
29
|
-
Чтобы собрать проект, используйте:
|
|
30
|
-
|
|
31
|
-
```sh
|
|
32
|
-
npm run build
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Результаты сборки появятся в папке `dist`. Там, возможно, живёт магия. 🧙♂️✨
|
|
11
|
+
PS: Даже этот дисклеймер закину в нейронку 🧠.
|
|
36
12
|
|
|
37
13
|
---
|
|
38
14
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
Перед публикацией можно протестировать библиотеку на локальном **React**-проекте `test-project`. Для этого используется **yalc** — аналог npm, но для локальных пакетов. 🛞
|
|
42
|
-
|
|
43
|
-
### 🚀 Установка `yalc`
|
|
44
|
-
|
|
45
|
-
```sh
|
|
46
|
-
npm install -g yalc
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
### 📦 Публикация в локальное хранилище
|
|
50
|
-
|
|
51
|
-
```sh
|
|
52
|
-
yalc publish
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### 📥 Установка библиотеки в проект
|
|
56
|
-
|
|
57
|
-
```sh
|
|
58
|
-
yalc add indicator-ui
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
### 🔄 Обновление библиотеки
|
|
62
|
-
|
|
63
|
-
```sh
|
|
64
|
-
yalc update
|
|
65
|
-
```
|
|
15
|
+
### 📑 **Содержание**
|
|
66
16
|
|
|
67
|
-
|
|
17
|
+
* [Для разработки](./docs/ForDev.md)
|
|
18
|
+
* [Про CSS переменные](./docs/CSSVariables/CSSVariables.md)
|
|
19
|
+
* [Про CSS переменные, но в Калифорнийском стиле](./docs/CSSVariables/CSSVariablesCalifornia.mdS)
|
|
20
|
+
* [Про SCSS переменные](./docs/SCSSVariables.md)
|
|
21
|
+
* [Что-то про FormBuilder](./docs/FormBuilderDocs.md)
|