Skip to content

apply naming rules #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AxyIX wants to merge 1 commit into
base: main
Choose a base branch
from
Open

apply naming rules #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/components-api/accordion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@

| Событие | Описание | Типизация |
| --------- | -------------------------------- | ---------- |
| `onOpen` | срабатывает при раскрытии панели | `() => void` |
| `onClose` | срабатывает при сворачивании панели | `() => void` |
| `open` | срабатывает при раскрытии панели | `() => void` |
| `close` | срабатывает при сворачивании панели | `() => void` |

# ExtraAccordionPanel

Expand Down
28 changes: 14 additions & 14 deletions docs/components-api/autocomplete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@
| ---------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `placeholder` | текст подсказки внутри поля | `string` |
| `label` | текст названия поля | `string` |
| `label-position` | положение лейбла | `default \| float \| left` |
| `labelPosition` | положение лейбла | `left \| top \| float` |
| `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` |
| `showChips` | отображать выбранные значения в виде chips | `boolean` |
| `chipIcon` | класс иконки tabler icon для элементов при отображении chips | `string` |
| `chipClearable` | отображение иконки удаления chip | `boolean` |
| `showCheckbox` | отображать чекбокс у option | `boolean` |
| `clearable` | отображение иконки для очистки поля | `boolean` |
| `caption` | текст пояснения под полем | `string` |
| `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` |
| `size` | размер поля | `sm \| base \| lg \| xlg` |
| `size` | размер поля | `small \| base \| large \| xlarge` |

Группировка элементов определяется по данным: если в `suggestions` передан `ExtraAutoCompleteGroup`, варианты выводятся сгруппированно.

Expand Down Expand Up @@ -50,16 +50,16 @@

| Событие | Описание | Типизация |
| ----------------- | ---------------------------------------- | ----------------------------------------------------- |
| `onSelect` | срабатывает при выборе варианта | `(event: ExtraAutoCompleteSelectEvent) => void` |
| `onUnselect` | срабатывает при снятии выбора | `(event: ExtraAutoCompleteSelectEvent) => void` |
| `onClear` | срабатывает при очистке значения | `() => void` |
| `onShow` | срабатывает при открытии оверлея | `() => void` |
| `onHide` | срабатывает при закрытии оверлея | `() => void` |
| `onDropdownClick` | срабатывает при клике по кнопке dropdown | `(event: ExtraAutoCompleteDropdownClickEvent) => void` |
| `select` | срабатывает при выборе варианта | `(event: ExtraAutoCompleteSelectEvent) => void` |
| `unselect` | срабатывает при снятии выбора | `(event: ExtraAutoCompleteSelectEvent) => void` |
| `clear` | срабатывает при очистке значения | `() => void` |
| `show` | срабатывает при открытии оверлея | `() => void` |
| `hide` | срабатывает при закрытии оверлея | `() => void` |
| `dropdownClick` | срабатывает при клике по кнопке dropdown | `(event: ExtraAutoCompleteDropdownClickEvent) => void` |

# ExtraAutoCompleteSelectEvent

Событие выбора варианта, передаётся в `onSelect` и `onUnselect`.
Событие выбора варианта, передаётся в `select` и `unselect`.

| Свойство | Описание | Типизация |
| --------------- | ----------------- | --------- |
Expand All @@ -68,7 +68,7 @@

# ExtraAutoCompleteDropdownClickEvent

Событие клика по кнопке dropdown, передаётся в `onDropdownClick`.
Событие клика по кнопке dropdown, передаётся в `dropdownClick`.

| Свойство | Описание | Типизация |
| --------------- | ---------------------------------- | --------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/components-api/button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| --------------- | --------------------------------------------- | -------------------------------------------------- |
| `label` | текст на кнопке | `string` |
| `icon` | класс иконки tabler icon на кнопке | `string` |
| `icon-position` | позиция иконки относительно текста | `left \| right` |
| `iconPosition` | позиция иконки относительно текста | `left \| right` |
| `variant` | вариант отображения кнопки | `primary \| secondary \| tertiary \| text \| link` |
| `severity` | семантическое состояние кнопки | `base \| danger \| warning \| success \| info` |
| `size` | размер кнопки | `small \| base \| large \| xlarge` |
Expand Down
22 changes: 11 additions & 11 deletions docs/components-api/carousel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@

| Свойство | Описание | Типизация |
| ------------------- | -------------------------------------- | ------------------------- |
| `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` |
| `showNav` | кнопки навигации (стрелки) | `boolean` |
| `showIndicators` | индикаторы-точки (пагинация) | `boolean` |
| `navIconLeft` | класс иконки tabler icon кнопки слева | `string` |
| `navIconRight` | класс иконки tabler icon кнопки справа | `string` |
| `navTextLeft` | текст кнопок навигации слева | `string` |
| `navTextRight` | текст кнопок навигации справа | `string` |
| `navVariant` | вариант стиля кнопок навигации | `string` |
| `navSize` | размер кнопок навигации | `small \| base \| large \| xlarge` |
| `navRounded` | скруглённая форма кнопок | `boolean` |
| `navIconPosition` | позиция иконки в кнопках | `left \| right` |

# Слоты (content projection)

Expand All @@ -27,7 +27,7 @@

| Событие | Описание | Типизация |
| -------------- | ------------------------------ | ----------------------------------------- |
| `onPageChange` | срабатывает при смене страницы | `(event: ExtraCarouselPageEvent) => void` |
| `pageChange` | срабатывает при смене страницы | `(event: ExtraCarouselPageEvent) => void` |

# ExtraCarouselPageEvent

Expand Down
6 changes: 3 additions & 3 deletions docs/components-api/checkbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@
| Свойство | Описание | Типизация |
| ---------------- | ----------------------------------------------- | --------------- |
| `label` | текст названия поля | `string` |
| `label-position` | положение лейбла | `right \| left` |
| `labelPosition` | положение лейбла | `left \| right` |
| `caption` | текст пояснения под лейблом | `string` |
| `indeterminate` | возможно ли третье состояние (частично выбрано) | `boolean` |

# События

| Событие | Описание | Типизация |
| ---------- | ----------------------------------- | ------------------------------------------- |
| `onChange` | срабатывает при изменении состояния | `(event: ExtraCheckboxChangeEvent) => void` |
| `change` | срабатывает при изменении состояния | `(event: ExtraCheckboxChangeEvent) => void` |

# ExtraCheckboxChangeEvent

Событие изменения состояния, передаётся в `onChange`.
Событие изменения состояния, передаётся в `change`.

| Свойство | Описание | Типизация |
| --------------- | ------------------ | --------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/components-api/chip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@

| Событие | Описание | Типизация |
| ---------- | ------------------------ | ------------ |
| `onRemove` | срабатывает при удалении | `() => void` |
| `remove` | срабатывает при удалении | `() => void` |
18 changes: 9 additions & 9 deletions docs/components-api/confirmdialog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
| --------------- | --------------------------------------------------- | -------------------------------------- |
| `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` |
| `showHeader` | отображать верхний колонтитул | `boolean` |
| `acceptLabel` | текст кнопки подтверждения | `string` |
| `acceptIcon` | класс иконки tabler icon для подтверждения | `string` |
| `acceptIconPosition` | положение иконки подтверждения | `left \| right` |
| `rejectLabel` | текст кнопки отмены | `string` |
| `rejectIcon` | класс иконки tabler icon для отмены | `string` |
| `rejectIconPosition` | положение иконки отмены | `left \| right` |

# Слоты (content projection)

Expand All @@ -26,5 +26,5 @@

| Событие | Описание | Типизация |
| --------- | -------------------------------- | ---------- |
| `onShow` | срабатывает при открытии окна | `() => void` |
| `onHide` | срабатывает при закрытии окна | `() => void` |
| `show` | срабатывает при открытии окна | `() => void` |
| `hide` | срабатывает при закрытии окна | `() => void` |
Loading