r3ui-lib 1.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 REGAGRO LTD
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,149 @@
1
+ # πŸ“š r3lib UI Library
2
+
3
+ > БоврСмСнная Π±ΠΈΠ±Π»ΠΈΠΎΡ‚Π΅ΠΊΠ° Vue 3 ΠΊΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ‚ΠΎΠ² с TypeScript ΠΏΠΎΠ΄Π΄Π΅Ρ€ΠΆΠΊΠΎΠΉ
4
+
5
+ [![Version](https://img.shields.io/npm/v/r3lib.svg)](https://www.npmjs.com/package/r3lib)
6
+ [![License](https://img.shields.io/npm/l/r3lib.svg)](https://github.com/REGAGRO-LTD-CY/r3lib/blob/main/LICENSE)
7
+ [![Vue](https://img.shields.io/badge/Vue-3.x-4FC08D.svg)](https://vuejs.org/)
8
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6.svg)](https://www.typescriptlang.org/)
9
+
10
+ ## πŸš€ Быстрый старт
11
+
12
+ ```bash
13
+ # Установка
14
+ npm install r3ui-lib
15
+
16
+ # ИспользованиС
17
+ import { DefaultButton, Table, useTableDefault } from 'r3ui-lib'
18
+ ```
19
+
20
+ ## πŸ“– ДокумСнтация
21
+
22
+ Полная докумСнтация доступна Π² ΠΏΠ°ΠΏΠΊΠ΅ [`docs/`](./docs/):
23
+
24
+ - **[πŸ“š Главная докумСнтация](./docs/README.md)** - ΠžΠ±Π·ΠΎΡ€ ΠΈ навигация
25
+ - **[🧩 ΠšΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ‚Ρ‹](./docs/components/)** - ВсС UI ΠΊΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ‚Ρ‹
26
+ - **[πŸ”§ Composables](./docs/composables/)** - Vue composables
27
+ - **[🎨 Бтилизация](./docs/styling/)** - Π’Π΅ΠΌΡ‹ ΠΈ стили
28
+ - **[πŸ“ ΠŸΡ€ΠΈΠΌΠ΅Ρ€Ρ‹](./examples/)** - Π“ΠΎΡ‚ΠΎΠ²Ρ‹Π΅ ΠΏΡ€ΠΈΠΌΠ΅Ρ€Ρ‹ использования
29
+
30
+ ## 🧩 ΠšΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ‚Ρ‹
31
+
32
+ ### πŸ”˜ Кнопки ΠΈ дСйствия
33
+ - `DefaultButton` - Базовая ΠΊΠ½ΠΎΠΏΠΊΠ° с 7 стилями
34
+ - `AddButton` - Кнопка добавлСния
35
+ - `ExportButton` - Кнопка экспорта
36
+ - `PrintButton` - Кнопка ΠΏΠ΅Ρ‡Π°Ρ‚ΠΈ
37
+
38
+ ### πŸ“ Π€ΠΎΡ€ΠΌΡ‹
39
+ - `CustomInput` - ПолС Π²Π²ΠΎΠ΄Π° с Π²Π°Π»ΠΈΠ΄Π°Ρ†ΠΈΠ΅ΠΉ
40
+ - `PasswordInput` - ПолС пароля
41
+ - `Checkbox` - ЧСкбокс
42
+ - `FormError` - ΠžΡ‚ΠΎΠ±Ρ€Π°ΠΆΠ΅Π½ΠΈΠ΅ ошибок
43
+
44
+ ### πŸ“Š Π’Π°Π±Π»ΠΈΡ†Ρ‹
45
+ - `Table` - Π£Π½ΠΈΠ²Π΅Ρ€ΡΠ°Π»ΡŒΠ½Π°Ρ Ρ‚Π°Π±Π»ΠΈΡ†Π° с AJAX
46
+ - `TableCount` - Π‘Ρ‡Π΅Ρ‚Ρ‡ΠΈΠΊ записСй
47
+
48
+ ### πŸͺŸ ΠœΠΎΠ΄Π°Π»ΡŒΠ½Ρ‹Π΅ ΠΎΠΊΠ½Π°
49
+ - `DefaultModal` - Π‘Π°Π·ΠΎΠ²ΠΎΠ΅ модальноС ΠΎΠΊΠ½ΠΎ
50
+ - `ConfirmationModal` - МодальноС ΠΎΠΊΠ½ΠΎ подтвСрТдСния
51
+
52
+ ### πŸ”” УвСдомлСния
53
+ - `Toast` - Π’ΡΠΏΠ»Ρ‹Π²Π°ΡŽΡ‰ΠΈΠ΅ увСдомлСния
54
+ - `ErrorMessageComponent` - ΠšΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ‚ ошибок
55
+
56
+ ### 🎨 ΠœΠ°ΠΊΠ΅Ρ‚
57
+ - `PageTitle` - Π—Π°Π³ΠΎΠ»ΠΎΠ²ΠΎΠΊ страницы
58
+ - `Card` - ΠšΠ°Ρ€Ρ‚ΠΎΡ‡ΠΊΠ°
59
+ - `Divider` - Π Π°Π·Π΄Π΅Π»ΠΈΡ‚Π΅Π»ΡŒ
60
+
61
+ ## πŸ”§ Composables
62
+
63
+ - `useTableDefault` - Π£ΠΏΡ€Π°Π²Π»Π΅Π½ΠΈΠ΅ состояниСм Ρ‚Π°Π±Π»ΠΈΡ†Ρ‹
64
+ - `useTableStorage` - Π Π°Π±ΠΎΡ‚Π° с localStorage
65
+
66
+ ## πŸ“ ΠŸΡ€ΠΈΠΌΠ΅Ρ€Ρ‹
67
+
68
+ Π‘ΠΌ. ΠΏΠ°ΠΏΠΊΡƒ [`examples/`](./examples/) для ΠΏΠΎΠ»Π½Ρ‹Ρ… ΠΏΡ€ΠΈΠΌΠ΅Ρ€ΠΎΠ²:
69
+
70
+ - **[TableWithComposable.vue](./examples/TableWithComposable.vue)** - ΠŸΡ€ΠΈΠΌΠ΅Ρ€ использования Table с useTableDefault
71
+
72
+ ## πŸ› οΈ Π Π°Π·Ρ€Π°Π±ΠΎΡ‚ΠΊΠ°
73
+
74
+ ```bash
75
+ # ΠšΠ»ΠΎΠ½ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅ рСпозитория
76
+ git clone git@github.com:REGAGRO-LTD-CY/r3lib.git
77
+ cd r3lib
78
+
79
+ # Установка зависимостСй
80
+ npm install
81
+
82
+ # Запуск Storybook
83
+ npm run storybook
84
+
85
+ # Π‘Π±ΠΎΡ€ΠΊΠ° Π±ΠΈΠ±Π»ΠΈΠΎΡ‚Π΅ΠΊΠΈ
86
+ npm run build
87
+
88
+ # ВСстированиС
89
+ npm run test
90
+ ```
91
+
92
+ ## πŸ“¦ Установка
93
+
94
+ ```bash
95
+ npm install r3lib
96
+ ```
97
+
98
+ ## 🎯 ИспользованиС
99
+
100
+ ```vue
101
+ <template>
102
+ <div>
103
+ <PageTitle title="Моя страница" />
104
+
105
+ <Card>
106
+ <Table
107
+ :columns="columns"
108
+ :data="data"
109
+ :loading="isLoading"
110
+ @sort="handleSort"
111
+ />
112
+ </Card>
113
+
114
+ <DefaultButton
115
+ label="Π‘ΠΎΡ…Ρ€Π°Π½ΠΈΡ‚ΡŒ"
116
+ styles="primary"
117
+ @click="handleSave"
118
+ />
119
+ </div>
120
+ </template>
121
+
122
+ <script setup>
123
+ import {
124
+ PageTitle,
125
+ Card,
126
+ Table,
127
+ DefaultButton,
128
+ useTableDefault
129
+ } from 'r3ui-lib'
130
+
131
+ // Π’Π°ΡˆΠ° Π»ΠΎΠ³ΠΈΠΊΠ°
132
+ </script>
133
+ ```
134
+
135
+ ## πŸ”— ΠŸΠΎΠ»Π΅Π·Π½Ρ‹Π΅ ссылки
136
+
137
+ - [GitHub Repository](git@github.com:REGAGRO-LTD-CY/r3lib.git)
138
+ - [Storybook](http://localhost:6006) - Π˜Π½Ρ‚Π΅Ρ€Π°ΠΊΡ‚ΠΈΠ²Π½Ρ‹Π΅ ΠΏΡ€ΠΈΠΌΠ΅Ρ€Ρ‹
139
+ - [NPM Package](https://www.npmjs.com/package/r3lib)
140
+
141
+ ## πŸ“„ ЛицСнзия
142
+
143
+ MIT License
144
+
145
+ ---
146
+
147
+ **ВСрсия:** 1.0.0
148
+ **Бтатус:** βœ… Π“ΠΎΡ‚ΠΎΠ² ΠΊ использованию
149
+ **ПослСднСС ΠΎΠ±Π½ΠΎΠ²Π»Π΅Π½ΠΈΠ΅:** Π‘Π΅Π½Ρ‚ΡΠ±Ρ€ΡŒ 2024
Binary file
Binary file
Binary file
Binary file