API компонента Calendar
Полное описание API компонента Calendar, включая пропсы, события, слоты и публичные методы/состояния.
Пропсы
Компонент Calendar принимает следующие пропсы:
| Пропс | По умолчанию | Тип | Описание |
|---|---|---|---|
paramsDatePicker | undefined | Partial<IParamsDatePicker> или undefined | Дополнительные параметры для поведения и форматирования выбора дат |
autoFocus | undefined | boolean или undefined | Автоматический фокус на поле ввода при монтировании |
isNotCloseOnDateChange | undefined | boolean или undefined | Предотвращает закрытие календаря при выборе даты |
classDataPicker | undefined | StyleClass или undefined | Пользовательский CSS-класс для элемента выбора даты |
classPicker | undefined | StyleClass или undefined | Пользовательский CSS-класс для элемента календаря |
classDateText | undefined | StyleClass или undefined | Пользовательский CSS-класс для отображаемого текста даты |
paramsFixWindow | undefined | FixWindowProps или undefined | Конфигурация позиционирования окна календаря |
id | undefined | string или undefined | Уникальный идентификатор компонента |
modelValue | undefined | DateValueCalendar или Partial<IRangeValue> | Текущее значение календаря (может быть отдельной датой или диапазоном) |
События
Компонент Calendar генерирует следующие события:
| Событие | Данные | Описание |
|---|---|---|
update:isInvalid | CalendarProps["isInvalid"] | Изменение состояния валидации календаря |
update:modelValue | CalendarProps["modelValue"] | Обновление значения modelValue |
change:modelValue | CalendarProps["modelValue"] | Изменение значения modelValue |
getCalendar | ICalendarPicker | Получение данных календаря |
isActive | boolean | Изменение активного состояния календаря |
Слоты
Компонент Calendar предоставляет следующие слоты:
| Слот | Данные | Описание |
|---|---|---|
default | VNode[] | Основной контент компонента |
before | VNode[] | Контент перед календарем |
after | VNode[] | Контент после календаря |
footerPicker | VNode[] | Пользовательский контент в подвале выбора даты |
Публичные методы
Компонент Calendar предоставляет следующие методы и состояния через ref:
| Метод/Состояние | Значение | Описание |
|---|---|---|
layout | InputLayoutExpose или undefined | Ссылка на состояние разметки поля ввода |
inputLayout | Omit<InputLayoutProps, "value"> | Свойства разметки ввода |
dataPicker | HTMLElement или undefined | Ссылка на HTML-элемент выбора даты |
picker | HTMLElement или undefined | Ссылка на HTML-элемент календаря |
calendarPicker | ICalendarPicker или undefined | Экземпляр календаря |
isFocus | boolean | Фокус на поле ввода календаря? |
isOpenPicker | boolean | Открыт ли календарь? |
datePicker | Partial<IParamsDatePicker> | Параметры выбора даты |
value | CalendarProps["modelValue"] | Текущее значение календаря |
visibleDate | ICalendarPicker["inputValue"] или undefined | Отображаемая дата в календаре |
id | CalendarProps["id"] | Идентификатор компонента |
isValue | boolean | Есть ли выбранное значение? |
autoFocus | CalendarProps["autoFocus"] | Включен ли автофокус? |
isNotCloseOnDateChange | CalendarProps["isNotCloseOnDateChange"] | Остается ли календарь открытым после выбора даты? |
mode | StyleMode | Текущий режим стилизации |
placeholder | IParamsDatePicker["placeholder"] или undefined | Текст-заполнитель для поля ввода |
isLoading | CalendarProps["loading"] | В состоянии загрузки? |
isDisabled | CalendarProps["disabled"] | Отключен? |
isInvalid | CalendarProps["isInvalid"] | Невалидное состояние? |
messageInvalid | CalendarProps["messageInvalid"] | Сообщение об ошибке валидации |
separator | IParamsDatePicker["separator"] или undefined | Разделитель для диапазонов дат |
valueLayout | string | Текущее значение разметки |
paramsFixWindow | CalendarProps["paramsFixWindow"] | Конфигурация позиционирования окна |
classLayout | CalendarProps["class"] | CSS-класс контейнера разметки |
classDataPicker | CalendarProps["classDataPicker"] | CSS-класс элемента выбора даты |
classDateText | CalendarProps["classDateText"] | CSS-класс текста даты |
classPicker | CalendarProps["classPicker"] | CSS-класс элемента календаря |
Методы:
openCalendar(): void- Открывает календарьcloseCalendar(event?: MouseEvent): void- Закрывает календарьchangeDate(date: ICalendarPicker["inputValue"]): void- Изменяет выбранную датуfocus(focus: boolean): void- Управляет состоянием фокусаclearDataPicker(): void- Очищает выбранную дату