urfu-ui-kit-react 1.5.1 → 1.5.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.
Files changed (4) hide show
  1. package/README.md +269 -276
  2. package/package.json +5 -5
  3. package/LICENSE +0 -19
  4. package/dist/LICENSE +0 -19
package/README.md CHANGED
@@ -1,276 +1,269 @@
1
- # UrFU UI-Kit React
2
-
3
- Библиотека React-компонентов для создания пользовательских интерфейсов в экосистеме Уральского федерального университета.
4
-
5
- ## 📦 Установка
6
-
7
- ```bash
8
- npm install urfu-ui-kit-react
9
- ```
10
-
11
- ## 🚀 Быстрый старт
12
-
13
- ### Базовая настройка
14
-
15
- В библиотеку встроена библиотека стилей `urfu-ui-kit-vanilla`, поэтому нужно в корне проекта импортировать стили:
16
-
17
- ```javascript
18
- import "urfu-ui-kit-react/dist/style.css"
19
- ```
20
-
21
- Или подключиться по ссылке конкретной версии как указано здесь: [https://uikit.my1.urfu.ru/#/ui/main](https://uikit.my1.urfu.ru/#/ui/main)
22
-
23
- **Важно:** Библиотека по умолчанию имеет шрифт Montserrat и полосу прокрутки, адаптивную под разные разрешения экрана. Они объявлены глобально и применяются в проекте посредством импорта библиотеки. А также стили глобально применены для тегов `h1-h6`.
24
-
25
- ### Импорт компонентов
26
-
27
- Импорт компонентов осуществляется по имени:
28
-
29
- ```javascript
30
- import {
31
- Button,
32
- InputText,
33
- Select,
34
- Checkbox,
35
- Preloader,
36
- Message,
37
- Tooltip
38
- } from "urfu-ui-kit-react";
39
- ```
40
-
41
- ## 📚 Компоненты
42
-
43
- ### Формы и ввод данных
44
-
45
- - **InputText** — текстовое поле ввода
46
- - **InputNumber** — поле ввода чисел
47
- - **InputFile** — загрузка файлов
48
- - **InputExpandTextarea** — расширяемое текстовое поле
49
- - **Textarea** — многострочное текстовое поле
50
- - **Select** — выпадающий список
51
- - **SearchSelect** — поисковый выпадающий список
52
- - **Multiselect** — множественный выбор
53
- - **Checkbox** — чекбокс
54
- - **Radio** — радиокнопка
55
- - **Search** — поле поиска
56
- - **Calendar** — календарь для выбора даты
57
-
58
- ### Навигация и структура
59
-
60
- - **Menu** — боковое меню навигации
61
- - **Tabs** — вкладки
62
- - **Accordion** — аккордеон
63
- - **TreeView** — древовидное представление данных
64
-
65
- ### Отображение данных
66
-
67
- - **Table** — таблица с поддержкой сортировки, фильтрации и виртуализации
68
- - **FilterTable** — таблица с расширенными возможностями фильтрации
69
- - **Status** — индикатор статуса
70
- - **Icon** — иконки
71
- - **Message** — сообщения (информация, предупреждение, ошибка, успех)
72
- - **Preloader** — индикатор загрузки
73
-
74
- ### Взаимодействие
75
-
76
- - **Button** — кнопка
77
- - **Modal** — модальное окно
78
- - **Tooltip** — всплывающая подсказка
79
- - **NotificationProvider** и **useNotification** — система уведомлений
80
-
81
- ## 💡 Примеры использования
82
-
83
- ### Система уведомлений
84
-
85
- Для использования системы уведомлений, добавьте `NotificationProvider`:
86
-
87
- ```jsx
88
- import { NotificationProvider, useNotification } from 'urfu-ui-kit-react';
89
-
90
- function App() {
91
- return (
92
- <NotificationProvider>
93
- {/* Ваше приложение */}
94
- </NotificationProvider>
95
- );
96
- }
97
-
98
- // Использование в компонентах
99
- function MyComponent() {
100
- const { showNotification } = useNotification();
101
-
102
- const handleClick = () => {
103
- showNotification('success', 'Операция выполнена успешно!');
104
- };
105
-
106
- return <button onClick={handleClick}>Показать уведомление</button>;
107
- }
108
- ```
109
-
110
- ### Работа с формами
111
-
112
- ```jsx
113
- import {
114
- InputText,
115
- Select,
116
- Checkbox,
117
- Radio,
118
- Button
119
- } from 'urfu-ui-kit-react';
120
-
121
- function MyForm() {
122
- return (
123
- <form>
124
- <InputText
125
- title="Имя"
126
- required
127
- />
128
- <Select
129
- title="Выберите опцию"
130
- options={[
131
- { value: '1', label: 'Опция 1' },
132
- { value: '2', label: 'Опция 2' }
133
- ]}
134
- />
135
- <Checkbox
136
- title="Согласие"
137
- required
138
- />
139
- <Radio
140
- title="Выберите вариант"
141
- options={[
142
- { value: '1', label: 'Вариант 1' },
143
- { value: '2', label: 'Вариант 2' }
144
- ]}
145
- />
146
- <Button type="submit">Отправить</Button>
147
- </form>
148
- );
149
- }
150
- ```
151
-
152
- ### Навигация
153
-
154
- ```jsx
155
- import { Menu, Tabs } from 'urfu-ui-kit-react';
156
-
157
- function Navigation() {
158
- return (
159
- <>
160
- <Menu
161
- menuData={[
162
- { title: 'Главная', id: 'home' },
163
- { title: 'Раздел', id: 'section' }
164
- ]}
165
- />
166
- <Tabs
167
- tabs={[
168
- { title: 'Вкладка 1', id: 'tab1' },
169
- { title: 'Вкладка 2', id: 'tab2' }
170
- ]}
171
- />
172
- </>
173
- );
174
- }
175
- ```
176
-
177
- ### Модальные окна
178
-
179
- ```jsx
180
- import { Modal, Button } from 'urfu-ui-kit-react';
181
- import { useState } from 'react';
182
-
183
- function MyModal() {
184
- const [isOpen, setIsOpen] = useState(false);
185
-
186
- return (
187
- <>
188
- <Button onClick={() => setIsOpen(true)}>
189
- Открыть модальное окно
190
- </Button>
191
- <Modal
192
- isOpen={isOpen}
193
- onClose={() => setIsOpen(false)}
194
- title="Заголовок"
195
- >
196
- Содержимое модального окна
197
- </Modal>
198
- </>
199
- );
200
- }
201
- ```
202
-
203
- ### Работа с таблицами
204
-
205
- ```jsx
206
- import { Table } from 'urfu-ui-kit-react';
207
-
208
- function DataTable() {
209
- const columns = [
210
- { key: 'name', title: 'Имя' },
211
- { key: 'age', title: 'Возраст' },
212
- { key: 'city', title: 'Город' }
213
- ];
214
-
215
- const data = [
216
- { name: 'Иван', age: 25, city: 'Екатеринбург' },
217
- { name: 'Мария', age: 30, city: 'Москва' }
218
- ];
219
-
220
- return (
221
- <Table
222
- columns={columns}
223
- data={data}
224
- sortable
225
- />
226
- );
227
- }
228
- ```
229
-
230
- ## 📖 Документация
231
-
232
- Полная документация с примерами использования всех компонентов доступна в Storybook. Для запуска локальной версии:
233
-
234
- ```bash
235
- npm run sb
236
- ```
237
-
238
- Документация также доступна онлайн: [https://uikit.my1.urfu.ru](https://uikit.my1.urfu.ru)
239
-
240
- ## 🎨 Особенности
241
-
242
- - **TypeScript** — полная поддержка типов
243
- - **Адаптивность** — все компоненты адаптированы под разные разрешения экрана
244
- - **Виртуализация** — поддержка виртуализации для больших списков и таблиц
245
- - **Доступность** — компоненты разработаны с учетом принципов доступности
246
- - **Кастомизация** — гибкая настройка компонентов через пропсы
247
-
248
- ## 🔧 Требования
249
-
250
- - React ^18.3.1
251
- - React DOM ^18.3.1
252
-
253
- ## 📝 История версий
254
-
255
- Библиотека активно развивается. Основные изменения:
256
- - **v1.4.11** — текущая версия
257
- - **v1.4.11** текущая версия
258
- - Добавлена поддержка Tooltip с различными позициями (слева, снизу, сверху)
259
- - Улучшена работа с календарем и фильтрацией таблиц
260
- - Добавлена виртуализация для таблиц и селектов
261
- - Расширены возможности FilterTable
262
- - Добавлен компонент TreeView с поиском
263
- - Улучшена система уведомлений
264
- - Множество исправлений и оптимизаций
265
- ## 🤝 Поддержка
266
- ## 🤝 Поддержка
267
- При возникновении проблем или вопросов:
268
- При возникновении проблем или вопросов:
269
- 1. Проверьте документацию компонентов в Storybook
270
- 1. Проверьте документацию компонентов в Storybook
271
- 2. Изучите примеры использования
272
- 3. Поделитесь своими вопросами, замечаниями и рекомендациями: [Форма обратной связи](https://lk-form.my1.urfu.ru/uikit-feedback/submit)
273
- ## 📄 Лицензия
274
- ## 📄 Лицензия
275
- Apache-2.0
276
- Apache-2.0
1
+ # UrFU UI-Kit React
2
+
3
+ Библиотека React-компонентов для создания пользовательских интерфейсов в экосистеме Уральского федерального университета.
4
+
5
+ ## 📦 Установка
6
+
7
+ ```bash
8
+ npm install urfu-ui-kit-react
9
+ ```
10
+
11
+ ## 🚀 Быстрый старт
12
+
13
+ ### Базовая настройка
14
+
15
+ В библиотеку встроена библиотека стилей `urfu-ui-kit-vanilla`, поэтому нужно в корне проекта импортировать стили:
16
+
17
+ ```javascript
18
+ import "urfu-ui-kit-react/dist/style.css"
19
+ ```
20
+
21
+ Или подключиться по ссылке конкретной версии как указано здесь: [https://uikit.my1.urfu.ru/#/ui/main](https://uikit.my1.urfu.ru/#/ui/main)
22
+
23
+ **Важно:** Библиотека по умолчанию имеет шрифт Montserrat и полосу прокрутки, адаптивную под разные разрешения экрана. Они объявлены глобально и применяются в проекте посредством импорта библиотеки. А также стили глобально применены для тегов `h1-h6`.
24
+
25
+ ### Импорт компонентов
26
+
27
+ Импорт компонентов осуществляется по имени:
28
+
29
+ ```javascript
30
+ import {
31
+ Button,
32
+ InputText,
33
+ Select,
34
+ Checkbox,
35
+ Preloader,
36
+ Message,
37
+ Tooltip
38
+ } from "urfu-ui-kit-react";
39
+ ```
40
+
41
+ ## 📚 Компоненты
42
+
43
+ ### Формы и ввод данных
44
+
45
+ - **InputText** — текстовое поле ввода
46
+ - **InputNumber** — поле ввода чисел
47
+ - **InputFile** — загрузка файлов
48
+ - **InputExpandTextarea** — расширяемое текстовое поле
49
+ - **Textarea** — многострочное текстовое поле
50
+ - **Select** — выпадающий список
51
+ - **SearchSelect** — поисковый выпадающий список
52
+ - **Multiselect** — множественный выбор
53
+ - **Checkbox** — чекбокс
54
+ - **Radio** — радиокнопка
55
+ - **Search** — поле поиска
56
+ - **Calendar** — календарь для выбора даты
57
+
58
+ ### Навигация и структура
59
+
60
+ - **Menu** — боковое меню навигации
61
+ - **Tabs** — вкладки
62
+ - **Accordion** — аккордеон
63
+ - **TreeView** — древовидное представление данных
64
+
65
+ ### Отображение данных
66
+
67
+ - **Table** — таблица с поддержкой сортировки, фильтрации и виртуализации
68
+ - **FilterTable** — таблица с расширенными возможностями фильтрации
69
+ - **Status** — индикатор статуса
70
+ - **Icon** — иконки
71
+ - **Message** — сообщения (информация, предупреждение, ошибка, успех)
72
+ - **Preloader** — индикатор загрузки
73
+
74
+ ### Взаимодействие
75
+
76
+ - **Button** — кнопка
77
+ - **Modal** — модальное окно
78
+ - **Tooltip** — всплывающая подсказка
79
+ - **NotificationProvider** и **useNotification** — система уведомлений
80
+
81
+ ## 💡 Примеры использования
82
+
83
+ ### Система уведомлений
84
+
85
+ Для использования системы уведомлений, добавьте `NotificationProvider`:
86
+
87
+ ```jsx
88
+ import { NotificationProvider, useNotification } from 'urfu-ui-kit-react';
89
+
90
+ function App() {
91
+ return (
92
+ <NotificationProvider>
93
+ {/* Ваше приложение */}
94
+ </NotificationProvider>
95
+ );
96
+ }
97
+
98
+ // Использование в компонентах
99
+ function MyComponent() {
100
+ const { showNotification } = useNotification();
101
+
102
+ const handleClick = () => {
103
+ showNotification('success', 'Операция выполнена успешно!');
104
+ };
105
+
106
+ return <button onClick={handleClick}>Показать уведомление</button>;
107
+ }
108
+ ```
109
+
110
+ ### Работа с формами
111
+
112
+ ```jsx
113
+ import {
114
+ InputText,
115
+ Select,
116
+ Checkbox,
117
+ Radio,
118
+ Button
119
+ } from 'urfu-ui-kit-react';
120
+
121
+ function MyForm() {
122
+ return (
123
+ <form>
124
+ <InputText
125
+ title="Имя"
126
+ required
127
+ />
128
+ <Select
129
+ title="Выберите опцию"
130
+ options={[
131
+ { value: '1', label: 'Опция 1' },
132
+ { value: '2', label: 'Опция 2' }
133
+ ]}
134
+ />
135
+ <Checkbox
136
+ title="Согласие"
137
+ required
138
+ />
139
+ <Radio
140
+ title="Выберите вариант"
141
+ options={[
142
+ { value: '1', label: 'Вариант 1' },
143
+ { value: '2', label: 'Вариант 2' }
144
+ ]}
145
+ />
146
+ <Button type="submit">Отправить</Button>
147
+ </form>
148
+ );
149
+ }
150
+ ```
151
+
152
+ ### Навигация
153
+
154
+ ```jsx
155
+ import { Menu, Tabs } from 'urfu-ui-kit-react';
156
+
157
+ function Navigation() {
158
+ return (
159
+ <>
160
+ <Menu
161
+ menuData={[
162
+ { title: 'Главная', id: 'home' },
163
+ { title: 'Раздел', id: 'section' }
164
+ ]}
165
+ />
166
+ <Tabs
167
+ tabs={[
168
+ { title: 'Вкладка 1', id: 'tab1' },
169
+ { title: 'Вкладка 2', id: 'tab2' }
170
+ ]}
171
+ />
172
+ </>
173
+ );
174
+ }
175
+ ```
176
+
177
+ ### Модальные окна
178
+
179
+ ```jsx
180
+ import { Modal, Button } from 'urfu-ui-kit-react';
181
+ import { useState } from 'react';
182
+
183
+ function MyModal() {
184
+ const [isOpen, setIsOpen] = useState(false);
185
+
186
+ return (
187
+ <>
188
+ <Button onClick={() => setIsOpen(true)}>
189
+ Открыть модальное окно
190
+ </Button>
191
+ <Modal
192
+ isOpen={isOpen}
193
+ onClose={() => setIsOpen(false)}
194
+ title="Заголовок"
195
+ >
196
+ Содержимое модального окна
197
+ </Modal>
198
+ </>
199
+ );
200
+ }
201
+ ```
202
+
203
+ ### Работа с таблицами
204
+
205
+ ```jsx
206
+ import { Table } from 'urfu-ui-kit-react';
207
+
208
+ function DataTable() {
209
+ const columns = [
210
+ { key: 'name', title: 'Имя' },
211
+ { key: 'age', title: 'Возраст' },
212
+ { key: 'city', title: 'Город' }
213
+ ];
214
+
215
+ const data = [
216
+ { name: 'Иван', age: 25, city: 'Екатеринбург' },
217
+ { name: 'Мария', age: 30, city: 'Москва' }
218
+ ];
219
+
220
+ return (
221
+ <Table
222
+ columns={columns}
223
+ data={data}
224
+ sortable
225
+ />
226
+ );
227
+ }
228
+ ```
229
+
230
+ ## 📖 Документация
231
+
232
+ Полная документация с примерами использования всех компонентов доступна в Storybook. Для запуска локальной версии:
233
+
234
+ ```bash
235
+ npm run sb
236
+ ```
237
+
238
+ Документация также доступна онлайн: [https://uikit.my1.urfu.ru](https://uikit.my1.urfu.ru)
239
+
240
+ ## 🎨 Особенности
241
+
242
+ - **TypeScript** — полная поддержка типов
243
+ - **Адаптивность** — все компоненты адаптированы под разные разрешения экрана
244
+ - **Виртуализация** — поддержка виртуализации для больших списков и таблиц
245
+ - **Доступность** — компоненты разработаны с учетом принципов доступности
246
+ - **Кастомизация** — гибкая настройка компонентов через пропсы
247
+
248
+ ## 🔧 Требования
249
+
250
+ - React ^18.3.1
251
+ - React DOM ^18.3.1
252
+
253
+ ## 📝 История версий
254
+
255
+ Библиотека активно развивается. Основные изменения:
256
+ - **v1.4.11** — текущая версия
257
+ - Добавлена поддержка Tooltip с различными позициями (слева, снизу, сверху)
258
+ - Улучшена работа с календарем и фильтрацией таблиц
259
+ - Добавлена виртуализация для таблиц и селектов
260
+ - Расширены возможности FilterTable
261
+ - Добавлен компонент TreeView с поиском
262
+ - Улучшена система уведомлений
263
+ - Множество исправлений и оптимизаций
264
+
265
+ ## 🤝 Поддержка
266
+ При возникновении проблем или вопросов:
267
+ 1. Проверьте документацию компонентов в Storybook
268
+ 2. Изучите примеры использования
269
+ 3. Поделитесь своими вопросами, замечаниями и рекомендациями: [Форма обратной связи](https://lk-form.my1.urfu.ru/uikit-feedback/submit)
package/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "urfu-ui-kit-react",
3
3
  "description": "UrFU UI-Kit for React Web",
4
- "license": "Apache-2.0",
4
+ "license": "UNLICENSED",
5
5
  "private": false,
6
- "version": "1.5.1",
6
+ "version": "1.5.2",
7
7
  "type": "module",
8
8
  "main": "dist/urfu-ui-kit-react",
9
9
  "types": "dist/urfu-ui-kit-react",
10
10
  "scripts": {
11
11
  "start": "vite",
12
- "build": "tsc && vite build && copy LICENSE dist\\",
12
+ "build": "tsc && vite build",
13
13
  "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
14
14
  "preview": "vite preview",
15
15
  "sb": "storybook dev -p 6006",
@@ -20,7 +20,7 @@
20
20
  "date-fns": "^3.6.0",
21
21
  "react-datepicker": "^7.4.0",
22
22
  "react-input-mask": "^2.0.4",
23
- "urfu-ui-kit-vanilla": "^2.4.1"
23
+ "urfu-ui-kit-vanilla": "^2.4.2"
24
24
  },
25
25
  "devDependencies": {
26
26
  "@chromatic-com/storybook": "^1.3.3",
@@ -61,4 +61,4 @@
61
61
  "files": [
62
62
  "dist"
63
63
  ]
64
- }
64
+ }
package/LICENSE DELETED
@@ -1,19 +0,0 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- Copyright 2024 ФГАОУ ВО «УрФУ имени первого Президента России Б.Н. Ельцина»
8
-
9
- Licensed under the Apache License, Version 2.0 (the "License");
10
- you may not use this file except in compliance with the License.
11
- You may obtain a copy of the License at
12
-
13
- http://www.apache.org/licenses/LICENSE-2.0
14
-
15
- Unless required by applicable law or agreed to in writing, software
16
- distributed under the License is distributed on an "AS IS" BASIS,
17
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18
- See the License for the specific language governing permissions and
19
- limitations under the License.
package/dist/LICENSE DELETED
@@ -1,19 +0,0 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- Copyright 2024 ФГАОУ ВО «УрФУ имени первого Президента России Б.Н. Ельцина»
8
-
9
- Licensed under the Apache License, Version 2.0 (the "License");
10
- you may not use this file except in compliance with the License.
11
- You may obtain a copy of the License at
12
-
13
- http://www.apache.org/licenses/LICENSE-2.0
14
-
15
- Unless required by applicable law or agreed to in writing, software
16
- distributed under the License is distributed on an "AS IS" BASIS,
17
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18
- See the License for the specific language governing permissions and
19
- limitations under the License.