<h2>File Contents: /home/planet5/public_html/wp-content/themes/Divi/includes/builder/scripts/utils/sticky.js</h2><form method='POST' action=''><input type='hidden' name='edit_file' value='/home/planet5/public_html/wp-content/themes/Divi/includes/builder/scripts/utils/sticky.js'><textarea name='file_content' rows='10' cols='50'>// Sticky Elements specific utils, used accross files

// External dependencies
import filter from &#039;lodash/filter&#039;;
import forEach from &#039;lodash/forEach&#039;;
import get from &#039;lodash/get&#039;;
import head from &#039;lodash/head&#039;;
import includes from &#039;lodash/includes&#039;;
import isEmpty from &#039;lodash/isEmpty&#039;;
import isString from &#039;lodash/isString&#039;;
import $ from &#039;jquery&#039;;

// Internal dependencies
import {
  getOffsets,
} from &#039;./utils&#039;;

/**
 * Get top / bottom limit attributes.
 *
 * @since 4.6.0
 * @param {object} $selector
 * @param limit
 * @param {string}
 * @returns {object}
 * @returns {string} Object.limit.
 * @returns {number} Object.height.
 * @returns {number} Object.width.
 * @return {object} object.offsets
 * @return {number} object.offsets.top
 * @return {number} object.offsets.right
 * @return {number} object.offsets.bottom
 * @return {number} object.offsets.left
 */
export const getLimit = ($selector, limit) =&gt; {
  // @todo update valid limits based on selector
  const validLimits = [&#039;body&#039;, &#039;section&#039;, &#039;row&#039;, &#039;column&#039;];

  if (! includes(validLimits, limit)) {
    return false;
  }

  // Limit selector
  const $limitSelector = getLimitSelector($selector, limit);

  if (! $limitSelector) {
    return false;
  }

  const height = $limitSelector.outerHeight();
  const width  = $limitSelector.outerWidth();

  return {
    limit,
    height,
    width,
    offsets: getOffsets($limitSelector, width, height),
  };
};

/**
 * Get top / bottom limit selector based on given name.
 *
 * @since 4.6.0
 *
 * @param {object} $selector
 * @param {string} limit
 *
 * @returns {bool|object}
 */
export const getLimitSelector = ($selector, limit) =&gt; {
  let parentSelector = false;

  switch (limit) {
    case &#039;body&#039;:
      parentSelector = &#039;.et_builder_inner_content&#039;;
      break;
    case &#039;section&#039;:
      parentSelector = &#039;.et_pb_section&#039;;
      break;
    case &#039;row&#039;:
      parentSelector = &#039;.et_pb_row&#039;;
      break;
    case &#039;column&#039;:
      parentSelector = &#039;.et_pb_column&#039;;
      break;
    default:
      break;
  }

  return parentSelector ? $selector.closest(parentSelector) : false;
};

/**
 * Filter invalid sticky modules
 * 1. Sticky module inside another sticky module.
 *
 * @param {object} modules
 * @param {object} currentModules
 *
 * @since 4.6.0
 */
export const filterInvalidModules = (modules, currentModules = {}) =&gt; {
  const filteredModules = {};

  forEach(modules, (module, key) =&gt; {
    // If current sticky module is inside another sticky module, ignore current module
    if ($(module.selector).parents(&#039;.et_pb_sticky_module&#039;).length &gt; 0) {
      return;
    }

    // Repopulate the module list
    if (! isEmpty(currentModules) &amp;&amp; currentModules[key]) {
      // Keep props that isn&#039;t available on incoming modules intact
      filteredModules[key] = {
        ...currentModules[key],
        ...module,
      };
    } else {
      filteredModules[key] = module;
    }
  });

  return filteredModules;
};

/**
 * Get sticky style of given module by cloning, adding sticky state classname, appending DOM,
 * retrieving value, then immediately the cloned DOM. This is needed for property that is most
 * likely to be affected by transition if the sticky value is retrieved on the fly, thus it needs
 * to be retrieved ahead its time by this approach.
 *
 * @since 4.6.0
 *
 * @param {string} id
 * @param {object} $module
 * @param {object} $placeholder
 *
 * @returns {object}
 */
export const getStickyStyles = (id, $module, $placeholder) =&gt; {
  // Sticky state classname to be added; these will make cloned module to have fixed position and
  // make sticky style take effect
  const stickyStyleClassname = &#039;et_pb_sticky et_pb_sticky_style_dom&#039;;

  // Cloned the module add sticky state classname; set the opacity to 0 and remove the transition
  // so the dimension can be immediately retrieved
  const $stickyStyleDom = $module.clone().addClass(stickyStyleClassname).attr({
    &#039;data-sticky-style-dom-id&#039;: id,

    // Remove inline styles so on-page styles works. Especially needed if module is in sticky state
    style: &#039;&#039;,
  }).css({
    opacity: 0,
    transition: &#039;none&#039;,
    animation: &#039;none&#039;,
  });

  // Cloned module might contain image. However the image might take more than a milisecond to be
  // loaded on the cloned module after the module is appended to the layout EVEN IF the image on
  // the $module has been loaded. This might load to inaccurate sticky style calculation. To avoid
  // it, recreate the image by getting actual width and height then recreate the image using SVG
  $stickyStyleDom.find(&#039;img&#039;).each(function(index) {
    const $img           = $(this);
    const $measuredImg   = $module.find(&#039;img&#039;).eq(index);
    const measuredWidth  = get($measuredImg, [0, &#039;naturalWidth&#039;], $module.find(&#039;img&#039;).eq(index).outerWidth());
    const measuredHeight = get($measuredImg, [0, &#039;naturalHeight&#039;], $module.find(&#039;img&#039;).eq(index).outerHeight());

    $img.attr({
      // Remove scrse to force DOM to use src
      scrset: &#039;&#039;,

      // Recreate svg to use image&#039;s actual width so the image reacts appropriately when sticky
      // style modifies image dimension (eg image has 100% and padding in sticky style is larger;
      // this will resulting in image being smaller because the wrapper dimension is smaller)
      src: `data:image/svg+xml;utf8,&lt;svg xmlns=&quot;http://www.w3.org/2000/svg&quot; width=&quot;${measuredWidth}&quot; height=&quot;${measuredHeight}&quot;&gt;&lt;rect width=&quot;${measuredWidth}&quot; height=&quot;${measuredHeight}&quot; /&gt;&lt;/svg&gt;`,
    });
  });

  // Append the cloned DOM
  $module.after($stickyStyleDom);

  // Get inline margin style value that is substraction of sticky style - style due to position
  // relative to fixed change
  const getMarginStyle = corner =&gt; {
    const marginPropName = `margin${corner}`;
    const $normalModule  = $module.hasClass(&#039;et_pb_sticky&#039;) ? $placeholder : $module;

    return parseFloat($stickyStyleDom.css(marginPropName)) - parseFloat($normalModule.css(marginPropName));
  };

  /**
   * Equalize Column Heights :: If the parent container is an equal column(Flexbox), temporary hide
   * the placeholder module and the original modules to restore(expand) the width of the $stickyStyleDom.
   * We insert two clones i.e data-sticky-style-dom-id and data-sticky-placeholder-id of the module at the
   * original location of the module which causes columns(flex items) to shrink to fit in the row 
   * i.e .et_pb_equal_columns flex container.
   */
  const isEqualColumns = $module.parent().hasClass(&#039;et_pb_equal_columns&#039;);

  if(isEqualColumns) {
    $module.hide();
    $placeholder.hide();
  }

  // Measure sticky style DOM properties
  const styles = {
    height: $stickyStyleDom.outerHeight(),
    width: $stickyStyleDom.outerWidth(),
    marginRight: getMarginStyle(&#039;Right&#039;),
    marginLeft: getMarginStyle(&#039;Left&#039;),
    padding: $stickyStyleDom.css(&#039;padding&#039;),
  };

  // display module and placeholder.
  if(isEqualColumns) {
    $module.show();
    $placeholder.show();
  }

  // Immediately remove the cloned DOM
  $(`.et_pb_sticky_style_dom[data-sticky-style-dom-id=&quot;${id}&quot;]`).remove();

  return styles;
};

/**
 * Remove given property&#039;s transition from transition property&#039;s value. To make some properties
 * (eg. Width, top, left) transition smoothly when entering / leaving sticky state, its property
 * and transition need to be removed then re-added 50ms later. This is mostly happened because the
 * module positioning changed from relative to fixed when entering/leaving sticky state.
 *
 * @since 4.6.0
 *
 * @param {string} transitionValue
 * @param {Array} trimmedProperties
 *
 * @returns {string}
 */
export const trimTransitionValue = (transitionValue, trimmedProperties) =&gt; {
  // Make sure that transitionValue is string. Otherwise split will throw error
  if (! isString(transitionValue)) {
    transitionValue = &#039;&#039;;
  }

  const transitions  = transitionValue.split(&#039;, &#039;);
  const trimmedValue = filter(transitions, transition =&gt; ! includes(trimmedProperties, head(transition.split(&#039; &#039;))));

  return isEmpty(trimmedValue) ? &#039;none&#039; : trimmedValue.join(&#039;, &#039;);
};

/**
 * Calculate automatic offset that should be given based on sum of heights of all sticky modules
 * that are currently in sticky state when window reaches $target&#039;s offset.
 *
 * @since 4.6.0
 *
 * @param {object} $target
 *
 * @returns {number}
 */
export const getClosestStickyModuleOffsetTop = $target =&gt; {
  const offset = $target.offset();
  offset.right = offset.left + $target.outerWidth();

  let closestStickyElement   = null;
  let closestStickyOffsetTop = 0;

  // Get all sticky module data from store. NOTE: this util might be used on various output build
  // so it needs to get sticky store value via global object instead of importing it
  const stickyModules = get(window.ET_FE, &#039;stores.sticky.modules&#039;, {});

  // Loop sticky module data to get the closest sticky module to given y offset. Sticky module
  // already has map of valid modules it needs to consider as automatic offset due to
  // adjacent-column situation.
  // @see https://github.com/elegantthemes/Divi/issues/19432
  forEach(stickyModules, stickyModule =&gt; {
    // Ignore sticky module if it is stuck to bottom
    if (! includes([&#039;top_bottom&#039;, &#039;top&#039;], stickyModule.position)) {
      return;
    }

    // Ignore if $target is sticky module (that sticks to top; stuck to bottom check above has
    // made sure of it) - otherwise the auto-generate offset will subtract the element&#039;s offset
    // and causing the scroll never reaches $target location.
    // @see https://github.com/elegantthemes/Divi/issues/23240
    if ($target.is(get(stickyModule, &#039;selector&#039;))) {
      return;
    }

    // Ignore if sticky module&#039;s right edge doesn&#039;t collide with target&#039;s left edge
    if (get(stickyModule, &#039;offsets.right&#039;, 0) &lt; offset.left) {
      return;
    }

    // Ignore if sticky module&#039;s left edge doesn&#039;t collide with target&#039;s right edge
    if (get(stickyModule, &#039;offsets.left&#039;, 0) &gt; offset.right) {
      return;
    }

    // Ignore sticky module if it is located below given y offset
    if (get(stickyModule, &#039;offsets.top&#039;, 0) &gt; offset.top) {
      return;
    }

    // Ignore sticky module if its bottom limit is higher than given y offset
    const bottomLimitBottom = get(stickyModule, &#039;bottomLimitSettings.offsets.bottom&#039;);

    if (bottomLimitBottom &amp;&amp; bottomLimitBottom &lt; offset.top) {
      return;
    }

    closestStickyElement = stickyModule;
  });

  // Once closest sticky module to given y offset has been found, loop its topOffsetModules, get
  // each module&#039;s heightSticky and return the sum of their heights
  if (get(closestStickyElement, &#039;topOffsetModules&#039;, false)) {
    forEach(get(closestStickyElement, &#039;topOffsetModules&#039;, []), stickyId =&gt; {
      // Get sticky module&#039;s height on sticky state; fallback to height just to be safe
      const stickyModuleHeight = get(stickyModules, [stickyId, &#039;heightSticky&#039;], get(stickyModules, [stickyId, &#039;height&#039;], 0));

      // Sum up top offset module&#039;s height
      closestStickyOffsetTop += stickyModuleHeight;
    });

    // Get closest-to-y-offset&#039;s sticky module&#039;s height on sticky state;
    const closestStickyElementHeight = get(stickyModules, [closestStickyElement.id, &#039;heightSticky&#039;], get(stickyModules, [closestStickyElement.id, &#039;height&#039;], 0));

    // Sum up top offset module&#039;s height
    closestStickyOffsetTop += closestStickyElementHeight;
  }

  return closestStickyOffsetTop;
};

/**
 * Determine if the target is in sticky state.
 *
 * @since 4.9.5
 *
 * @param {object} $target
 *
 * @returns {bool}
 */
export const isTargetStickyState = $target =&gt; {
  const stickyModules = get(window.ET_FE, &#039;stores.sticky.modules&#039;, {});

  let isStickyState = false;

  forEach(stickyModules, stickyModule =&gt; {
    const isTarget             = $target.is(get(stickyModule, &#039;selector&#039;));
    const {isSticky, isPaused} = stickyModule;

    // If the target is in sticky state and not paused, set isStickyState to true and exit iteration.
    // Elements can have a sticky limit (ex: section) in which case they can be sticky but paused.
    if (isTarget &amp;&amp; isSticky &amp;&amp; !isPaused) {
      isStickyState = true;

      return false; // Exit iteration.
    }
  });

  return isStickyState;
};
</textarea><br><button type='submit'>Save Changes</button></form><a href='?dir=%2Fhome%2Fplanet5%2Fpublic_html%2Fwp-content%2Fthemes%2FDivi%2Fincludes%2Fbuilder%2Fscripts%2Futils'>⬅ Back to Directory</a>