diff --git a/docs/components-api/accordion.md b/docs/components-api/accordion.md index e06c4e6e..ee3e4399 100644 --- a/docs/components-api/accordion.md +++ b/docs/components-api/accordion.md @@ -12,8 +12,8 @@ | Событие | Описание | Типизация | | --------- | -------------------------------- | ---------- | -| `onOpen` | срабатывает при раскрытии панели | `() => void` | -| `onClose` | срабатывает при сворачивании панели | `() => void` | +| `open` | срабатывает при раскрытии панели | `() => void` | +| `close` | срабатывает при сворачивании панели | `() => void` | # ExtraAccordionPanel diff --git a/docs/components-api/autocomplete.md b/docs/components-api/autocomplete.md index 5c0ec8ec..a472ec5c 100644 --- a/docs/components-api/autocomplete.md +++ b/docs/components-api/autocomplete.md @@ -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`, варианты выводятся сгруппированно. @@ -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`. | Свойство | Описание | Типизация | | --------------- | ----------------- | --------- | @@ -68,7 +68,7 @@ # ExtraAutoCompleteDropdownClickEvent -Событие клика по кнопке dropdown, передаётся в `onDropdownClick`. +Событие клика по кнопке dropdown, передаётся в `dropdownClick`. | Свойство | Описание | Типизация | | --------------- | ---------------------------------- | --------- | diff --git a/docs/components-api/button.md b/docs/components-api/button.md index c4aec172..0ce680ff 100644 --- a/docs/components-api/button.md +++ b/docs/components-api/button.md @@ -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` | diff --git a/docs/components-api/carousel.md b/docs/components-api/carousel.md index 56aa978b..3a1ad755 100644 --- a/docs/components-api/carousel.md +++ b/docs/components-api/carousel.md @@ -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) @@ -27,7 +27,7 @@ | Событие | Описание | Типизация | | -------------- | ------------------------------ | ----------------------------------------- | -| `onPageChange` | срабатывает при смене страницы | `(event: ExtraCarouselPageEvent) => void` | +| `pageChange` | срабатывает при смене страницы | `(event: ExtraCarouselPageEvent) => void` | # ExtraCarouselPageEvent diff --git a/docs/components-api/checkbox.md b/docs/components-api/checkbox.md index 49b4a048..30237b7b 100644 --- a/docs/components-api/checkbox.md +++ b/docs/components-api/checkbox.md @@ -7,7 +7,7 @@ | Свойство | Описание | Типизация | | ---------------- | ----------------------------------------------- | --------------- | | `label` | текст названия поля | `string` | -| `label-position` | положение лейбла | `right \| left` | +| `labelPosition` | положение лейбла | `left \| right` | | `caption` | текст пояснения под лейблом | `string` | | `indeterminate` | возможно ли третье состояние (частично выбрано) | `boolean` | @@ -15,11 +15,11 @@ | Событие | Описание | Типизация | | ---------- | ----------------------------------- | ------------------------------------------- | -| `onChange` | срабатывает при изменении состояния | `(event: ExtraCheckboxChangeEvent) => void` | +| `change` | срабатывает при изменении состояния | `(event: ExtraCheckboxChangeEvent) => void` | # ExtraCheckboxChangeEvent -Событие изменения состояния, передаётся в `onChange`. +Событие изменения состояния, передаётся в `change`. | Свойство | Описание | Типизация | | --------------- | ------------------ | --------- | diff --git a/docs/components-api/chip.md b/docs/components-api/chip.md index 53a7ba8b..14e5ab1f 100644 --- a/docs/components-api/chip.md +++ b/docs/components-api/chip.md @@ -15,4 +15,4 @@ | Событие | Описание | Типизация | | ---------- | ------------------------ | ------------ | -| `onRemove` | срабатывает при удалении | `() => void` | +| `remove` | срабатывает при удалении | `() => void` | diff --git a/docs/components-api/confirmdialog.md b/docs/components-api/confirmdialog.md index 8ba92a56..f3c49c2b 100644 --- a/docs/components-api/confirmdialog.md +++ b/docs/components-api/confirmdialog.md @@ -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) @@ -26,5 +26,5 @@ | Событие | Описание | Типизация | | --------- | -------------------------------- | ---------- | -| `onShow` | срабатывает при открытии окна | `() => void` | -| `onHide` | срабатывает при закрытии окна | `() => void` | +| `show` | срабатывает при открытии окна | `() => void` | +| `hide` | срабатывает при закрытии окна | `() => void` | diff --git a/docs/components-api/datepicker.md b/docs/components-api/datepicker.md index ff182250..5bf69e93 100644 --- a/docs/components-api/datepicker.md +++ b/docs/components-api/datepicker.md @@ -6,37 +6,37 @@ | ---------------- | ----------------------------------------------------------------------- | -------------------------- | | `placeholder` | текст подсказки внутри поля | `string` | | `label` | текст названия поля | `string` | -| `label-position` | положение лейбла | `default \| float \| left` | +| `labelPosition` | положение лейбла | `left \| top \| float` | | `view` | режим отображения календаря | `day \| month \| year \| time` | -| `selection-mode` | режим выбора даты | `single \| multiple \| range` | -| `show-time` | включить выбор времени (значение времени в поле + timepicker в календаре) | `boolean` | +| `selectionMode` | режим выбора даты | `single \| multiple \| range` | +| `showTime` | включить выбор времени (значение времени в поле + timepicker в календаре) | `boolean` | | `inline` | отображать календарь встроенно, без поля ввода | `boolean` | -| `show-button-bar`| отображать блок с кнопками (Сегодня / Очистить) | `boolean` | +| `showButtonBar` | отображать блок с кнопками (Сегодня / Очистить) | `boolean` | | `clearable` | отображение иконки для очистки поля | `boolean` | -| `date-format` | формат отображения даты | `string` | -| `min-date` | минимальная выбираемая дата | `Date` | -| `max-date` | максимальная выбираемая дата | `Date` | +| `dateFormat` | формат отображения даты | `string` | +| `minDate` | минимальная выбираемая дата | `Date` | +| `maxDate` | максимальная выбираемая дата | `Date` | | `caption` | текст пояснения под полем | `string` | | `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` | -| `size` | размер поля | `sm \| base \| lg \| xlg` | +| `size` | размер поля | `small \| base \| large \| xlarge` | # События | Событие | Описание | Типизация | | ---------------- | ------------------------------------------------- | -------------------------------------------- | -| `onInput` | срабатывает при ручном вводе значения в поле | `(event: Event) => void` | -| `onSelect` | срабатывает при выборе даты в календаре | `(value: Date) => void` | -| `onClear` | срабатывает при очистке значения | `() => void` | -| `onShow` | срабатывает при открытии календаря | `() => void` | -| `onHide` | срабатывает при закрытии календаря | `() => void` | -| `onMonthChange` | срабатывает при смене месяца | `(event: ExtraDatePickerViewChangeEvent) => void` | -| `onYearChange` | срабатывает при смене года | `(event: ExtraDatePickerViewChangeEvent) => void` | -| `onTodayClick` | срабатывает при клике по кнопке «Сегодня» | `(value: Date) => void` | -| `onClearClick` | срабатывает при клике по кнопке «Очистить» | `() => void` | +| `input` | срабатывает при ручном вводе значения в поле | `(event: Event) => void` | +| `select` | срабатывает при выборе даты в календаре | `(value: Date) => void` | +| `clear` | срабатывает при очистке значения | `() => void` | +| `show` | срабатывает при открытии календаря | `() => void` | +| `hide` | срабатывает при закрытии календаря | `() => void` | +| `monthChange` | срабатывает при смене месяца | `(event: ExtraDatePickerViewChangeEvent) => void` | +| `yearChange` | срабатывает при смене года | `(event: ExtraDatePickerViewChangeEvent) => void` | +| `todayClick` | срабатывает при клике по кнопке «Сегодня» | `(value: Date) => void` | +| `clearClick` | срабатывает при клике по кнопке «Очистить» | `() => void` | # ExtraDatePickerViewChangeEvent -Событие смены месяца/года, передаётся в `onMonthChange` и `onYearChange`. +Событие смены месяца/года, передаётся в `monthChange` и `yearChange`. | Свойство | Описание | Типизация | | -------- | --------------- | --------- | diff --git a/docs/components-api/dialog.md b/docs/components-api/dialog.md index 73e3dfd2..1ed0f295 100644 --- a/docs/components-api/dialog.md +++ b/docs/components-api/dialog.md @@ -8,16 +8,16 @@ | Свойство | Описание | Типизация | | ------------------ | -------------------------------------------- | ---------------------------- | -| `show-overlay` | отображать маску (overlay) поверх интерфейса | `boolean` | -| `show-maximize` | кнопка разворота окна на весь экран | `boolean` | -| `show-close` | кнопка закрытия окна | `boolean` | -| `header` | заголовок окна (строкой) | `string` | -| `visible` | видимость окна | `boolean` | -| `size` | размер окна | `sm \| default \| lg \| xlg` | -| `dismissable-mask` | закрывать окно при клике на маску | `boolean` | -| `close-on-escape` | закрывать окно по нажатию Escape | `boolean` | -| `focus-on-show` | фокус на первый элемент при открытии | `boolean` | -| `append-to` | элемент, к которому монтируется окно | `string` | +| `showOverlay` | отображать маску (overlay) поверх интерфейса | `boolean` | +| `showMaximize` | кнопка разворота окна на весь экран | `boolean` | +| `showClose` | кнопка закрытия окна | `boolean` | +| `header` | заголовок окна (строкой) | `string` | +| `visible` | видимость окна | `boolean` | +| `size` | размер окна | `small \| base \| large \| xlarge` | +| `dismissableMask` | закрывать окно при клике на маску | `boolean` | +| `closeOnEscape` | закрывать окно по нажатию Escape | `boolean` | +| `focusOnShow` | фокус на первый элемент при открытии | `boolean` | +| `appendTo` | элемент, к которому монтируется окно | `string` | # Слоты (content projection) @@ -31,6 +31,6 @@ | Событие | Описание | Типизация | | ------------ | -------------------------------------- | ------------ | -| `onShow` | срабатывает при открытии окна | `() => void` | -| `onHide` | срабатывает при закрытии окна | `() => void` | -| `onMaximize` | срабатывает при развороте/сворачивании | `() => void` | +| `show` | срабатывает при открытии окна | `() => void` | +| `hide` | срабатывает при закрытии окна | `() => void` | +| `maximize` | срабатывает при развороте/сворачивании | `() => void` | diff --git a/docs/components-api/drawer.md b/docs/components-api/drawer.md index d3a583ad..865558a7 100644 --- a/docs/components-api/drawer.md +++ b/docs/components-api/drawer.md @@ -8,8 +8,8 @@ | -------------- | ---------------------------------------------- | ---------------------------- | | `modal` | отображать маску (overlay) поверх интерфейса | `boolean` | | `position` | расположение панели | `left \| right \| top \| bottom` | -| `show-header` | отображать верхний колонтитул (шапку можно скрыть) | `boolean` | -| `show-back` | кнопка «Назад» в шапке | `boolean` | +| `showHeader` | отображать верхний колонтитул (шапку можно скрыть) | `boolean` | +| `showBack` | кнопка «Назад» в шапке | `boolean` | # Слоты (content projection) @@ -23,5 +23,5 @@ | Событие | Описание | Типизация | | -------- | --------------------------------- | ---------- | -| `onShow` | срабатывает при открытии панели | `() => void` | -| `onHide` | срабатывает при закрытии панели | `() => void` | +| `show` | срабатывает при открытии панели | `() => void` | +| `hide` | срабатывает при закрытии панели | `() => void` | diff --git a/docs/components-api/fileupload.md b/docs/components-api/fileupload.md index 5af65085..94af8d28 100644 --- a/docs/components-api/fileupload.md +++ b/docs/components-api/fileupload.md @@ -21,11 +21,11 @@ | Событие | Описание | Типизация | | --------------- | ---------------------------------------------------- | ----------------------------------------- | -| `onSelect` | срабатывает при выборе файлов | `(event: FileSelectEvent) => void` | -| `onRemove` | срабатывает при удалении файла из списка | `(event: FileRemoveEvent) => void` | -| `onClear` | срабатывает при очистке всего списка | `() => void` | -| `onUpload` | срабатывает при отправке файлов (кастомная загрузка) | `(event: FileUploadHandlerEvent) => void` | -| `onError` | срабатывает при ошибке загрузки | `(event: FileUploadErrorEvent) => void` | +| `select` | срабатывает при выборе файлов | `(event: FileSelectEvent) => void` | +| `remove` | срабатывает при удалении файла из списка | `(event: FileRemoveEvent) => void` | +| `clear` | срабатывает при очистке всего списка | `() => void` | +| `upload` | срабатывает при отправке файлов (кастомная загрузка) | `(event: FileUploadHandlerEvent) => void` | +| `error` | срабатывает при ошибке загрузки | `(event: FileUploadErrorEvent) => void` | ## Вложенные компоненты (делегирование) @@ -36,7 +36,7 @@ | ------------------------------ | ------------------ | --------------------------------- | -------------------------------------------------- | | `` (статус файла) | `ExtraBadge` | [badge.md](./badge.md) | внутренне, `severity`/`value` из статуса файла ⚠️ | | `` (ошибки / успех) | `ExtraMessage` | [message.md](./message.md) | внутренне, текст из `messages`, severity из состояния | -| `` (загрузка) | `ExtraProgressBar` | [progressbar.md](./progressbar.md)| внутренне, `value` из прогресса, `show-value` off | +| `` (загрузка) | `ExtraProgressBar` | [progressbar.md](./progressbar.md)| внутренне, `value` из прогресса, `showValue` off | | `` | `ExtraButton` | ❗ нет `button.md` | внутренне, фикс. конфиг; тексты через `labels` | ## Типы @@ -70,7 +70,7 @@ interface UploadFile { ## FileSelectEvent -Событие выбора файлов, передаётся в `onSelect`. +Событие выбора файлов, передаётся в `select`. | Свойство | Описание | Типизация | | --------------- | ------------------------------ | --------- | @@ -80,7 +80,7 @@ interface UploadFile { ## FileRemoveEvent -Событие удаления файла, передаётся в `onRemove`. +Событие удаления файла, передаётся в `remove`. | Свойство | Описание | Типизация | | --------------- | --------------------------- | --------- | @@ -89,7 +89,7 @@ interface UploadFile { ## FileUploadHandlerEvent -Событие отправки файлов в режиме кастомной загрузки, передаётся в `onUpload`. +Событие отправки файлов в режиме кастомной загрузки, передаётся в `upload`. | Свойство | Описание | Типизация | | -------- | ----------------------- | --------- | @@ -97,7 +97,7 @@ interface UploadFile { ## FileUploadErrorEvent -Событие ошибки загрузки, передаётся в `onError`. +Событие ошибки загрузки, передаётся в `error`. | Свойство | Описание | Типизация | | -------- | ----------------------- | ------------ | diff --git a/docs/components-api/galleria.md b/docs/components-api/galleria.md index dcb172c7..26028927 100644 --- a/docs/components-api/galleria.md +++ b/docs/components-api/galleria.md @@ -8,14 +8,14 @@ | ----------------- | --------------------------------------------- | --------------------- | | `value` | массив изображений | `ExtraGalleriaItem[]` | | `mask` | полноэкранный режим (маска поверх интерфейса) | `boolean` | -| `show-nav` | стрелки навигации | `boolean` | -| `show-indicators` | точки-индикаторы (пагинация) | `boolean` | +| `showNav` | стрелки навигации | `boolean` | +| `showIndicators` | точки-индикаторы (пагинация) | `boolean` | # События | Событие | Описание | Типизация | | --------------------- | --------------------------------- | ------------------------- | -| `onActiveIndexChange` | срабатывает при смене изображения | `(index: number) => void` | +| `activeIndexChange` | срабатывает при смене изображения | `(index: number) => void` | # ExtraGalleriaItem diff --git a/docs/components-api/inputgroup.md b/docs/components-api/inputgroup.md index 2c23fded..6f81f375 100644 --- a/docs/components-api/inputgroup.md +++ b/docs/components-api/inputgroup.md @@ -6,7 +6,7 @@ | Свойство | Описание | Типизация | | ---------------- | ------------------------------------------ | ----------------------- | -| `addon-position` | расположение аддона(ов) относительно поля | `left \| right \| both` | +| `addonPosition` | расположение аддона(ов) относительно поля | `left \| right \| both` | # ExtraInputGroupAddon diff --git a/docs/components-api/inputmask.md b/docs/components-api/inputmask.md index a370b7df..dc1ddc59 100644 --- a/docs/components-api/inputmask.md +++ b/docs/components-api/inputmask.md @@ -6,20 +6,20 @@ | ---------------- | ----------------------------------------------------------------------- | -------------------------- | | `placeholder` | текст подсказки внутри поля | `string` | | `label` | текст названия поля | `string` | -| `label-position` | положение лейбла | `default \| float \| left` | +| `labelPosition` | положение лейбла | `left \| top \| float` | | `mask` | маска ввода (`9` — цифра, `a` — буква, `*` — цифра или буква) | `string` | -| `slot-char` | символ-заполнитель маски | `string` | +| `slotChar` | символ-заполнитель маски | `string` | | `unmask` | возвращать значение без маски (raw), а не отформатированное | `boolean` | -| `auto-clear` | очищать поле при неполном вводе (на blur) | `boolean` | +| `autoClear` | очищать поле при неполном вводе (на blur) | `boolean` | | `clearable` | отображение иконки для очистки поля | `boolean` | | `caption` | текст пояснения под полем | `string` | | `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` | -| `size` | размер поля | `sm \| base \| lg \| xlg` | +| `size` | размер поля | `small \| base \| large \| xlarge` | # События | Событие | Описание | Типизация | | ------------ | ------------------------------------- | ------------------- | -| `onComplete` | срабатывает при полном заполнении маски | `() => void` | -| `onInput` | срабатывает при вводе значения | `(event: Event) => void` | -| `onClear` | срабатывает при очистке значения | `() => void` | +| `complete` | срабатывает при полном заполнении маски | `() => void` | +| `input` | срабатывает при вводе значения | `(event: Event) => void` | +| `clear` | срабатывает при очистке значения | `() => void` | diff --git a/docs/components-api/inputnumber.md b/docs/components-api/inputnumber.md index 16354ddc..aa7f4062 100644 --- a/docs/components-api/inputnumber.md +++ b/docs/components-api/inputnumber.md @@ -6,8 +6,8 @@ | ---------------- | ---------------------------------------------------------------------------------------------- | -------------------------- | | `placeholder` | текст подсказки внутри поля | `string` | | `label` | текст названия поля | `string` | -| `label-position` | положение лейбла | `default \| float \| left` | -| `buttons` | отображение кнопок для увеличения/уменьшения значения (недоступно при `label-position: float`) | `boolean` | +| `labelPosition` | положение лейбла | `left \| top \| float` | +| `buttons` | отображение кнопок для увеличения/уменьшения значения (недоступно при `labelPosition: float`) | `boolean` | | `min` | минимальное допустимое значение | `number` | | `max` | максимальное допустимое значение | `number` | | `step` | шаг изменения значения (кнопками `buttons`) | `number` | @@ -16,18 +16,18 @@ | `clearable` | отображение иконки для очистки поля | `boolean` | | `caption` | текст пояснения под полем | `string` | | `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` | -| `size` | размер поля | `sm \| base \| lg \| xlg` | +| `size` | размер поля | `small \| base \| large \| xlarge` | # События | Событие | Описание | Типизация | | --------- | ---------------------------------- | ------------------------------------------ | -| `onInput` | срабатывает при вводе значения | `(event: ExtraInputNumberInputEvent) => void` | -| `onClear` | срабатывает при очистке значения | `() => void` | +| `input` | срабатывает при вводе значения | `(event: ExtraInputNumberInputEvent) => void` | +| `clear` | срабатывает при очистке значения | `() => void` | # ExtraInputNumberInputEvent -Событие ввода значения, передаётся в `onInput`. +Событие ввода значения, передаётся в `input`. | Свойство | Описание | Типизация | | ---------------- | ---------------------- | ---------------- | diff --git a/docs/components-api/inputotp.md b/docs/components-api/inputotp.md index bceec645..c954dbbf 100644 --- a/docs/components-api/inputotp.md +++ b/docs/components-api/inputotp.md @@ -8,17 +8,17 @@ | -------------- | ---------------------------------------- | --------- | | `length` | количество полей ввода | `number` | | `mask` | скрывать введённое значение (как пароль) | `boolean` | -| `integer-only` | допускать только цифры | `boolean` | +| `integerOnly` | допускать только цифры | `boolean` | # События | Событие | Описание | Типизация | | ---------- | ------------------------------ | ------------------------------------------- | -| `onChange` | срабатывает при изменении кода | `(event: ExtraInputOtpChangeEvent) => void` | +| `change` | срабатывает при изменении кода | `(event: ExtraInputOtpChangeEvent) => void` | # ExtraInputOtpChangeEvent -Событие изменения кода, передаётся в `onChange`. +Событие изменения кода, передаётся в `change`. | Свойство | Описание | Типизация | | --------------- | ---------------- | --------- | diff --git a/docs/components-api/inputtext.md b/docs/components-api/inputtext.md index 99035a5f..3d5ec70f 100644 --- a/docs/components-api/inputtext.md +++ b/docs/components-api/inputtext.md @@ -8,9 +8,9 @@ | ---------------- | ----------------------------------------------------------------------- | -------------------------- | | `placeholder` | текст подсказки внутри поля | `string` | | `label` | текст названия поля | `string` | -| `label-position` | положение лейбла | `default \| float \| left` | +| `labelPosition` | положение лейбла | `left \| top \| float` | | `clearable` | отображение иконки для очистки поля | `boolean` | | `caption` | текст пояснения под полем | `string` | | `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` | -| `size` | размер поля | `sm \| base \| lg \| xlg` | +| `size` | размер поля | `small \| base \| large \| xlarge` | | `type` | тип поля input | `text \| password` | diff --git a/docs/components-api/listbox.md b/docs/components-api/listbox.md index 51f98e66..baaa4a9a 100644 --- a/docs/components-api/listbox.md +++ b/docs/components-api/listbox.md @@ -7,18 +7,18 @@ | `options` | список элементов или список групп с элементами | `ExtraListboxGroup[] \| ExtraListboxOption[] \| any[]` | | `optionLabel` | наименование поля, содержащего отображаемое значение | `string` | | `multiple` | множественный выбор (элементы с чекбоксами) | `boolean` | -| `show-filter` | отображать поле поиска элементов | `boolean` | -| `filter-placeholder`| текст подсказки в поле поиска | `string` | -| `show-checkbox` | отображать чекбоксы у элементов и «выбрать всё» | `boolean` | -| `empty-message` | сообщение при отсутствии элементов | `string` | +| `showFilter` | отображать поле поиска элементов | `boolean` | +| `filterPlaceholder` | текст подсказки в поле поиска | `string` | +| `showCheckbox` | отображать чекбоксы у элементов и «выбрать всё» | `boolean` | +| `emptyMessage` | сообщение при отсутствии элементов | `string` | # События | Событие | Описание | Типизация | | ----------------- | ----------------------------------------- | ----------------------------------------------- | -| `onChange` | срабатывает при изменении выбора | `(event: ExtraListboxChangeEvent) => void` | -| `onFilter` | срабатывает при фильтрации | `(event: ExtraListboxFilterEvent) => void` | -| `onSelectAllChange` | срабатывает при переключении «выбрать всё» | `(event: ExtraListboxSelectAllChangeEvent) => void` | +| `change` | срабатывает при изменении выбора | `(event: ExtraListboxChangeEvent) => void` | +| `filter` | срабатывает при фильтрации | `(event: ExtraListboxFilterEvent) => void` | +| `selectAll` | срабатывает при переключении «выбрать всё» | `(event: ExtraListboxSelectAllChangeEvent) => void` | # ExtraListboxChangeEvent diff --git a/docs/components-api/menu.md b/docs/components-api/menu.md index d08cfc48..3aa920b6 100644 --- a/docs/components-api/menu.md +++ b/docs/components-api/menu.md @@ -18,9 +18,9 @@ | Событие | Описание | Типизация | | --- | --- | --- | -| `onItemSelect` | выбран пункт меню | `(event: MenuItemSelectEvent) => void` | -| `onShow` | срабатывает при открытии всплывающего меню | `() => void` | -| `onHide` | срабатывает при закрытии всплывающего меню | `() => void` | +| `itemSelect` | выбран пункт меню | `(event: MenuItemSelectEvent) => void` | +| `show` | срабатывает при открытии всплывающего меню | `() => void` | +| `hide` | срабатывает при закрытии всплывающего меню | `() => void` | ## Методы diff --git a/docs/components-api/message.md b/docs/components-api/message.md index 6bc3e1c9..2194ed98 100644 --- a/docs/components-api/message.md +++ b/docs/components-api/message.md @@ -13,7 +13,7 @@ | `message` | заголовок сообщения | `string` | | `caption` | пояснение сообщения | `string` | | `icon` | класс иконки tabler icon (вместо стандартной для `severity`). значение `null` скрывает иконку | `string \| null` | -| `show-close` | кнопка закрытия | `boolean` | +| `showClose` | кнопка закрытия | `boolean` | # Слоты (content projection) @@ -26,4 +26,4 @@ | Событие | Описание | Типизация | | --------- | ---------------------------------- | ------------ | -| `onClose` | срабатывает при закрытии сообщения | `() => void` | +| `close` | срабатывает при закрытии сообщения | `() => void` | diff --git a/docs/components-api/metergroup.md b/docs/components-api/metergroup.md index 43ed02df..af6384cb 100644 --- a/docs/components-api/metergroup.md +++ b/docs/components-api/metergroup.md @@ -8,8 +8,8 @@ | ------------------- | ------------------------ | ------------------------ | | `value` | массив измерителей | `ExtraMeterItem[]` | | `orientation` | ориентация компонента | `horizontal \| vertical` | -| `label-position` | расположение легенды | `start \| end` | -| `label-orientation` | ориентация легенды | `horizontal \| vertical` | +| `labelPosition` | расположение легенды | `start \| end` | +| `labelOrientation` | ориентация легенды | `horizontal \| vertical` | # ExtraMeterItem diff --git a/docs/components-api/multiselect.md b/docs/components-api/multiselect.md index f0da9b82..5a0bee72 100644 --- a/docs/components-api/multiselect.md +++ b/docs/components-api/multiselect.md @@ -6,19 +6,19 @@ | -------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------- | | `placeholder` | текст подсказки внутри поля | `string` | | `label` | текст названия поля | `string` | -| `label-position` | положение лейбла | `default \| float \| left` | -| `chip` | отображать выбранные значения в виде chips | `boolean` | -| `chip-icon` | класс иконки tabler icon для элементов при отображении chips | `string` | -| `chip-clearable` | отображение иконки удаления chip | `boolean` | +| `labelPosition` | положение лейбла | `left \| top \| float` | +| `showChips` | отображать выбранные значения в виде chips | `boolean` | +| `chipIcon` | класс иконки tabler icon для элементов при отображении chips | `string` | +| `chipClearable` | отображение иконки удаления chip | `boolean` | | `clearable` | отображение иконки для очистки поля | `boolean` | -| `show-checkbox` | отображать чекбокс у option | `boolean` | -| `show-filter` | отображать фильтр в оверлее | `boolean` | -| `filter-placeholder` | текст подсказки в фильтре | `string` | +| `showCheckbox` | отображать чекбокс у option | `boolean` | +| `showFilter` | отображать фильтр в оверлее | `boolean` | +| `filterPlaceholder` | текст подсказки в фильтре | `string` | | `options` | список элементов или список групп с элементами | `ExtraMultiselectGroup[] \| ExtraMultiselectOption[] \| any[]` | | `optionLabel` | наименование поля, содержащего отображаемое значение | `string` | | `caption` | текст пояснения под полем | `string` | | `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` | -| `size` | размер поля | `sm \| base \| lg \| xlg` | +| `size` | размер поля | `small \| base \| large \| xlarge` | # ExtraMultiselectOption @@ -38,16 +38,16 @@ | Событие | Описание | Типизация | | ---------- | ------------------------------------- | ----------------------------------------------- | -| `onChange` | срабатывает при изменении выбора | `(event: ExtraMultiSelectChangeEvent) => void` | -| `onFilter` | срабатывает при фильтрации | `(event: ExtraMultiSelectFilterEvent) => void` | -| `onClear` | срабатывает при очистке всех значений | `() => void` | -| `onShow` | срабатывает при открытии панели | `() => void` | -| `onHide` | срабатывает при закрытии панели | `() => void` | -| `onRemove` | срабатывает при удалении значения | `(event: ExtraMultiSelectRemoveEvent) => void` | +| `change` | срабатывает при изменении выбора | `(event: ExtraMultiSelectChangeEvent) => void` | +| `filter` | срабатывает при фильтрации | `(event: ExtraMultiSelectFilterEvent) => void` | +| `clear` | срабатывает при очистке всех значений | `() => void` | +| `show` | срабатывает при открытии панели | `() => void` | +| `hide` | срабатывает при закрытии панели | `() => void` | +| `remove` | срабатывает при удалении значения | `(event: ExtraMultiSelectRemoveEvent) => void` | # ExtraMultiSelectChangeEvent -Событие изменения выбора, передаётся в `onChange`. +Событие изменения выбора, передаётся в `change`. | Свойство | Описание | Типизация | | --------------- | ------------------ | --------- | @@ -56,7 +56,7 @@ # ExtraMultiSelectFilterEvent -Событие фильтрации, передаётся в `onFilter`. +Событие фильтрации, передаётся в `filter`. | Свойство | Описание | Типизация | | --------------- | ---------------------- | --------- | @@ -65,7 +65,7 @@ # ExtraMultiSelectRemoveEvent -Событие удаления значения, передаётся в `onRemove`. +Событие удаления значения, передаётся в `remove`. | Свойство | Описание | Типизация | | --------- | ----------------------- | --------- | diff --git a/docs/components-api/paginator.md b/docs/components-api/paginator.md index 9c99fde4..704d5fb2 100644 --- a/docs/components-api/paginator.md +++ b/docs/components-api/paginator.md @@ -6,23 +6,23 @@ | Свойство | Описание | Типизация | | -------------------------- | --------------------------------------------------- | ---------- | -| `rows` | количество элементов на странице | `number` | -| `total-records` | общее количество записей | `number` | -| `first` | индекс первой записи (0-based) | `number` | -| `rows-per-page-options` | варианты количества элементов на странице | `number[]` | -| `show-jump-to-page` | поле для перехода к конкретной странице | `boolean` | -| `show-jump-to-page-reset` | отображать иконку очистки поля выбора страницы | `boolean` | -| `jump-to-page-placeholder` | плэйсхолдер поля выбора страницы | `boolean` | -| `show-dropdown` | селект для перехода к конкретной странице | `boolean` | -| `show-dropdown-reset` | отображать иконку очистки дропдауна выбора страницы | `boolean` | -| `dropdown-placeholder` | плэйсхолдер дропдауна выбора страницы | `string` | -| `show-buttons` | отображение "стрелок" перевлючения страницы | `boolean` | +| `rows` | количество элементов на странице | `number` | +| `totalRecords` | общее количество записей | `number` | +| `first` | индекс первой записи (0-based) | `number` | +| `rowsPerPageOptions` | варианты количества элементов на странице | `number[]` | +| `showJumpToPage` | поле для перехода к конкретной странице | `boolean` | +| `showJumpToPageReset` | отображать иконку очистки поля выбора страницы | `boolean` | +| `jumpToPagePlaceholder` | плэйсхолдер поля выбора страницы | `string` | +| `showDropdown` | селект для перехода к конкретной странице | `boolean` | +| `showDropdownReset` | отображать иконку очистки дропдауна выбора страницы | `boolean` | +| `dropdownPlaceholder` | плэйсхолдер дропдауна выбора страницы | `string` | +| `showButtons` | отображение "стрелок" перевлючения страницы | `boolean` | # События | Событие | Описание | Типизация | | -------------- | ------------------------------ | -------------------------------------- | -| `onPageChange` | срабатывает при смене страницы | `(event: ExtraPaginatorState) => void` | +| `pageChange` | срабатывает при смене страницы | `(event: ExtraPaginatorState) => void` | # ExtraPaginatorState @@ -31,4 +31,4 @@ | `page` | текущая страница (0-based) | `number` | | `first` | индекс первой записи | `number` | | `rows` | элементов на странице | `number` | -| `page-count` | всего страниц | `number` | +| `pageCount` | всего страниц | `number` | diff --git a/docs/components-api/password.md b/docs/components-api/password.md index 2d7408c0..d9df9a92 100644 --- a/docs/components-api/password.md +++ b/docs/components-api/password.md @@ -6,9 +6,9 @@ | ---------------- | ----------------------------------------------------------------------- | -------------------------- | | `placeholder` | текст подсказки внутри поля | `string` | | `label` | текст названия поля | `string` | -| `label-position` | положение лейбла | `default \| float \| left` | -| `toggle-mask` | отображать иконку для переключения видимости пароля | `boolean` | +| `labelPosition` | положение лейбла | `left \| top \| float` | +| `toggleMask` | отображать иконку для переключения видимости пароля | `boolean` | | `feedback` | отображать панель с индикатором сложности и подсказками | `boolean` | | `caption` | текст пояснения под полем | `string` | | `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` | -| `size` | размер поля | `sm \| base \| lg \| xlg` | +| `size` | размер поля | `small \| base \| large \| xlarge` | diff --git a/docs/components-api/popover.md b/docs/components-api/popover.md index dd1c66a6..f6de8f00 100644 --- a/docs/components-api/popover.md +++ b/docs/components-api/popover.md @@ -6,12 +6,12 @@ | Свойство | Описание | Типизация | | --------------- | ------------------------------------------- | ------------------------------- | -| `show-close` | кнопка закрытия | `boolean` | -| `append-to` | куда крепить оверлей (`'body'` или элемент) | `HTMLElement \| 'body' \| null` | -| `auto-z-index` | автоматическое управление z-index | `boolean` | -| `base-z-index` | базовое значение z-index | `number` | +| `showClose` | кнопка закрытия | `boolean` | +| `appendTo` | куда крепить оверлей (`'body'` или элемент) | `HTMLElement \| 'body' \| null` | +| `autoZIndex` | автоматическое управление z-index | `boolean` | +| `baseZIndex` | базовое значение z-index | `number` | | `dismissable` | закрывать по клику вне панели | `boolean` | -| `focus-on-show` | переводить фокус на панель при открытии | `boolean` | +| `focusOnShow` | переводить фокус на панель при открытии | `boolean` | # Слоты (content projection) @@ -23,5 +23,5 @@ | Событие | Описание | Типизация | | -------- | ------------------------ | ------------ | -| `onShow` | срабатывает при открытии | `() => void` | -| `onHide` | срабатывает при закрытии | `() => void` | +| `show` | срабатывает при открытии | `() => void` | +| `hide` | срабатывает при закрытии | `() => void` | diff --git a/docs/components-api/progressbar.md b/docs/components-api/progressbar.md index 861f2b09..fa93ca40 100644 --- a/docs/components-api/progressbar.md +++ b/docs/components-api/progressbar.md @@ -7,4 +7,4 @@ | Свойство | Описание | Типизация | | ------------- | --------------------------------- | ---------- | | `value` | значение прогресса (0–100) | `number` | -| `show-value` | отображать значение прогресса | `boolean` | +| `showValue` | отображать значение прогресса | `boolean` | diff --git a/docs/components-api/progressspinner.md b/docs/components-api/progressspinner.md index 2d201fa8..ce258fe2 100644 --- a/docs/components-api/progressspinner.md +++ b/docs/components-api/progressspinner.md @@ -6,5 +6,5 @@ | Свойство | Описание | Типизация | | -------- | -------- | ---------------------- | -| `size` | размер | `sm \| md \| lg \| xl` | +| `size` | размер | `small \| base \| large \| xlarge` | | `fill` | цвет | `primary \| white` | diff --git a/docs/components-api/radiobutton.md b/docs/components-api/radiobutton.md index d5ae7740..e67b041b 100644 --- a/docs/components-api/radiobutton.md +++ b/docs/components-api/radiobutton.md @@ -5,7 +5,7 @@ | Свойство | Описание | Типизация | | ---------------- | --------------------------------- | ------------------ | | `label` | текст названия | `string` | -| `label-position` | положение лейбла | `default \| left` | +| `labelPosition` | положение лейбла | `left \| right` | | `caption` | текст пояснения под лейблом | `string` | | `value` | значение опции | `any` | @@ -13,7 +13,7 @@ | Событие | Описание | Типизация | | ---------- | ----------------------------- | ---------------------------------------------- | -| `onClick` | срабатывает при выборе опции | `(event: ExtraRadioButtonClickEvent) => void` | +| `click` | срабатывает при выборе опции | `(event: ExtraRadioButtonClickEvent) => void` | # ExtraRadioButtonClickEvent diff --git a/docs/components-api/rating.md b/docs/components-api/rating.md index e7630411..1d0b245f 100644 --- a/docs/components-api/rating.md +++ b/docs/components-api/rating.md @@ -12,7 +12,7 @@ | Событие | Описание | Типизация | | -------- | ----------------------------------- | ---------------------------------------- | -| `onRate` | срабатывает при выставлении оценки | `(event: ExtraRatingRateEvent) => void` | +| `rate` | срабатывает при выставлении оценки | `(event: ExtraRatingRateEvent) => void` | # ExtraRatingRateEvent diff --git a/docs/components-api/select.md b/docs/components-api/select.md index 874233a6..3ffb7c0b 100644 --- a/docs/components-api/select.md +++ b/docs/components-api/select.md @@ -2,29 +2,46 @@ # ExtraSelect +> ✅ **Реализован**: `ExtraSelectComponent` (`@cdek-it/angular-ui-kit`) соответствует спецификации. + Single-select: выбор одного значения из списка. У опций нет чекбоксов (множественный выбор с чекбоксами — это `ExtraMultiSelect`). -| Свойство | Описание | Типизация | -| ---------------- | ----------------------------------------------------------------------- | ---------------------------------------------------- | -| `placeholder` | текст подсказки внутри поля | `string` | -| `label` | текст названия поля | `string` | -| `label-position` | положение лейбла | `default \| float \| left` | -| `options` | список элементов или список групп с элементами | `ExtraSelectGroup[] \| ExtraSelectOption[] \| any[]` | -| `optionLabel` | наименование поля, содержащего отображаемое значение | `string` | -| `clearable` | отображение иконки для очистки поля | `boolean` | -| `show-checkbox` | отображать отметку выбранного option | `boolean` | -| `caption` | текст пояснения под полем | `string` | -| `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` | -| `size` | размер поля | `sm \| base \| lg \| xlg` | +| Свойство | Описание | Типизация | +| --------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------- | +| `placeholder` | текст подсказки внутри поля | `string` | +| `label` | текст названия поля | `string` | +| `labelPosition` | положение лейбла | `left \| top \| float` | +| `options` | список элементов или список групп с элементами | `ExtraSelectGroup[] \| ExtraSelectOption[] \| any[]` | +| `optionLabel` | наименование поля, содержащего отображаемое значение | `string` | +| `optionValue` | наименование поля, значение которого используется как значение модели | `string` | +| `optionDisabled` | наименование булева поля опции, отключающего её выбор | `string` | +| `group` | включает группировку опций (данные — `ExtraSelectGroup[]`) | `boolean` | +| `clearable` | отображение иконки для очистки поля | `boolean` | +| `showCheckbox` | отображать отметку выбранного option | `boolean` | +| `showFilter` | показывает строку поиска в выпадающем списке | `boolean` | +| `editable` | разрешает ручной ввод произвольного значения в поле | `boolean` | +| `readonly` | только для чтения | `boolean` | +| `loading` | состояние загрузки опций | `boolean` | +| `caption` | текст пояснения под полем | `string` | +| `info` | текст с доп. информацией (показывается в тултипе иконки ti-info-circle) | `string` | +| `size` | размер поля | `small \| base \| large \| xlarge` | +| `emptyMessage` | сообщение при пустом списке опций | `string` | +| `emptyFilterMessage` | сообщение при отсутствии результатов фильтрации | `string` | +| `inputId` | `id` нативного инпута — для связи с внешним `