FixWindow API
Эта страница предоставляет обзор API компонента FixWindow, детализируя его props, emits, слоты и exposed методы/состояния.
Props
Компонент FixWindow принимает следующие props:
| Prop | Default | Type | Description |
|---|---|---|---|
modelValue | undefined | boolean или undefined | Управляет видимостью фиксированного окна. |
el | undefined | RefLink или undefined | Целевой элемент для фиксированного окна. |
scrollableEl | undefined | RefLink или undefined | Прокручиваемый элемент, влияющий на позицию фиксированного окна. |
typePosition | "fixed" | "absolute" или"fixed" илиundefined | Стиль CSS позиционирования для фиксированного окна. |
position | "top" | Position илиundefined | Позиция фиксированного окна относительно целевого элемента. |
class | "" | StyleClass или undefined | Пользовательский CSS класс для контейнера фиксированного окна. |
classBody | "" | StyleClass или undefined | Пользовательский CSS класс для тела фиксированного окна. |
mode | "filled" | StyleMode или undefined | Режим стилизации для фиксированного окна. |
eventOpen | "hover" | FixWindowEvent или undefined | Событие, которое вызывает открытие фиксированного окна. |
eventClose | "hover" | FixWindowEvent или undefined | Событие, которое вызывает закрытие фиксированного окна. |
delay | 0 | number или 100 или number или undefined | Задержка перед открытием фиксированного окна (в миллисекундах). |
marginPx | 10 | number или 2 или 5 или number или undefined | Отступ между фиксированным окном и целевым элементом (в пикселях). |
translatePx | 0 | number или 2 или 5 или number или undefined | Смещение в пикселях для точной настройки позиции фиксированного окна. |
paddingWindow | 0 | number или 2 или 5 или number или undefined | Отступ для границ фиксированного окна. |
byCursor | false | boolean или undefined | Позиционирует фиксированное окно на основе положения курсора. |
closeButton | false | boolean или undefined | Включает кнопку закрытия для фиксированного окна. |
stopOpenPropagation | false | boolean или undefined | Предотвращает распространение события при открытии фиксированного окна. |
Слоты
Компонент FixWindow предоставляет следующие слоты:
| Слот | Payload | Описание |
|---|---|---|
default | VNode[] | Основное содержимое фиксированного окна. |
Emits
Компонент FixWindow испускает следующие события:
| Событие | Payload | Описание |
|---|---|---|
update:modelValue | boolean | Испускается при обновлении modelValue, указывая состояние видимости фиксированного окна. |
open | MouseEvent или undefined | Испускается при открытии фиксированного окна. |
close | MouseEvent или undefined | Испускается при закрытии фиксированного окна. |
Expose
Компонент FixWindow предоставляет следующие методы и состояния через ref:
| Expose | Тип | Описание |
|---|---|---|
x | string | Текущая позиция x-координаты фиксированного окна. |
y | string | Текущая позиция y-координаты фиксированного окна. |
isOpen | boolean | Указывает, открыто ли фиксированное окно. |
position | Position | Текущая позиция фиксированного окна. |
delay | number | Текущая задержка перед открытием фиксированного окна. |
marginPx | number | Текущий отступ между фиксированным окном и целевым элементом. |
isCloseButton | boolean | Указывает, включена ли кнопка закрытия. |
eventOpen | FixWindowEvent | Тип события для открытия фиксированного окна. |
eventClose | FixWindowEvent | Тип события для закрытия фиксированного окна. |
element | HTMLElement | Целевой HTML элемент для фиксированного окна. |
open | () => void | Открывает фиксированное окно. |
close | () => void | Закрывает фиксированное окно. |
updatePosition | () => void | Динамически обновляет позицию фиксированного окна. |
Типы
FixWindowEvent
Тип FixWindowEvent определяет возможные события, которые могут вызвать открытие или закрытие фиксированного окна:
| Значение | Описание |
|---|---|
"hover" | Вызывается при наведении мыши на целевой элемент. |
"click" | Вызывается при клике на целевой элемент. |
"mousedown" | Вызывается при нажатии кнопки мыши. |
"mouseup" | Вызывается при отпускании кнопки мыши. |
"dblclick" | Вызывается при двойном клике на целевой элемент. |
"contextmenu" | Вызывается при открытии контекстного меню (правый клик). |
"none" | Никакое событие не вызывает действие. |
StyleMode
Режимы стилизации, доступные для фиксированного окна:
| Значение | Описание |
|---|---|
"filled" | Стиль с заливкой фона. |
"outlined" | Стиль с обводкой. |
"underlined" | Стиль с подчеркиванием. |
Position
Тип Position определяет относительное положение фиксированного окна относительно целевого элемента:
| Значение | Описание |
|---|---|
"top" | Позиционируется над целевым элементом. |
"bottom" | Позиционируется под целевым элементом. |
"left" | Позиционируется слева от целевого элемента. |
"right" | Позиционируется справа от целевого элемента. |
"center" | Центрируется относительно целевого элемента. |
"bottom-left" | Позиционируется в левом нижнем углу целевого элемента. |
"top-left" | Позиционируется в левом верхнем углу целевого элемента. |
"bottom-right" | Позиционируется в правом нижнем углу целевого элемента. |
"top-right" | Позиционируется в правом верхнем углу целевого элемента. |
"center-top" | Центрируется горизонтально в верхней части целевого элемента. |
"center-bottom" | Центрируется горизонтально в нижней части целевого элемента. |
"center-right" | Центрируется вертикально справа от целевого элемента. |
"center-left" | Центрируется вертикально слева от целевого элемента. |
"right-top" | Позиционируется в правом верхнем углу справа от целевого элемента. |
"right-bottom" | Позиционируется в правом нижнем углу справа от целевого элемента. |
"left-top" | Позиционируется в левом верхнем углу слева от целевого элемента. |
"left-bottom" | Позиционируется в левом нижнем углу слева от целевого элемента. |