Skip to content

add docs - #93

Open
AxyIX wants to merge 9 commits into
mainfrom
figma-api
Open

add docs#93
AxyIX wants to merge 9 commits into
mainfrom
figma-api

Conversation

@AxyIX

@AxyIX AxyIX commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@AxyIX AxyIX closed this Jul 23, 2026
@AxyIX AxyIX reopened this Jul 23, 2026
Comment thread docs/components-api/common-info.md Outdated
@@ -0,0 +1,4 @@
Дока описывает публичное апи компонента, без привязки к стэку.
То есть работа с формами, состояния (hover/foces/etc), валидации в этой документации не описываются, так как способы реализации и связанные с этим свойства для каждого стэка свои.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

опечатка: foces вместо focus

Comment thread docs/components-api/checkbox.md Outdated
| ---------------- | ----------------------------------------------- | ----------------- |
| `label` | текст названия поля | `string` |
| `label-position` | положение лейбла | `default \| left` |
| `note` | текст пояснения под лейблом | `string` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note – предлагаю заменить на caption

Comment thread docs/components-api/inputtext.md Outdated
| `label` | текст названия поля | `string` |
| `label-position` | положение лейбла | `default \| float \| left` |
| `clearable` | отображение иконки для очистки поля | `boolean` |
| `note` | текст пояснения под полем | `string` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note – предлагаю заменить на caption

Comment thread docs/components-api/multiselect.md Outdated
| `filter-placeholder` | текст подсказки в фильтре | `string` |
| `options` | список элементов или список групп с элементами | `ExtraMultiselectGroup[] \| ExtraMultiselectOption[] \| any[]` |
| `optionLabel` | наименование поля, содержащего отображаемое значение | `string` |
| `note` | текст пояснения под полем | `string` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note – предлагаю заменить на caption

@@ -0,0 +1,28 @@
[Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=1207-3811&m=dev)

# ExtraCarousel

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

по фигме у карусели можно менять иконки кнопок например
нужно проверить соответствие апи


| Свойство | Описание | Типизация |
| -------------- | ------------------------------------------- | ---------- |
| `modal` | отображать маску (overlay) поверх интерфейса | `boolean` |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Всегда бесило это в старых библиотеках. Поле modal отвечает за наличие overlay.
Может тут нормально назовем? hasOverlay или withOverlay? (проверить остальные modal флаги)

Вопрос 2.
Есть некий стайл гайд на именование bool-полей? with-/ has- or just overlay?

| Свойство | Описание | Типизация |
| -------------- | ------------------------------------------- | ---------- |
| `modal` | отображать маску (overlay) поверх интерфейса | `boolean` |
| `maximizable` | кнопка разворота окна на весь экран | `boolean` |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Тут тоже косяк. Речь идет про наличие такой возможности. Но флаг определяющий это почему-то прилагательное. Хотя в этом же компоненте для таких целей используются существительные.

| `maximizable` | кнопка разворота окна на весь экран | `boolean` |
| `show-close` | кнопка закрытия окна | `boolean` |

# Слоты (content projection)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

думаю стоит учесть возможность передачи обычных строк для прямого отображения, в случае отсутствующей необходимости кастомизации модалки.

| Свойство | Описание | Типизация |
| ---------------- | ----------------------------------------------- | ----------------- |
| `label` | текст названия поля | `string` |
| `label-position` | положение лейбла | `default \| left` |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default / left - не понятно что в таком случае делает default?

| `timer` | таймер автоскрытия | `boolean` |
| `message` | заголовок сообщения | `string` |
| `caption` | заголовок сообщения | `string` |
| `icon` | класс иконки tabler icon (вместо стандартной для `severity`) | `string` |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

нужна возможность скрытия икнонки. Что-то из:
icon=null
icon=none

| `severity` | тип сообщения | `info \| success \| warning \| danger` |
| `timer` | таймер автоскрытия | `boolean` |
| `message` | заголовок сообщения | `string` |
| `caption` | заголовок сообщения | `string` |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

caption - текст сообщения

| -------- | --------------- | ------------------ |
| `name` | текст варианта | `string` |
| `code` | идентификатор | `string \| number` |
| `icon` | класс иконки tabler icon | `string` |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Это поле можно не указывать - в спеке должна быть пометка

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants