@huntflow/ui 0.2.33 → 0.2.34-test.0

package/README.md

@@ -21,27 +21,121 @@
 
 Для добавления UiKit в ваш проект выполните:
 
-```javascript
+```bash
 npm install @huntflow/ui
 ```
 
-## 📚 Storybook
+### Подключение в проекте
 
-```javascript
+Подключите глобальные стили и один раз внедрите SVG-спрайт для иконок:
+
+```ts
+import '@huntflow/ui/dist/global.css';
+import { injectSvgSprite } from '@huntflow/ui';
+
+await injectSvgSprite();
+```
+
+## 📚 Документация и разработка
+
+- **Storybook** — каталог компонентов и примеры использования. Локальный запуск:
+
+```bash
 npm run storybook
 ```
 
 ## 🎨 Иконки
-Для того, чтобы актуализировать иконки, необходимо создать `.env` (пример в `.env.develop`):
-- указать свой токен Figma (Help and account → Account settings → Security → Personal access tokens)
-- необходимый `FIGMA_FILE_ID` (Например: `https://www.figma.com/design/DV8Zm9gdvUocVlrqD8egvV/Igor-(New-UI-Kit)?node-id=1581-180&p=f&t=YzO5zlBlx3wPY5HW-0` это `DV8Zm9gdvUocVlrqD8egvV`)
-- необходимый `NODE_ID` (Например: `https://www.figma.com/design/DV8Zm9gdvUocVlrqD8egvV/Igor-(New-UI-Kit)?node-id=1581-180&p=f&t=YzO5zlBlx3wPY5HW-0` это `1581-180`, указываем через двоеточие)
-- скачать новый иконки `npm run icons:download`
-- обновить типы и список иконок `npm run icons:update-list`
-
-
-##  Пример использования
-```javascript
-import { UiButton } from '@huntflow/ui';
-import { UiIcon } from '@huntflow/ui/icons';
+# Актуализация иконок
+
+Чтобы актуализировать иконки, выполните следующие шаги:
+
+1. Создайте файл `.env` (можно использовать пример из `.env.develop`).
+
+2. Укажите необходимые переменные:
+
+   - **`FIGMA_TOKEN`** — персональный токен Figma  
+     *(Иконка профиля -> Settings -> Security -> Personal access tokens -> Generate new token)*
+
+   - **`FIGMA_FILE_ID`** — ID файла Figma  
+     Пример:  
+     ```
+     Ссылка: https://www.figma.com/design/DV8Zm9gdvUocVlrqD8egvV/Igor-(New-UI-Kit)?node-id=1581-180&p=f&t=YzO5zlBlx3wPY5HW-0
+     FIGMA_FILE_ID = DV8Zm9gdvUocVlrqD8egvV
+     ```
+
+   - **`NODE_ID`** — ID узла Figma  
+     Пример из той же ссылки:  
+     ```
+     NODE_ID = 1581-180, указываем через двоеточие (1581:180)
+     ```  
+
+3. Скачайте новые иконки:  
+```bash
+npm run icons:download
+```
+
+4. Обновите типы и список иконок:  
+```bash
+npm run icons:update-list
+```
+
+5. Соберите SVG-спрайт из иконок:  
+```bash
+npm run sprite
+```
+
+Для отображения иконок нужно один раз внедрить SVG-спрайт: 
+
+```ts
+import { injectSvgSprite } from '@huntflow/ui';
+
+await injectSvgSprite();
+```
+
+# Добавление новых токенов из Figma
+
+1. В Figma откройте **Plugins → Sync Variables**.
+
+2. В правой панели в плагине:  
+   - В правой панели где открылся плагин ставим галочки 
+   - Жмем **Generate → Copy to clipboard**.
+
+3. Вставьте скопированные токены в файл:  
+```
+src/assets/css/token.css
+```
+4. В терминале выполните команду для конвертации токенов:
+```bash
+npm run tokens:convert
+```
+
+## Компоненты
+
+| Компонент | Описание |
+|-----------|----------|
+| `UiButton` | Стандартная кнопка |
+| `UiButtonIcon` | Кнопка только с иконкой, без текста |
+| `UiButtonLink` | Кнопка в виде ссылки, с опциональной иконкой и замочком |
+| `UiIcon` | Иконка из SVG-спрайта |
+| `UiInput` | Инпут |
+| `UiTextarea` | Многострочное поле ввода |
+| `UiLabel` | Лейбл для полей форм |
+| `UiLoader` | Индикатор загрузки (спиннер) |
+| `UiPlank` | Плашка |
+| `UiText` | Текстовый блок |
+| `UiTitle` | Заголовок (h1–h4) |
+| `UiError` | Отображение сообщения об ошибке в формах |
+| `UiAvatar` | Аватар пользователя |
+| `UiStack` | Flex-контейнер для компоновки элементов с настройкой gap и выравнивания |
+| `UiRadioGroup` | Группа радиокнопок |
+| `UiCheckboxGroup` | Группа чекбоксов |
+| `UiDropzone` | Область перетаскивания и выбора файлов для загрузки |
+
+## Пример использования
+
+```ts
+import { UiButton, UiIcon } from '@huntflow/ui';
+
+<ui-button>Кнопка</ui-button>
+<ui-icon name="icon-name" />
 ```

package/dist/components/ui-radio-button/radio-button.vue.d.ts

@@ -2,7 +2,7 @@ import { UiRadioButtonProps } from './types';
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: {
-        title?(_: {}): any;
+        label?(_: {}): any;
         subtitle?(_: {}): any;
     };
     refs: {};

package/dist/components/ui-radio-button/types.d.ts

@@ -1,9 +1,13 @@
 export type UiRadioButtonProps = {
     value: string;
     disabled?: boolean;
-    title?: string;
+    label?: string;
     subtitle?: string;
     partial?: boolean;
     required?: boolean;
     name?: string;
+    /** Вертикальное расположение: индикатор сверху, лейбл снизу */
+    vertical?: boolean;
+    /** Выравнивание индикатора и лейбла внутри радиокнопки */
+    itemsAlign?: 'start' | 'center';
 };

package/dist/components/ui-radio-group/radio-group.vue.d.ts

@@ -7,7 +7,7 @@ type __VLS_PublicProps = {
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: {
-        optionTitle?(_: {
+        optionLabel?(_: {
             option: import('../ui-radio-button').UiRadioButtonProps;
         }): any;
         optionSubtitle?(_: {

package/dist/components/ui-radio-group/types.d.ts

@@ -7,7 +7,12 @@ export type UiRadioGroupProps = {
     disabled?: boolean;
     error?: string;
     required?: boolean;
+    /** Направление расположения радиокнопок в группе */
     direction?: 'column' | 'row';
+    /** Вертикальное расположение внутри каждой радиокнопки: индикатор сверху, лейбл снизу */
+    vertical?: boolean;
+    /** Выравнивание индикатора и лейбла внутри каждой радиокнопки */
+    itemsAlign?: 'start' | 'center';
     loop?: boolean;
     dir?: 'ltr' | 'rtl';
     stackGap?: 's' | 'l';