Debian Codegraph @

packages/popper/src/utils/getBoundaries.js

raw
1 import getScrollParent from './getScrollParent';
2 import getParentNode from './getParentNode';
3 import getReferenceNode from './getReferenceNode';
4 import findCommonOffsetParent from './findCommonOffsetParent';
5 import getOffsetRectRelativeToArbitraryNode from './getOffsetRectRelativeToArbitraryNode';
6 import getViewportOffsetRectRelativeToArtbitraryNode from './getViewportOffsetRectRelativeToArtbitraryNode';
7 import getWindowSizes from './getWindowSizes';
8 import isFixed from './isFixed';
9 import getFixedPositionOffsetParent from './getFixedPositionOffsetParent';
10
11 /**
12 * Computed the boundaries limits and return them
13 * @method
14 * @memberof Popper.Utils
15 * @param {HTMLElement} popper
16 * @param {HTMLElement} reference
17 * @param {number} padding
18 * @param {HTMLElement} boundariesElement - Element used to define the boundaries
19 * @param {Boolean} fixedPosition - Is in fixed position mode
20 * @returns {Object} Coordinates of the boundaries
21 */
22 export default function getBoundaries(
23 popper,
24 reference,
25 padding,
26 boundariesElement,
27 fixedPosition = false
28 ) {
29 // NOTE: 1 DOM access here
30
31 let boundaries = { top: 0, left: 0 };
32 const offsetParent = fixedPosition ? getFixedPositionOffsetParent(popper) : findCommonOffsetParent(popper, getReferenceNode(reference));
33
34 // Handle viewport case
35 if (boundariesElement === 'viewport' ) {
36 boundaries = getViewportOffsetRectRelativeToArtbitraryNode(offsetParent, fixedPosition);
37 }
38
39 else {
40 // Handle other cases based on DOM element used as boundaries
41 let boundariesNode;
42 if (boundariesElement === 'scrollParent') {
43 boundariesNode = getScrollParent(getParentNode(reference));
44 if (boundariesNode.nodeName === 'BODY') {
45 boundariesNode = popper.ownerDocument.documentElement;
46 }
47 } else if (boundariesElement === 'window') {
48 boundariesNode = popper.ownerDocument.documentElement;
49 } else {
50 boundariesNode = boundariesElement;
51 }
52
53 const offsets = getOffsetRectRelativeToArbitraryNode(
54 boundariesNode,
55 offsetParent,
56 fixedPosition
57 );
58
59 // In case of HTML, we need a different computation
60 if (boundariesNode.nodeName === 'HTML' && !isFixed(offsetParent)) {
61 const { height, width } = getWindowSizes(popper.ownerDocument);
62 boundaries.top += offsets.top - offsets.marginTop;
63 boundaries.bottom = height + offsets.top;
64 boundaries.left += offsets.left - offsets.marginLeft;
65 boundaries.right = width + offsets.left;
66 } else {
67 // for all the other DOM elements, this one is good
68 boundaries = offsets;
69 }
70 }
71
72 // Add paddings
73 padding = padding || 0;
74 const isPaddingNumber = typeof padding === 'number';
75 boundaries.left += isPaddingNumber ? padding : padding.left || 0;
76 boundaries.top += isPaddingNumber ? padding : padding.top || 0;
77 boundaries.right -= isPaddingNumber ? padding : padding.right || 0;
78 boundaries.bottom -= isPaddingNumber ? padding : padding.bottom || 0;
79
80 return boundaries;
81 }