Debian Codegraph @

packages/popper/src/utils/isModifierRequired.js

raw
1 import find from './find';
2
3 /**
4 * Helper used to know if the given modifier depends from another one.<br />
5 * It checks if the needed modifier is listed and enabled.
6 * @method
7 * @memberof Popper.Utils
8 * @param {Array} modifiers - list of modifiers
9 * @param {String} requestingName - name of requesting modifier
10 * @param {String} requestedName - name of requested modifier
11 * @returns {Boolean}
12 */
13 export default function isModifierRequired(
14 modifiers,
15 requestingName,
16 requestedName
17 ) {
18 const requesting = find(modifiers, ({ name }) => name === requestingName);
19
20 const isRequired =
21 !!requesting &&
22 modifiers.some(modifier => {
23 return (
24 modifier.name === requestedName &&
25 modifier.enabled &&
26 modifier.order < requesting.order
27 );
28 });
29
30 if (!isRequired) {
31 const requesting = `\`${requestingName}\``;
32 const requested = `\`${requestedName}\``;
33 console.warn(
34 `${requested} modifier is required by ${requesting} modifier in order to work, be sure to include it before ${requesting}!`
35 );
36 }
37 return isRequired;
38 }