devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
452 lines (451 loc) • 16.7 kB
JavaScript
/**
* DevExtreme (esm/__internal/ui/popover/m_popover.js)
* Version: 24.2.6
* Build date: Mon Mar 17 2025
*
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import _extends from "@babel/runtime/helpers/esm/extends";
import positionUtils from "../../../common/core/animation/position";
import {
move
} from "../../../common/core/animation/translator";
import eventsEngine from "../../../common/core/events/core/events_engine";
import {
addNamespace
} from "../../../common/core/events/utils/index";
import registerComponent from "../../../core/component_registrator";
import domAdapter from "../../../core/dom_adapter";
import {
getPublicElement
} from "../../../core/element";
import $ from "../../../core/renderer";
import {
extend
} from "../../../core/utils/extend";
import {
fitIntoRange
} from "../../../core/utils/math";
import {
getBoundingRect
} from "../../../core/utils/position";
import {
getHeight,
getWidth,
setHeight,
setWidth
} from "../../../core/utils/size";
import {
isObject,
isString
} from "../../../core/utils/type";
import {
hasWindow
} from "../../../core/utils/window";
import {
isMaterial,
isMaterialBased
} from "../../../ui/themes";
import errors from "../../../ui/widget/ui.errors";
import Popup from "../../ui/popup/m_popup";
import {
POPOVER_POSITION_ALIASES,
PopoverPositionController
} from "./m_popover_position_controller";
const POPOVER_CLASS = "dx-popover";
const POPOVER_WRAPPER_CLASS = "dx-popover-wrapper";
const POPOVER_ARROW_CLASS = "dx-popover-arrow";
const POPOVER_WITHOUT_TITLE_CLASS = "dx-popover-without-title";
const POSITION_FLIP_MAP = {
left: "right",
top: "bottom",
right: "left",
bottom: "top",
center: "center"
};
const getEventNameByOption = function(optionValue) {
return isObject(optionValue) ? optionValue.name : optionValue
};
const getEventName = function(that, optionName) {
const optionValue = that.option(optionName);
return getEventNameByOption(optionValue)
};
const getEventDelay = function(that, optionName) {
const optionValue = that.option(optionName);
return isObject(optionValue) && optionValue.delay
};
const attachEvent = function(that, name) {
const {
target: target,
shading: shading,
disabled: disabled,
hideEvent: hideEvent
} = that.option();
const isSelector = isString(target);
const shouldIgnoreHideEvent = shading && "hide" === name;
const event = shouldIgnoreHideEvent ? null : getEventName(that, `${name}Event`);
if (shouldIgnoreHideEvent && hideEvent) {
errors.log("W1020")
}
if (!event || disabled) {
return
}
const eventName = addNamespace(event, that.NAME);
const action = that._createAction(function() {
const delay = getEventDelay(that, `${name}Event`);
this._clearEventsTimeouts();
if (delay) {
this._timeouts[name] = setTimeout((() => {
that[name]()
}), delay)
} else {
that[name]()
}
}.bind(that), {
validatingTargetName: "target"
});
const handler = function(e) {
action({
event: e,
target: $(e.currentTarget)
})
};
const EVENT_HANDLER_NAME = `_${name}EventHandler`;
if (isSelector) {
that[EVENT_HANDLER_NAME] = handler;
eventsEngine.on(domAdapter.getDocument(), eventName, target, handler)
} else {
const targetElement = getPublicElement($(target));
that[EVENT_HANDLER_NAME] = void 0;
eventsEngine.on(targetElement, eventName, handler)
}
};
const detachEvent = function(that, target, name, event) {
let eventName = event || getEventName(that, `${name}Event`);
if (!eventName) {
return
}
eventName = addNamespace(eventName, that.NAME);
const EVENT_HANDLER_NAME = `_${name}EventHandler`;
if (that[EVENT_HANDLER_NAME]) {
eventsEngine.off(domAdapter.getDocument(), eventName, target, that[EVENT_HANDLER_NAME])
} else {
eventsEngine.off(getPublicElement($(target)), eventName)
}
};
class Popover extends Popup {
_getDefaultOptions() {
return _extends({}, super._getDefaultOptions(), {
shading: false,
position: extend({}, POPOVER_POSITION_ALIASES.bottom),
hideOnOutsideClick: true,
animation: {
show: {
type: "fade",
from: 0,
to: 1
},
hide: {
type: "fade",
from: 1,
to: 0
}
},
showTitle: false,
width: "auto",
height: "auto",
dragEnabled: false,
resizeEnabled: false,
fullScreen: false,
hideOnParentScroll: true,
arrowPosition: "",
arrowOffset: 0,
_fixWrapperPosition: true
})
}
_defaultOptionsRules() {
return [{
device: {
platform: "ios"
},
options: {
arrowPosition: {
boundaryOffset: {
h: 20,
v: -10
},
collision: "fit"
}
}
}, {
device: () => !hasWindow(),
options: {
animation: null
}
}, {
device: () => isMaterialBased(),
options: {
useFlatToolbarButtons: true
}
}, {
device: () => isMaterial(),
options: {
useDefaultToolbarButtons: true,
showCloseButton: false
}
}]
}
_init() {
super._init();
this._renderArrow();
this._timeouts = {};
this.$element().addClass("dx-popover");
this.$wrapper().addClass("dx-popover-wrapper");
const {
toolbarItems: toolbarItems
} = this.option();
const isInteractive = null === toolbarItems || void 0 === toolbarItems ? void 0 : toolbarItems.length;
this.setAria("role", isInteractive ? "dialog" : "tooltip")
}
_render() {
super._render.apply(this, arguments);
this._detachEvents(this.option("target"));
this._attachEvents()
}
_detachEvents(target) {
detachEvent(this, target, "show");
detachEvent(this, target, "hide")
}
_attachEvents() {
attachEvent(this, "show");
attachEvent(this, "hide")
}
_renderArrow() {
this._$arrow = $("<div>").addClass("dx-popover-arrow").prependTo(this.$overlayContent())
}
_documentDownHandler(e) {
if (this._isOutsideClick(e)) {
return super._documentDownHandler(e)
}
return true
}
_isOutsideClick(e) {
const {
target: target
} = this.option();
return !$(e.target).closest(target).length
}
_animate(animation) {
if (null !== animation && void 0 !== animation && animation.to && "object" === typeof animation.to) {
extend(animation.to, {
position: this._getContainerPosition()
})
}
super._animate.apply(this, arguments)
}
_stopAnimation() {
super._stopAnimation.apply(this, arguments)
}
_renderTitle() {
this.$wrapper().toggleClass("dx-popover-without-title", !this.option("showTitle"));
super._renderTitle()
}
_renderPosition() {
let shouldUpdateDimensions = arguments.length > 0 && void 0 !== arguments[0] ? arguments[0] : true;
super._renderPosition();
this._renderOverlayPosition(shouldUpdateDimensions);
this._actions.onPositioned()
}
_renderOverlayPosition(shouldUpdateDimensions) {
this._resetOverlayPosition(shouldUpdateDimensions);
this._updateContentSize(shouldUpdateDimensions);
const contentPosition = this._getContainerPosition();
const resultLocation = positionUtils.setup(this.$overlayContent(), contentPosition);
const positionSide = this._getSideByLocation(resultLocation);
this._togglePositionClass(`dx-position-${positionSide}`);
this._toggleFlippedClass(resultLocation.h.flip, resultLocation.v.flip);
const isArrowVisible = this._isHorizontalSide() || this._isVerticalSide();
if (isArrowVisible) {
this._renderArrowPosition(positionSide)
}
}
_resetOverlayPosition(shouldUpdateDimensions) {
this._setContentHeight(shouldUpdateDimensions);
this._togglePositionClass(`dx-position-${this._positionController._positionSide}`);
move(this.$overlayContent(), {
left: 0,
top: 0
});
this._$arrow.css({
top: "auto",
right: "auto",
bottom: "auto",
left: "auto"
})
}
_updateContentSize(shouldUpdateDimensions) {
if (!this.$content() || !shouldUpdateDimensions) {
return
}
const containerLocation = positionUtils.calculate(this.$overlayContent(), this._getContainerPosition());
if (containerLocation.h.oversize > 0 && this._isHorizontalSide() && !containerLocation.h.fit) {
const newContainerWidth = getWidth(this.$overlayContent()) - containerLocation.h.oversize;
setWidth(this.$overlayContent(), newContainerWidth)
}
if (containerLocation.v.oversize > 0 && this._isVerticalSide() && !containerLocation.v.fit) {
const newOverlayContentHeight = getHeight(this.$overlayContent()) - containerLocation.v.oversize;
const newPopupContentHeight = getHeight(this.$content()) - containerLocation.v.oversize;
setHeight(this.$overlayContent(), newOverlayContentHeight);
setHeight(this.$content(), newPopupContentHeight)
}
}
_getContainerPosition() {
return this._positionController._getContainerPosition()
}
_getHideOnParentScrollTarget() {
return $(this._positionController._position.of || super._getHideOnParentScrollTarget())
}
_getSideByLocation(location) {
const isFlippedByVertical = location.v.flip;
const isFlippedByHorizontal = location.h.flip;
return this._isVerticalSide() && isFlippedByVertical || this._isHorizontalSide() && isFlippedByHorizontal || this._isPopoverInside() ? POSITION_FLIP_MAP[this._positionController._positionSide] : this._positionController._positionSide
}
_togglePositionClass(positionClass) {
this.$wrapper().removeClass("dx-position-left dx-position-right dx-position-top dx-position-bottom").addClass(positionClass)
}
_toggleFlippedClass(isFlippedHorizontal, isFlippedVertical) {
this.$wrapper().toggleClass("dx-popover-flipped-horizontal", isFlippedHorizontal).toggleClass("dx-popover-flipped-vertical", isFlippedVertical)
}
_renderArrowPosition(side) {
const arrowRect = getBoundingRect(this._$arrow.get(0));
const arrowFlip = -(this._isVerticalSide(side) ? arrowRect.height : arrowRect.width);
this._$arrow.css(POSITION_FLIP_MAP[side], arrowFlip);
const axis = this._isVerticalSide(side) ? "left" : "top";
const sizeProperty = this._isVerticalSide(side) ? "width" : "height";
const $target = $(this._positionController._position.of);
const targetOffset = positionUtils.offset($target) ?? {
top: 0,
left: 0
};
const contentOffset = positionUtils.offset(this.$overlayContent());
const arrowSize = arrowRect[sizeProperty];
const contentLocation = null === contentOffset || void 0 === contentOffset ? void 0 : contentOffset[axis];
const contentSize = getBoundingRect(this.$overlayContent().get(0))[sizeProperty];
const targetLocation = targetOffset[axis];
const targetElement = $target.get(0);
const targetSize = targetElement && !targetElement.preventDefault ? getBoundingRect(targetElement)[sizeProperty] : 0;
const min = Math.max(contentLocation, targetLocation);
const max = Math.min(contentLocation + contentSize, targetLocation + targetSize);
let arrowLocation;
const {
arrowPosition: arrowPosition
} = this.option();
if ("start" === arrowPosition) {
arrowLocation = min - contentLocation
} else if ("end" === arrowPosition) {
arrowLocation = max - contentLocation - arrowSize
} else {
arrowLocation = (min + max) / 2 - contentLocation - arrowSize / 2
}
const borderWidth = this._positionController._getContentBorderWidth(side);
const {
arrowOffset: arrowOffset
} = this.option();
const finalArrowLocation = fitIntoRange(arrowLocation - borderWidth + arrowOffset, borderWidth, contentSize - arrowSize - 2 * borderWidth);
this._$arrow.css(axis, finalArrowLocation)
}
_isPopoverInside() {
return this._positionController._isPopoverInside()
}
_setContentHeight(fullUpdate) {
if (fullUpdate) {
super._setContentHeight()
}
}
_getPositionControllerConfig() {
const {
shading: shading,
target: target
} = this.option();
return extend({}, super._getPositionControllerConfig(), {
target: target,
shading: shading,
$arrow: this._$arrow
})
}
_initPositionController() {
this._positionController = new PopoverPositionController(this._getPositionControllerConfig())
}
_renderWrapperDimensions() {
if (this.option("shading")) {
this.$wrapper().css({
width: "100%",
height: "100%"
})
}
}
_isVerticalSide(side) {
return this._positionController._isVerticalSide(side)
}
_isHorizontalSide(side) {
return this._positionController._isHorizontalSide(side)
}
_clearEventTimeout(name) {
clearTimeout(this._timeouts[name])
}
_clearEventsTimeouts() {
this._clearEventTimeout("show");
this._clearEventTimeout("hide")
}
_clean() {
this._detachEvents(this.option("target"));
super._clean.apply(this, arguments)
}
_optionChanged(args) {
switch (args.name) {
case "arrowPosition":
case "arrowOffset":
this._renderGeometry();
break;
case "fullScreen":
if (args.value) {
this.option("fullScreen", false)
}
break;
case "target":
args.previousValue && this._detachEvents(args.previousValue);
this._positionController.updateTarget(args.value);
this._invalidate();
break;
case "showEvent":
case "hideEvent": {
const name = args.name.substring(0, 4);
const event = getEventNameByOption(args.previousValue);
this.hide();
detachEvent(this, this.option("target"), name, event);
attachEvent(this, name);
break
}
case "visible":
this._clearEventTimeout(args.value ? "show" : "hide");
super._optionChanged(args);
break;
case "disabled":
this._detachEvents(this.option("target"));
this._attachEvents();
super._optionChanged(args);
break;
default:
super._optionChanged(args)
}
}
show(target) {
if (target) {
this.option("target", target)
}
return super.show()
}
}
registerComponent("dxPopover", Popover);
export default Popover;