sep-yui 0.1.123 → 0.1.125

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 CHANGED
@@ -1,79 +1,79 @@
1
- # SEP-YUI
2
-
3
- **SEP-YUI** — библиотека UI-компонентов для Vue, созданная для решения задачи удобного переиспользования интерфейсных элементов между проектами.
4
- Она позволяет использовать единый набор UI-решений, снижает связанность компонентов и упрощает поддержку.
5
-
6
- ## Основные преимущества
7
-
8
- - Лёгкая интеграция в существующие проекты
9
- - Низкий порог входа
10
- - Гибкость и кастомизация
11
- - Регулярные обновления и техническая поддержка
12
- - Возможность комбинирования компонентов внутри проекта
13
-
14
- ---
15
-
16
- ## Установка и подключение
17
-
18
- ```bash
19
- npm i sep-yui
20
- ```
21
-
22
- #### 1. Для использования библиотеки в проекте, необходимо импортировать компоненты библиотеки в главный файл проекта main.ts таким образом:
23
-
24
- ```ts
25
- main.ts;
26
- import Ylibrary from 'sep-yui';
27
- app.use(Ylibrary);
28
- app.mount('#app');
29
- ```
30
-
31
- #### 1.1 Для выборочного импорта компонентов, можно использовать подключение такого вида.
32
-
33
- ```ts
34
- main.ts;
35
- import { Toggle } from 'sep-yui';
36
- app.component('Toggle', Toggle);
37
- ```
38
-
39
- #### 2. Стили импортируются через путь "sep-yui/styles" также в файле main.ts
40
-
41
- ```ts
42
- main.ts;
43
- import 'sep-yui/styles';
44
- ```
45
-
46
- #### 3. Далее просто пишем название компонента внутри проекта и используем как при обычной разработке на Vue.
47
-
48
- ```vue
49
- App.vue
50
- <template>
51
- <Toggle :disabled="true" :backgroundColor="'red'" />
52
- </template>
53
- <script setup lang="ts"></script>
54
- <styles scoped></styles>
55
- ```
56
-
57
-
58
- ---
59
-
60
- ## Примеры и Storybook
61
-
62
- Документация и примеры компонентов:
63
-
64
- ➡️ https://pksep.github.io/sep_yui
65
-
66
- ---
67
-
68
- ## Разработка
69
-
70
- ### Публикация пакетов
71
-
72
- Обязательно через команду, так как генерятся changelog. Для этого используем:
73
- [changeloggen](https://unjs.io/packages/changelogen/)
74
-
75
- ```sh
76
- pnpm run build:lib
77
- ```
78
-
79
- Токен можно для публикации можно получить у менеджера.
1
+ # SEP-YUI
2
+
3
+ **SEP-YUI** — библиотека UI-компонентов для Vue, созданная для решения задачи удобного переиспользования интерфейсных элементов между проектами.
4
+ Она позволяет использовать единый набор UI-решений, снижает связанность компонентов и упрощает поддержку.
5
+
6
+ ## Основные преимущества
7
+
8
+ - Лёгкая интеграция в существующие проекты
9
+ - Низкий порог входа
10
+ - Гибкость и кастомизация
11
+ - Регулярные обновления и техническая поддержка
12
+ - Возможность комбинирования компонентов внутри проекта
13
+
14
+ ---
15
+
16
+ ## Установка и подключение
17
+
18
+ ```bash
19
+ npm i sep-yui
20
+ ```
21
+
22
+ #### 1. Для использования библиотеки в проекте, необходимо импортировать компоненты библиотеки в главный файл проекта main.ts таким образом:
23
+
24
+ ```ts
25
+ main.ts;
26
+ import Ylibrary from 'sep-yui';
27
+ app.use(Ylibrary);
28
+ app.mount('#app');
29
+ ```
30
+
31
+ #### 1.1 Для выборочного импорта компонентов, можно использовать подключение такого вида.
32
+
33
+ ```ts
34
+ main.ts;
35
+ import { Toggle } from 'sep-yui';
36
+ app.component('Toggle', Toggle);
37
+ ```
38
+
39
+ #### 2. Стили импортируются через путь "sep-yui/styles" также в файле main.ts
40
+
41
+ ```ts
42
+ main.ts;
43
+ import 'sep-yui/styles';
44
+ ```
45
+
46
+ #### 3. Далее просто пишем название компонента внутри проекта и используем как при обычной разработке на Vue.
47
+
48
+ ```vue
49
+ App.vue
50
+ <template>
51
+ <Toggle :disabled="true" :backgroundColor="'red'" />
52
+ </template>
53
+ <script setup lang="ts"></script>
54
+ <styles scoped></styles>
55
+ ```
56
+
57
+
58
+ ---
59
+
60
+ ## Примеры и Storybook
61
+
62
+ Документация и примеры компонентов:
63
+
64
+ ➡️ https://pksep.github.io/sep_yui
65
+
66
+ ---
67
+
68
+ ## Разработка
69
+
70
+ ### Публикация пакетов
71
+
72
+ Обязательно через команду, так как генерятся changelog. Для этого используем:
73
+ [changeloggen](https://unjs.io/packages/changelogen/)
74
+
75
+ ```sh
76
+ pnpm run build:lib
77
+ ```
78
+
79
+ Токен можно для публикации можно получить у менеджера.
@@ -105,5 +105,6 @@ export declare enum IconNameEnum {
105
105
  noDistrub = "no-distrub",
106
106
  logout = "logout",
107
107
  minus = "minus",
108
- keyboard = "keyboard"
108
+ keyboard = "keyboard",
109
+ planeRightFill = "plane-right-fill"
109
110
  }
@@ -114,3 +114,4 @@ export declare const addUser: IVectorIcon;
114
114
  export declare const noDistrub: IVectorIcon;
115
115
  export declare const logout: IVectorIcon;
116
116
  export declare const keyboard: IVectorIcon;
117
+ export declare const planeRightFill: IVectorIcon;