add docs #93
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| [Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=1207-3420&m=dev) | ||
|
|
||
| # ExtraAccordion | ||
|
|
||
| Контейнер из раскрывающихся панелей. Панели передаются как дочерние элементы `ExtraAccordionPanel`. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | ----------- | ------------------------------------------------- | ---------- | | ||
| | `multiple` | разрешить несколько раскрытых панелей одновременно | `boolean` | | ||
|
|
||
| # События | ||
|
|
||
| | Событие | Описание | Типизация | | ||
| | --------- | -------------------------------- | ---------- | | ||
| | `onOpen` | срабатывает при раскрытии панели | `() => void` | | ||
| | `onClose` | срабатывает при сворачивании панели | `() => void` | | ||
|
|
||
| # ExtraAccordionPanel | ||
|
|
||
| Отдельная панель аккордеона: заголовок + раскрываемое тело. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | ----------- | ----------------------- | ---------- | | ||
| | `icon` | класс иконки заголовка | `string` | | ||
| | `expanded` | раскрыта ли панель | `boolean` | | ||
| | `disabled` | панель недоступна | `boolean` | | ||
|
|
||
| # Слоты (content projection) | ||
|
|
||
| | Слот | Описание | | ||
| | --------- | ------------------------------ | | ||
| | `header` | заголовок панели | | ||
| | `content` | содержимое панели (тело) | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| [Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=9370-42381&m=dev) | ||
|
|
||
| # ExtraAutoComplete | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | ---------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------- | | ||
| | `placeholder` | текст подсказки внутри поля | `string` | | ||
| | `label` | текст названия поля | `string` | | ||
| | `label-position` | положение лейбла | `default \| float \| left` | | ||
| | `multiple` | множественный выбор значений (выбранные отображаются в виде chips) | `boolean` | | ||
| | `suggestions` | список предлагаемых вариантов, выводимых в оверлее | `ExtraAutoCompleteGroup[] \| ExtraAutoCompleteOption[] \| any[]` | | ||
| | `completeMethod` | функция, загружающая `suggestions` в зависимости от введённого значения | `(event: ExtraAutoCompleteCompleteEvent) => void` | | ||
| | `optionLabel` | наименование поля, содержащего отображаемое значение | `string` | | ||
| | `loading` | отображение индикатора загрузки | `boolean` | | ||
| | `chip` | отображать выбранные значения в виде chips | `boolean` | | ||
| | `chip-icon` | класс иконки tabler icon для элементов при отображении chips | `string` | | ||
| | `chip-clearable` | отображение иконки удаления chip | `boolean` | | ||
| | `show-checkbox` | отображать чекбокс у option | `boolean` | | ||
| | `clearable` | отображение иконки для очистки поля | `boolean` | | ||
| | `caption` | текст пояснения под полем | `string` | | ||
| | `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` | | ||
| | `size` | размер поля | `sm \| base \| lg \| xlg` | | ||
|
|
||
| Группировка элементов определяется по данным: если в `suggestions` передан `ExtraAutoCompleteGroup`, варианты выводятся сгруппированно. | ||
|
|
||
| # ExtraAutoCompleteCompleteEvent | ||
|
|
||
| Событие, передаваемое в `completeMethod`. По введённому значению `query` обработчик формирует и записывает новый список в `suggestions`. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | --------------- | -------------------------------- | --------- | | ||
| | `query` | введённое пользователем значение | `string` | | ||
| | `originalEvent` | исходное браузерное событие | `Event` | | ||
|
|
||
| # ExtraAutoCompleteOption | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | -------- | -------------- | ------------------ | | ||
| | `name` | текст варианта | `string` | | ||
| | `code` | идентификатор | `string \| number` | | ||
|
|
||
| # ExtraAutoCompleteGroup | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | --------- | ------------------- | ------------------------------------ | | ||
| | `options` | список элементов | `ExtraAutoCompleteOption[] \| any[]` | | ||
| | `name` | наименование группы | `string` | | ||
|
|
||
| # События | ||
|
|
||
| | Событие | Описание | Типизация | | ||
| | ----------------- | ---------------------------------------- | ----------------------------------------------------- | | ||
| | `onSelect` | срабатывает при выборе варианта | `(event: ExtraAutoCompleteSelectEvent) => void` | | ||
| | `onUnselect` | срабатывает при снятии выбора | `(event: ExtraAutoCompleteSelectEvent) => void` | | ||
| | `onClear` | срабатывает при очистке значения | `() => void` | | ||
| | `onShow` | срабатывает при открытии оверлея | `() => void` | | ||
| | `onHide` | срабатывает при закрытии оверлея | `() => void` | | ||
| | `onDropdownClick` | срабатывает при клике по кнопке dropdown | `(event: ExtraAutoCompleteDropdownClickEvent) => void` | | ||
|
|
||
| # ExtraAutoCompleteSelectEvent | ||
|
|
||
| Событие выбора варианта, передаётся в `onSelect` и `onUnselect`. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | --------------- | ----------------- | --------- | | ||
| | `value` | выбранный вариант | `any` | | ||
| | `originalEvent` | исходное событие | `Event` | | ||
|
|
||
| # ExtraAutoCompleteDropdownClickEvent | ||
|
|
||
| Событие клика по кнопке dropdown, передаётся в `onDropdownClick`. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | --------------- | ---------------------------------- | --------- | | ||
| | `query` | введённое значение на момент клика | `string` | | ||
| | `originalEvent` | исходное событие | `Event` | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| [Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=484-4972&m=dev) | ||
|
|
||
| # ExtraAvatar | ||
|
|
||
| Представление пользователя. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | -------- | --------------------------- | ------------------------- | | ||
| | `size` | размер аватара | `base \| large \| xlarge` | | ||
| | `shape` | форма | `square \| circle` | | ||
| | `image` | изображение | `string` | | ||
| | `label` | текст/инициалы | `string` | | ||
| | `icon` | класс иконки tabler icon | `string` | | ||
| | `badge` | отображать значок (`Badge`) | `string` | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| [Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=484-4871&m=dev) | ||
|
|
||
| # ExtraBadge | ||
|
|
||
| Счётчик или статус для элемента. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | ----------- | ------------------------------------------ | -------------------------------------- | | ||
| | `severity` | вариант стиля | `primary \| info \| success \| warning \| danger` | | ||
| | `value` | значение (счётчик/текст) | `string` | | ||
| | `dot` | режим точки (без значения) | `boolean` | | ||
| | `size` | размер | `base \| large \| xlarge` | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| [Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=1207-3471&m=dev) | ||
|
|
||
| # ExtraCard | ||
|
|
||
| Карточка для отображения информации. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | ---------- | --------------------------- | ---------- | | ||
| | `overlay` | отображать тень (возвышение) | `boolean` | | ||
|
|
||
| # Слоты (content projection) | ||
|
|
||
| | Слот | Описание | | ||
| | --------- | --------------------------------- | | ||
| | `header` | верхняя область (обычно изображение) | | ||
| | `content` | тело карточки | | ||
| | `footer` | нижний колонтитул | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| [Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=1207-3811&m=dev) | ||
|
|
||
| # ExtraCarousel | ||
|
|
||
| Прокручиваемый набор элементов. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | ------------------- | -------------------------------------- | ------------------------- | | ||
| | `show-nav` | кнопки навигации (стрелки) | `boolean` | | ||
| | `show-indicators` | индикаторы-точки (пагинация) | `boolean` | | ||
| | `nav-icon-left` | класс иконки tabler icon кнопки слева | `string` | | ||
| | `nav-icon-right` | класс иконки tabler icon кнопки справа | `string` | | ||
| | `nav-text-left` | текст кнопок навигации слева | `string` | | ||
| | `nav-text-right` | текст кнопок навигации справа | `string` | | ||
| | `nav-variant` | вариант стиля кнопок навигации | `string` | | ||
| | `nav-size` | размер кнопок навигации | `sm \| base \| lg \| xlg` | | ||
| | `nav-rounded` | скруглённая форма кнопок | `boolean` | | ||
| | `nav-icon-position` | позиция иконки в кнопках | `left \| right` | | ||
|
|
||
| # Слоты (content projection) | ||
|
|
||
| | Слот | Описание | | ||
| | --------- | ------------------------ | | ||
| | `content` | шаблон элемента карусели | | ||
|
|
||
| # События | ||
|
|
||
| | Событие | Описание | Типизация | | ||
| | -------------- | ------------------------------ | ----------------------------------------- | | ||
| | `onPageChange` | срабатывает при смене страницы | `(event: ExtraCarouselPageEvent) => void` | | ||
|
|
||
| # ExtraCarouselPageEvent | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | -------- | ---------------- | --------- | | ||
| | `page` | текущая страница | `number` | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| [Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=484-5316&m=dev) | ||
|
|
||
| # ExtraCheckbox | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | ---------------- | ----------------------------------------------- | ----------------- | | ||
| | `label` | текст названия поля | `string` | | ||
| | `label-position` | положение лейбла | `default \| left` | | ||
|
Collaborator
There was a problem hiding this comment.
|
||
| | `caption` | текст пояснения под лейблом | `string` | | ||
| | `indeterminate` | возможно ли третье состояние (частично выбрано) | `boolean` | | ||
|
|
||
| # События | ||
|
|
||
| | Событие | Описание | Типизация | | ||
| | ---------- | --------------------------------- | ------------------------------------------ | | ||
| | `onChange` | срабатывает при изменении состояния | `(event: ExtraCheckboxChangeEvent) => void` | | ||
|
|
||
| # ExtraCheckboxChangeEvent | ||
|
|
||
| Событие изменения состояния, передаётся в `onChange`. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | --------------- | ------------------ | --------- | | ||
| | `checked` | состояние чекбокса | `boolean` | | ||
| | `originalEvent` | исходное событие | `Event` | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| [Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=484-5126&m=dev) | ||
|
|
||
| # ExtraChip | ||
|
|
||
| Метка для представления значения. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | ----------- | ------------------------ | --------- | | ||
| | `label` | текст метки | `string` | | ||
| | `icon` | класс иконки tabler icon | `string` | | ||
| | `removable` | кнопка удаления метки | `boolean` | | ||
| | `disabled` | блокаровка | `boolean` | | ||
|
|
||
| # События | ||
|
|
||
| | Событие | Описание | Типизация | | ||
| | ---------- | ------------------------ | ------------ | | ||
| | `onRemove` | срабатывает при удалении | `() => void` | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| Дока описывает публичное апи компонента, без привязки к стэку. | ||
| То есть работа с формами, состояния (hover/focus/etc), валидации в этой документации не описываются, так как способы реализации и связанные с этим свойства для каждого стэка свои. | ||
|
|
||
| [Общий вид лейблов в свяске с полями](https://www.figma.com/design/5PubP8FifQkibWvs3mZVqt/Templates--DS--v2.0?node-id=5243-4312&m=dev) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| [Открыть в Figma →](https://www.figma.com/design/Q1BWgZ7zoV5UzlBOnjW0cM/UI-Kit--DS--v2.1?node-id=562-2797&m=dev) | ||
|
|
||
| # ExtraConfirmDialog | ||
|
|
||
| Модальное окно подтверждения действия. | ||
|
|
||
| | Свойство | Описание | Типизация | | ||
| | --------------- | --------------------------------------------------- | -------------------------------------- | | ||
| | `severity` | стиль окна (иконка и тон заголовка) | `danger \| warning \| success \| info \| help` | | ||
| | `header` | заголовок окна | `string` | | ||
| | `show-header` | отображать верхний колонтитул | `boolean` | | ||
| | `accept-label` | текст кнопки подтверждения | `string` | | ||
| | `accept-icon` | класс иконки tabler icon для подтверждения | `string` | | ||
| | `accept-icon-position` | положение иконки подтверждения | `left \| right` | | ||
| | `reject-label` | текст кнопки отмены | `string` | | ||
| | `reject-icon` | класс иконки tabler icon для отмены | `string` | | ||
| | `reject-icon-position` | положение иконки отмены | `left \| right` | | ||
|
|
||
| # Слоты (content projection) | ||
|
|
||
| | Слот | Описание | | ||
| | --------- | ---------------------------------------------------------- | | ||
| | `content` | основное содержимое окна (тело) — область под произвольный контент | | ||
|
|
||
| # События | ||
|
|
||
| | Событие | Описание | Типизация | | ||
| | --------- | -------------------------------- | ---------- | | ||
| | `onHide` | срабатывает при закрытии окна | `() => void` | |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
по фигме у карусели можно менять иконки кнопок например
нужно проверить соответствие апи