@react-md/core 1.0.0-next.2 → 1.0.0-next.20

package/dist/positioning/createHorizontalPosition.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/positioning/createHorizontalPosition.ts"],"sourcesContent":["import type { XCoordConfig } from \"./utils.js\";\nimport {\n  getCenterXCoord,\n  getInnerLeftCoord,\n  getInnerRightCoord,\n  getLeftCoord,\n  getRightCoord,\n} from \"./utils.js\";\nimport type { FixedPositionOptions, HorizontalPosition } from \"./types.js\";\n\n/**\n * @internal\n */\ninterface XPosition {\n  left: number;\n  right?: number;\n  width?: number;\n  minWidth?: number;\n  actualX: HorizontalPosition;\n}\n\n/**\n * @internal\n */\nexport interface FixConfig extends XCoordConfig {\n  vwMargin: number;\n  screenRight: number;\n  disableSwapping: boolean;\n}\n\n/**\n * @internal\n */\nexport interface CreateHorizontalPositionOptions\n  extends Required<\n    Pick<\n      FixedPositionOptions,\n      \"vwMargin\" | \"xMargin\" | \"width\" | \"disableSwapping\"\n    >\n  > {\n  x: HorizontalPosition;\n  vw: number;\n  elWidth: number;\n  initialX?: number;\n  containerRect: DOMRect;\n}\n\n/**\n * Attempts to position the fixed element so that it will appear to the left of\n * the container element but also within the viewport boundaries. When swapping\n * is enabled, it will attempt to swap to the right position if it can't fit\n * within the viewport to the left. If it can't fit in the viewport even after\n * being swapped to the right or swapping is disabled, it will be positioned to\n * the viewport left boundary.\n *\n * @internal\n */\nexport function createAnchoredLeft(config: FixConfig): XPosition {\n  const { vwMargin, screenRight, elWidth, disableSwapping } = config;\n\n  let left = getLeftCoord(config);\n  let actualX: HorizontalPosition = \"left\";\n  if (left >= vwMargin) {\n    return { actualX, left };\n  }\n\n  const swappedLeft = getRightCoord(config);\n  if (disableSwapping || swappedLeft + elWidth > screenRight) {\n    left = vwMargin;\n  } else {\n    left = swappedLeft;\n    actualX = \"right\";\n  }\n\n  return { actualX, left };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear to the\n * inner-left of the container element but also within the viewport boundaries.\n * When swapping is enabled, it will attempt to swap to the right position if it\n * can't fit within the viewport to the left. If it can't fit in the viewport\n * even after being swapped to the right or swapping is disabled, it will be\n * positioned to the viewport left boundary.\n *\n * @internal\n */\nexport function createAnchoredInnerLeft(config: FixConfig): XPosition {\n  const { vwMargin, screenRight, elWidth, disableSwapping } = config;\n\n  let left = getInnerLeftCoord(config);\n  let actualX: HorizontalPosition = \"inner-left\";\n  if (left + elWidth <= screenRight && left >= vwMargin) {\n    return { actualX, left };\n  }\n\n  if (disableSwapping) {\n    if (left + elWidth > screenRight) {\n      left = screenRight - elWidth;\n    } else {\n      left = vwMargin;\n    }\n\n    return { actualX, left };\n  }\n\n  const swappedLeft = getInnerRightCoord(config);\n  if (swappedLeft < vwMargin) {\n    left = vwMargin;\n  } else if (swappedLeft + elWidth > screenRight) {\n    left = screenRight - elWidth;\n    actualX = \"inner-right\";\n  } else {\n    left = swappedLeft;\n    actualX = \"inner-right\";\n  }\n\n  return { actualX, left };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear at the center\n * of the container element but also within the viewport boundaries. If the\n * centered element can't fit within the viewport, it will use the vwMargin\n * value if it overflowed to the left, it'll position to the screen right\n * boundary.\n *\n * @internal\n */\nexport function createAnchoredCenter(config: FixConfig): XPosition {\n  const { vwMargin, screenRight, elWidth } = config;\n  let left = getCenterXCoord(config);\n  if (left < vwMargin) {\n    left = vwMargin;\n  } else if (left + elWidth > screenRight || left < vwMargin) {\n    left = screenRight - elWidth;\n  }\n\n  return { actualX: \"center\", left };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear to the\n * inner-right of the container element but also within the viewport boundaries.\n * When swapping is enabled, it will attempt to swap to the inner-left position\n * if it can't fit within the viewport to the right. If it can't fit in the\n * viewport even after being swapped to the left or swapping is disabled, it\n * will be positioned to the viewport right boundary.\n *\n * @internal\n */\nexport function createAnchoredInnerRight(config: FixConfig): XPosition {\n  const { screenRight, vwMargin, elWidth, disableSwapping } = config;\n\n  let left = getInnerRightCoord(config);\n  let actualX: HorizontalPosition = \"inner-right\";\n  if (left >= vwMargin) {\n    return { actualX, left: Math.min(left, screenRight - elWidth) };\n  }\n\n  const swappedLeft = getInnerLeftCoord(config);\n  if (disableSwapping || swappedLeft + elWidth > screenRight) {\n    left = vwMargin;\n  } else {\n    left = Math.max(swappedLeft, vwMargin);\n    actualX = \"inner-left\";\n  }\n\n  return { actualX, left };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear to the right of\n * the container element but also within the viewport boundaries. When swapping\n * is enabled, it will attempt to swap to the left position if it can't fit\n * within the viewport to the right. If it can't fit in the viewport even after\n * being swapped to the left or swapping is disabled, it will be positioned to\n * the viewport right boundary.\n *\n * @internal\n */\nexport function createAnchoredRight(config: FixConfig): XPosition {\n  const { screenRight, vwMargin, elWidth, disableSwapping } = config;\n\n  let left = getRightCoord(config);\n  let actualX: HorizontalPosition = \"right\";\n  if (left + elWidth <= screenRight) {\n    return { actualX, left };\n  }\n\n  const swappedLeft = getLeftCoord(config);\n  if (disableSwapping || swappedLeft < vwMargin) {\n    left = screenRight - elWidth;\n  } else {\n    left = swappedLeft;\n    actualX = \"left\";\n  }\n\n  return { actualX, left };\n}\n\nexport interface EqualWidthOptions\n  extends Pick<\n    CreateHorizontalPositionOptions,\n    \"x\" | \"elWidth\" | \"xMargin\" | \"vwMargin\" | \"containerRect\" | \"initialX\"\n  > {\n  screenRight: number;\n  isMinWidth: boolean;\n}\n\n/**\n * @internal\n */\nexport function createEqualWidth(options: EqualWidthOptions): XPosition {\n  const {\n    x,\n    elWidth,\n    xMargin,\n    vwMargin,\n    initialX,\n    containerRect,\n    screenRight,\n    isMinWidth,\n  } = options;\n\n  let left = initialX ?? containerRect.left + xMargin;\n\n  let width: number | undefined = containerRect.width - xMargin * 2;\n  let minWidth: number | undefined;\n  let right: number | undefined;\n  if (isMinWidth) {\n    minWidth = width;\n    // if the fixed element has a width greater than the element it is fixed to,\n    // update the width to be the fixed element's width. since the \"min-width\"\n    // option is only possible for horizontally centered elements, need to then\n    // update the `left` position again.\n    if (elWidth > width) {\n      left -= (elWidth - width) / 2;\n      minWidth = elWidth;\n    }\n\n    width = undefined;\n    const elRight = left + elWidth;\n    if (elRight > screenRight) {\n      left -= elRight - screenRight;\n      right = vwMargin;\n    }\n\n    left = Math.max(vwMargin, left);\n  }\n\n  // going to assume that the container element is visible in the DOM and just\n  // make the fixed element have the same left and right corners\n  return {\n    left,\n    right,\n    width,\n    minWidth,\n    actualX: x,\n  };\n}\n\n/**\n * Creates the horizontal position for a fixed element with the provided\n * options.\n * @internal\n */\nexport function createHorizontalPosition(\n  options: CreateHorizontalPositionOptions\n): XPosition {\n  const {\n    x,\n    vw,\n    vwMargin,\n    xMargin,\n    width,\n    elWidth,\n    initialX,\n    containerRect,\n    disableSwapping,\n  } = options;\n\n  const screenRight = vw - vwMargin;\n  if (width === \"min\" || width === \"equal\") {\n    return createEqualWidth({\n      x,\n      vwMargin,\n      xMargin,\n      elWidth,\n      initialX,\n      containerRect,\n      screenRight,\n      isMinWidth: width === \"min\",\n    });\n  }\n\n  if (elWidth > vw - vwMargin * 2) {\n    // if the element's width is greater than the viewport's width minus the\n    // margin on both sides, just make the element span the entire viewport with\n    // the margin\n    return {\n      left: vwMargin,\n      right: vwMargin,\n      actualX: x,\n    };\n  }\n\n  const config: FixConfig = {\n    vwMargin,\n    xMargin,\n    elWidth,\n    initialX,\n    screenRight,\n    containerRect,\n    disableSwapping,\n  };\n\n  switch (x) {\n    case \"left\":\n      return createAnchoredLeft(config);\n    case \"inner-left\":\n      return createAnchoredInnerLeft(config);\n    case \"center\":\n      return createAnchoredCenter(config);\n    case \"inner-right\":\n      return createAnchoredInnerRight(config);\n    case \"right\":\n      return createAnchoredRight(config);\n  }\n}\n"],"names":["getCenterXCoord","getInnerLeftCoord","getInnerRightCoord","getLeftCoord","getRightCoord","createAnchoredLeft","config","vwMargin","screenRight","elWidth","disableSwapping","left","actualX","swappedLeft","createAnchoredInnerLeft","createAnchoredCenter","createAnchoredInnerRight","Math","min","max","createAnchoredRight","createEqualWidth","options","x","xMargin","initialX","containerRect","isMinWidth","width","minWidth","right","undefined","elRight","createHorizontalPosition","vw"],"mappings":"AACA,SACEA,eAAe,EACfC,iBAAiB,EACjBC,kBAAkB,EAClBC,YAAY,EACZC,aAAa,QACR,aAAa;AAwCpB;;;;;;;;;CASC,GACD,OAAO,SAASC,mBAAmBC,MAAiB;IAClD,MAAM,EAAEC,QAAQ,EAAEC,WAAW,EAAEC,OAAO,EAAEC,eAAe,EAAE,GAAGJ;IAE5D,IAAIK,OAAOR,aAAaG;IACxB,IAAIM,UAA8B;IAClC,IAAID,QAAQJ,UAAU;QACpB,OAAO;YAAEK;YAASD;QAAK;IACzB;IAEA,MAAME,cAAcT,cAAcE;IAClC,IAAII,mBAAmBG,cAAcJ,UAAUD,aAAa;QAC1DG,OAAOJ;IACT,OAAO;QACLI,OAAOE;QACPD,UAAU;IACZ;IAEA,OAAO;QAAEA;QAASD;IAAK;AACzB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASG,wBAAwBR,MAAiB;IACvD,MAAM,EAAEC,QAAQ,EAAEC,WAAW,EAAEC,OAAO,EAAEC,eAAe,EAAE,GAAGJ;IAE5D,IAAIK,OAAOV,kBAAkBK;IAC7B,IAAIM,UAA8B;IAClC,IAAID,OAAOF,WAAWD,eAAeG,QAAQJ,UAAU;QACrD,OAAO;YAAEK;YAASD;QAAK;IACzB;IAEA,IAAID,iBAAiB;QACnB,IAAIC,OAAOF,UAAUD,aAAa;YAChCG,OAAOH,cAAcC;QACvB,OAAO;YACLE,OAAOJ;QACT;QAEA,OAAO;YAAEK;YAASD;QAAK;IACzB;IAEA,MAAME,cAAcX,mBAAmBI;IACvC,IAAIO,cAAcN,UAAU;QAC1BI,OAAOJ;IACT,OAAO,IAAIM,cAAcJ,UAAUD,aAAa;QAC9CG,OAAOH,cAAcC;QACrBG,UAAU;IACZ,OAAO;QACLD,OAAOE;QACPD,UAAU;IACZ;IAEA,OAAO;QAAEA;QAASD;IAAK;AACzB;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASI,qBAAqBT,MAAiB;IACpD,MAAM,EAAEC,QAAQ,EAAEC,WAAW,EAAEC,OAAO,EAAE,GAAGH;IAC3C,IAAIK,OAAOX,gBAAgBM;IAC3B,IAAIK,OAAOJ,UAAU;QACnBI,OAAOJ;IACT,OAAO,IAAII,OAAOF,UAAUD,eAAeG,OAAOJ,UAAU;QAC1DI,OAAOH,cAAcC;IACvB;IAEA,OAAO;QAAEG,SAAS;QAAUD;IAAK;AACnC;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASK,yBAAyBV,MAAiB;IACxD,MAAM,EAAEE,WAAW,EAAED,QAAQ,EAAEE,OAAO,EAAEC,eAAe,EAAE,GAAGJ;IAE5D,IAAIK,OAAOT,mBAAmBI;IAC9B,IAAIM,UAA8B;IAClC,IAAID,QAAQJ,UAAU;QACpB,OAAO;YAAEK;YAASD,MAAMM,KAAKC,GAAG,CAACP,MAAMH,cAAcC;QAAS;IAChE;IAEA,MAAMI,cAAcZ,kBAAkBK;IACtC,IAAII,mBAAmBG,cAAcJ,UAAUD,aAAa;QAC1DG,OAAOJ;IACT,OAAO;QACLI,OAAOM,KAAKE,GAAG,CAACN,aAAaN;QAC7BK,UAAU;IACZ;IAEA,OAAO;QAAEA;QAASD;IAAK;AACzB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASS,oBAAoBd,MAAiB;IACnD,MAAM,EAAEE,WAAW,EAAED,QAAQ,EAAEE,OAAO,EAAEC,eAAe,EAAE,GAAGJ;IAE5D,IAAIK,OAAOP,cAAcE;IACzB,IAAIM,UAA8B;IAClC,IAAID,OAAOF,WAAWD,aAAa;QACjC,OAAO;YAAEI;YAASD;QAAK;IACzB;IAEA,MAAME,cAAcV,aAAaG;IACjC,IAAII,mBAAmBG,cAAcN,UAAU;QAC7CI,OAAOH,cAAcC;IACvB,OAAO;QACLE,OAAOE;QACPD,UAAU;IACZ;IAEA,OAAO;QAAEA;QAASD;IAAK;AACzB;AAWA;;CAEC,GACD,OAAO,SAASU,iBAAiBC,OAA0B;IACzD,MAAM,EACJC,CAAC,EACDd,OAAO,EACPe,OAAO,EACPjB,QAAQ,EACRkB,QAAQ,EACRC,aAAa,EACblB,WAAW,EACXmB,UAAU,EACX,GAAGL;IAEJ,IAAIX,OAAOc,YAAYC,cAAcf,IAAI,GAAGa;IAE5C,IAAII,QAA4BF,cAAcE,KAAK,GAAGJ,UAAU;IAChE,IAAIK;IACJ,IAAIC;IACJ,IAAIH,YAAY;QACdE,WAAWD;QACX,4EAA4E;QAC5E,0EAA0E;QAC1E,2EAA2E;QAC3E,oCAAoC;QACpC,IAAInB,UAAUmB,OAAO;YACnBjB,QAAQ,AAACF,CAAAA,UAAUmB,KAAI,IAAK;YAC5BC,WAAWpB;QACb;QAEAmB,QAAQG;QACR,MAAMC,UAAUrB,OAAOF;QACvB,IAAIuB,UAAUxB,aAAa;YACzBG,QAAQqB,UAAUxB;YAClBsB,QAAQvB;QACV;QAEAI,OAAOM,KAAKE,GAAG,CAACZ,UAAUI;IAC5B;IAEA,4EAA4E;IAC5E,8DAA8D;IAC9D,OAAO;QACLA;QACAmB;QACAF;QACAC;QACAjB,SAASW;IACX;AACF;AAEA;;;;CAIC,GACD,OAAO,SAASU,yBACdX,OAAwC;IAExC,MAAM,EACJC,CAAC,EACDW,EAAE,EACF3B,QAAQ,EACRiB,OAAO,EACPI,KAAK,EACLnB,OAAO,EACPgB,QAAQ,EACRC,aAAa,EACbhB,eAAe,EAChB,GAAGY;IAEJ,MAAMd,cAAc0B,KAAK3B;IACzB,IAAIqB,UAAU,SAASA,UAAU,SAAS;QACxC,OAAOP,iBAAiB;YACtBE;YACAhB;YACAiB;YACAf;YACAgB;YACAC;YACAlB;YACAmB,YAAYC,UAAU;QACxB;IACF;IAEA,IAAInB,UAAUyB,KAAK3B,WAAW,GAAG;QAC/B,wEAAwE;QACxE,4EAA4E;QAC5E,aAAa;QACb,OAAO;YACLI,MAAMJ;YACNuB,OAAOvB;YACPK,SAASW;QACX;IACF;IAEA,MAAMjB,SAAoB;QACxBC;QACAiB;QACAf;QACAgB;QACAjB;QACAkB;QACAhB;IACF;IAEA,OAAQa;QACN,KAAK;YACH,OAAOlB,mBAAmBC;QAC5B,KAAK;YACH,OAAOQ,wBAAwBR;QACjC,KAAK;YACH,OAAOS,qBAAqBT;QAC9B,KAAK;YACH,OAAOU,yBAAyBV;QAClC,KAAK;YACH,OAAOc,oBAAoBd;IAC/B;AACF"}
+{"version":3,"sources":["../../src/positioning/createHorizontalPosition.ts"],"sourcesContent":["import { type FixedPositionOptions, type HorizontalPosition } from \"./types.js\";\nimport {\n  type XCoordConfig,\n  getCenterXCoord,\n  getInnerLeftCoord,\n  getInnerRightCoord,\n  getLeftCoord,\n  getRightCoord,\n} from \"./utils.js\";\n\n/**\n * @internal\n */\ninterface XPosition {\n  left: number;\n  right?: number;\n  width?: number;\n  minWidth?: number;\n  actualX: HorizontalPosition;\n}\n\n/**\n * @internal\n */\nexport interface FixConfig extends XCoordConfig {\n  vwMargin: number;\n  screenRight: number;\n  disableSwapping: boolean;\n}\n\n/**\n * @internal\n */\nexport interface CreateHorizontalPositionOptions\n  extends Required<\n    Pick<\n      FixedPositionOptions,\n      \"vwMargin\" | \"xMargin\" | \"width\" | \"disableSwapping\"\n    >\n  > {\n  x: HorizontalPosition;\n  vw: number;\n  elWidth: number;\n  initialX?: number;\n  containerRect: DOMRect;\n}\n\n/**\n * Attempts to position the fixed element so that it will appear to the left of\n * the container element but also within the viewport boundaries. When swapping\n * is enabled, it will attempt to swap to the right position if it can't fit\n * within the viewport to the left. If it can't fit in the viewport even after\n * being swapped to the right or swapping is disabled, it will be positioned to\n * the viewport left boundary.\n *\n * @internal\n */\nexport function createAnchoredLeft(config: FixConfig): XPosition {\n  const { vwMargin, screenRight, elWidth, disableSwapping } = config;\n\n  let left = getLeftCoord(config);\n  let actualX: HorizontalPosition = \"left\";\n  if (left >= vwMargin) {\n    return { actualX, left };\n  }\n\n  const swappedLeft = getRightCoord(config);\n  if (disableSwapping || swappedLeft + elWidth > screenRight) {\n    left = vwMargin;\n  } else {\n    left = swappedLeft;\n    actualX = \"right\";\n  }\n\n  return { actualX, left };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear to the\n * inner-left of the container element but also within the viewport boundaries.\n * When swapping is enabled, it will attempt to swap to the right position if it\n * can't fit within the viewport to the left. If it can't fit in the viewport\n * even after being swapped to the right or swapping is disabled, it will be\n * positioned to the viewport left boundary.\n *\n * @internal\n */\nexport function createAnchoredInnerLeft(config: FixConfig): XPosition {\n  const { vwMargin, screenRight, elWidth, disableSwapping } = config;\n\n  let left = getInnerLeftCoord(config);\n  let actualX: HorizontalPosition = \"inner-left\";\n  if (left + elWidth <= screenRight && left >= vwMargin) {\n    return { actualX, left };\n  }\n\n  if (disableSwapping) {\n    if (left + elWidth > screenRight) {\n      left = screenRight - elWidth;\n    } else {\n      left = vwMargin;\n    }\n\n    return { actualX, left };\n  }\n\n  const swappedLeft = getInnerRightCoord(config);\n  if (swappedLeft < vwMargin) {\n    left = vwMargin;\n  } else if (swappedLeft + elWidth > screenRight) {\n    left = screenRight - elWidth;\n    actualX = \"inner-right\";\n  } else {\n    left = swappedLeft;\n    actualX = \"inner-right\";\n  }\n\n  return { actualX, left };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear at the center\n * of the container element but also within the viewport boundaries. If the\n * centered element can't fit within the viewport, it will use the vwMargin\n * value if it overflowed to the left, it'll position to the screen right\n * boundary.\n *\n * @internal\n */\nexport function createAnchoredCenter(config: FixConfig): XPosition {\n  const { vwMargin, screenRight, elWidth } = config;\n  let left = getCenterXCoord(config);\n  if (left < vwMargin) {\n    left = vwMargin;\n  } else if (left + elWidth > screenRight || left < vwMargin) {\n    left = screenRight - elWidth;\n  }\n\n  return { actualX: \"center\", left };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear to the\n * inner-right of the container element but also within the viewport boundaries.\n * When swapping is enabled, it will attempt to swap to the inner-left position\n * if it can't fit within the viewport to the right. If it can't fit in the\n * viewport even after being swapped to the left or swapping is disabled, it\n * will be positioned to the viewport right boundary.\n *\n * @internal\n */\nexport function createAnchoredInnerRight(config: FixConfig): XPosition {\n  const { screenRight, vwMargin, elWidth, disableSwapping } = config;\n\n  let left = getInnerRightCoord(config);\n  let actualX: HorizontalPosition = \"inner-right\";\n  if (left >= vwMargin) {\n    return { actualX, left: Math.min(left, screenRight - elWidth) };\n  }\n\n  const swappedLeft = getInnerLeftCoord(config);\n  if (disableSwapping || swappedLeft + elWidth > screenRight) {\n    left = vwMargin;\n  } else {\n    left = Math.max(swappedLeft, vwMargin);\n    actualX = \"inner-left\";\n  }\n\n  return { actualX, left };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear to the right of\n * the container element but also within the viewport boundaries. When swapping\n * is enabled, it will attempt to swap to the left position if it can't fit\n * within the viewport to the right. If it can't fit in the viewport even after\n * being swapped to the left or swapping is disabled, it will be positioned to\n * the viewport right boundary.\n *\n * @internal\n */\nexport function createAnchoredRight(config: FixConfig): XPosition {\n  const { screenRight, vwMargin, elWidth, disableSwapping } = config;\n\n  let left = getRightCoord(config);\n  let actualX: HorizontalPosition = \"right\";\n  if (left + elWidth <= screenRight) {\n    return { actualX, left };\n  }\n\n  const swappedLeft = getLeftCoord(config);\n  if (disableSwapping || swappedLeft < vwMargin) {\n    left = screenRight - elWidth;\n  } else {\n    left = swappedLeft;\n    actualX = \"left\";\n  }\n\n  return { actualX, left };\n}\n\nexport interface EqualWidthOptions\n  extends Pick<\n    CreateHorizontalPositionOptions,\n    \"x\" | \"elWidth\" | \"xMargin\" | \"vwMargin\" | \"containerRect\" | \"initialX\"\n  > {\n  screenRight: number;\n  isMinWidth: boolean;\n}\n\n/**\n * @internal\n */\nexport function createEqualWidth(options: EqualWidthOptions): XPosition {\n  const {\n    x,\n    elWidth,\n    xMargin,\n    vwMargin,\n    initialX,\n    containerRect,\n    screenRight,\n    isMinWidth,\n  } = options;\n\n  let left = initialX ?? containerRect.left + xMargin;\n\n  let width: number | undefined = containerRect.width - xMargin * 2;\n  let minWidth: number | undefined;\n  let right: number | undefined;\n  if (isMinWidth) {\n    minWidth = width;\n    // if the fixed element has a width greater than the element it is fixed to,\n    // update the width to be the fixed element's width. since the \"min-width\"\n    // option is only possible for horizontally centered elements, need to then\n    // update the `left` position again.\n    if (elWidth > width) {\n      left -= (elWidth - width) / 2;\n      minWidth = elWidth;\n    }\n\n    width = undefined;\n    const elRight = left + elWidth;\n    if (elRight > screenRight) {\n      left -= elRight - screenRight;\n      right = vwMargin;\n    }\n\n    left = Math.max(vwMargin, left);\n  }\n\n  // going to assume that the container element is visible in the DOM and just\n  // make the fixed element have the same left and right corners\n  return {\n    left,\n    right,\n    width,\n    minWidth,\n    actualX: x,\n  };\n}\n\n/**\n * Creates the horizontal position for a fixed element with the provided\n * options.\n * @internal\n */\nexport function createHorizontalPosition(\n  options: CreateHorizontalPositionOptions\n): XPosition {\n  const {\n    x,\n    vw,\n    vwMargin,\n    xMargin,\n    width,\n    elWidth,\n    initialX,\n    containerRect,\n    disableSwapping,\n  } = options;\n\n  const screenRight = vw - vwMargin;\n  if (width === \"min\" || width === \"equal\") {\n    return createEqualWidth({\n      x,\n      vwMargin,\n      xMargin,\n      elWidth,\n      initialX,\n      containerRect,\n      screenRight,\n      isMinWidth: width === \"min\",\n    });\n  }\n\n  if (elWidth > vw - vwMargin * 2) {\n    // if the element's width is greater than the viewport's width minus the\n    // margin on both sides, just make the element span the entire viewport with\n    // the margin\n    return {\n      left: vwMargin,\n      right: vwMargin,\n      actualX: x,\n    };\n  }\n\n  const config: FixConfig = {\n    vwMargin,\n    xMargin,\n    elWidth,\n    initialX,\n    screenRight,\n    containerRect,\n    disableSwapping,\n  };\n\n  switch (x) {\n    case \"left\":\n      return createAnchoredLeft(config);\n    case \"inner-left\":\n      return createAnchoredInnerLeft(config);\n    case \"center\":\n      return createAnchoredCenter(config);\n    case \"inner-right\":\n      return createAnchoredInnerRight(config);\n    case \"right\":\n      return createAnchoredRight(config);\n  }\n}\n"],"names":["getCenterXCoord","getInnerLeftCoord","getInnerRightCoord","getLeftCoord","getRightCoord","createAnchoredLeft","config","vwMargin","screenRight","elWidth","disableSwapping","left","actualX","swappedLeft","createAnchoredInnerLeft","createAnchoredCenter","createAnchoredInnerRight","Math","min","max","createAnchoredRight","createEqualWidth","options","x","xMargin","initialX","containerRect","isMinWidth","width","minWidth","right","undefined","elRight","createHorizontalPosition","vw"],"mappings":"AACA,SAEEA,eAAe,EACfC,iBAAiB,EACjBC,kBAAkB,EAClBC,YAAY,EACZC,aAAa,QACR,aAAa;AAuCpB;;;;;;;;;CASC,GACD,OAAO,SAASC,mBAAmBC,MAAiB;IAClD,MAAM,EAAEC,QAAQ,EAAEC,WAAW,EAAEC,OAAO,EAAEC,eAAe,EAAE,GAAGJ;IAE5D,IAAIK,OAAOR,aAAaG;IACxB,IAAIM,UAA8B;IAClC,IAAID,QAAQJ,UAAU;QACpB,OAAO;YAAEK;YAASD;QAAK;IACzB;IAEA,MAAME,cAAcT,cAAcE;IAClC,IAAII,mBAAmBG,cAAcJ,UAAUD,aAAa;QAC1DG,OAAOJ;IACT,OAAO;QACLI,OAAOE;QACPD,UAAU;IACZ;IAEA,OAAO;QAAEA;QAASD;IAAK;AACzB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASG,wBAAwBR,MAAiB;IACvD,MAAM,EAAEC,QAAQ,EAAEC,WAAW,EAAEC,OAAO,EAAEC,eAAe,EAAE,GAAGJ;IAE5D,IAAIK,OAAOV,kBAAkBK;IAC7B,IAAIM,UAA8B;IAClC,IAAID,OAAOF,WAAWD,eAAeG,QAAQJ,UAAU;QACrD,OAAO;YAAEK;YAASD;QAAK;IACzB;IAEA,IAAID,iBAAiB;QACnB,IAAIC,OAAOF,UAAUD,aAAa;YAChCG,OAAOH,cAAcC;QACvB,OAAO;YACLE,OAAOJ;QACT;QAEA,OAAO;YAAEK;YAASD;QAAK;IACzB;IAEA,MAAME,cAAcX,mBAAmBI;IACvC,IAAIO,cAAcN,UAAU;QAC1BI,OAAOJ;IACT,OAAO,IAAIM,cAAcJ,UAAUD,aAAa;QAC9CG,OAAOH,cAAcC;QACrBG,UAAU;IACZ,OAAO;QACLD,OAAOE;QACPD,UAAU;IACZ;IAEA,OAAO;QAAEA;QAASD;IAAK;AACzB;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASI,qBAAqBT,MAAiB;IACpD,MAAM,EAAEC,QAAQ,EAAEC,WAAW,EAAEC,OAAO,EAAE,GAAGH;IAC3C,IAAIK,OAAOX,gBAAgBM;IAC3B,IAAIK,OAAOJ,UAAU;QACnBI,OAAOJ;IACT,OAAO,IAAII,OAAOF,UAAUD,eAAeG,OAAOJ,UAAU;QAC1DI,OAAOH,cAAcC;IACvB;IAEA,OAAO;QAAEG,SAAS;QAAUD;IAAK;AACnC;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASK,yBAAyBV,MAAiB;IACxD,MAAM,EAAEE,WAAW,EAAED,QAAQ,EAAEE,OAAO,EAAEC,eAAe,EAAE,GAAGJ;IAE5D,IAAIK,OAAOT,mBAAmBI;IAC9B,IAAIM,UAA8B;IAClC,IAAID,QAAQJ,UAAU;QACpB,OAAO;YAAEK;YAASD,MAAMM,KAAKC,GAAG,CAACP,MAAMH,cAAcC;QAAS;IAChE;IAEA,MAAMI,cAAcZ,kBAAkBK;IACtC,IAAII,mBAAmBG,cAAcJ,UAAUD,aAAa;QAC1DG,OAAOJ;IACT,OAAO;QACLI,OAAOM,KAAKE,GAAG,CAACN,aAAaN;QAC7BK,UAAU;IACZ;IAEA,OAAO;QAAEA;QAASD;IAAK;AACzB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASS,oBAAoBd,MAAiB;IACnD,MAAM,EAAEE,WAAW,EAAED,QAAQ,EAAEE,OAAO,EAAEC,eAAe,EAAE,GAAGJ;IAE5D,IAAIK,OAAOP,cAAcE;IACzB,IAAIM,UAA8B;IAClC,IAAID,OAAOF,WAAWD,aAAa;QACjC,OAAO;YAAEI;YAASD;QAAK;IACzB;IAEA,MAAME,cAAcV,aAAaG;IACjC,IAAII,mBAAmBG,cAAcN,UAAU;QAC7CI,OAAOH,cAAcC;IACvB,OAAO;QACLE,OAAOE;QACPD,UAAU;IACZ;IAEA,OAAO;QAAEA;QAASD;IAAK;AACzB;AAWA;;CAEC,GACD,OAAO,SAASU,iBAAiBC,OAA0B;IACzD,MAAM,EACJC,CAAC,EACDd,OAAO,EACPe,OAAO,EACPjB,QAAQ,EACRkB,QAAQ,EACRC,aAAa,EACblB,WAAW,EACXmB,UAAU,EACX,GAAGL;IAEJ,IAAIX,OAAOc,YAAYC,cAAcf,IAAI,GAAGa;IAE5C,IAAII,QAA4BF,cAAcE,KAAK,GAAGJ,UAAU;IAChE,IAAIK;IACJ,IAAIC;IACJ,IAAIH,YAAY;QACdE,WAAWD;QACX,4EAA4E;QAC5E,0EAA0E;QAC1E,2EAA2E;QAC3E,oCAAoC;QACpC,IAAInB,UAAUmB,OAAO;YACnBjB,QAAQ,AAACF,CAAAA,UAAUmB,KAAI,IAAK;YAC5BC,WAAWpB;QACb;QAEAmB,QAAQG;QACR,MAAMC,UAAUrB,OAAOF;QACvB,IAAIuB,UAAUxB,aAAa;YACzBG,QAAQqB,UAAUxB;YAClBsB,QAAQvB;QACV;QAEAI,OAAOM,KAAKE,GAAG,CAACZ,UAAUI;IAC5B;IAEA,4EAA4E;IAC5E,8DAA8D;IAC9D,OAAO;QACLA;QACAmB;QACAF;QACAC;QACAjB,SAASW;IACX;AACF;AAEA;;;;CAIC,GACD,OAAO,SAASU,yBACdX,OAAwC;IAExC,MAAM,EACJC,CAAC,EACDW,EAAE,EACF3B,QAAQ,EACRiB,OAAO,EACPI,KAAK,EACLnB,OAAO,EACPgB,QAAQ,EACRC,aAAa,EACbhB,eAAe,EAChB,GAAGY;IAEJ,MAAMd,cAAc0B,KAAK3B;IACzB,IAAIqB,UAAU,SAASA,UAAU,SAAS;QACxC,OAAOP,iBAAiB;YACtBE;YACAhB;YACAiB;YACAf;YACAgB;YACAC;YACAlB;YACAmB,YAAYC,UAAU;QACxB;IACF;IAEA,IAAInB,UAAUyB,KAAK3B,WAAW,GAAG;QAC/B,wEAAwE;QACxE,4EAA4E;QAC5E,aAAa;QACb,OAAO;YACLI,MAAMJ;YACNuB,OAAOvB;YACPK,SAASW;QACX;IACF;IAEA,MAAMjB,SAAoB;QACxBC;QACAiB;QACAf;QACAgB;QACAjB;QACAkB;QACAhB;IACF;IAEA,OAAQa;QACN,KAAK;YACH,OAAOlB,mBAAmBC;QAC5B,KAAK;YACH,OAAOQ,wBAAwBR;QACjC,KAAK;YACH,OAAOS,qBAAqBT;QAC9B,KAAK;YACH,OAAOU,yBAAyBV;QAClC,KAAK;YACH,OAAOc,oBAAoBd;IAC/B;AACF"}

package/dist/positioning/createVerticalPosition.d.ts

@@ -1,11 +1,11 @@
-import type { YCoordConfig } from "./utils.js";
-import type { FixedPositionOptions, VerticalPosition } from "./types.js";
+import { type FixedPositionOptions, type VerticalPosition } from "./types.js";
+import { type YCoordConfig } from "./utils.js";
 /** @internal */
 interface YPosition {
     top: number;
     bottom?: number;
     actualY: VerticalPosition;
-    /** @remarks \@since 6.0.0 */
+    /** @since 5.1.6 */
     transformOriginY?: number;
 }
 /** @internal */

package/dist/positioning/createVerticalPosition.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/positioning/createVerticalPosition.ts"],"sourcesContent":["import type { YCoordConfig } from \"./utils.js\";\nimport {\n  getAboveCoord,\n  getBelowCoord,\n  getBottomCoord,\n  getCenterYCoord,\n  getTopCoord,\n} from \"./utils.js\";\nimport type { FixedPositionOptions, VerticalPosition } from \"./types.js\";\n\n/** @internal */\ninterface YPosition {\n  top: number;\n  bottom?: number;\n  actualY: VerticalPosition;\n  /** @remarks \\@since 6.0.0 */\n  transformOriginY?: number;\n}\n\n/** @internal */\nexport interface FixConfig extends YCoordConfig {\n  vhMargin: number;\n  screenBottom: number;\n  preventOverlap: boolean;\n  disableSwapping: boolean;\n  disableVHBounds: boolean;\n}\n\n/** @internal */\nexport interface CreateVerticalPositionOptions\n  extends Required<\n    Pick<\n      FixedPositionOptions,\n      | \"yMargin\"\n      | \"vhMargin\"\n      | \"preventOverlap\"\n      | \"disableSwapping\"\n      | \"disableVHBounds\"\n    >\n  > {\n  y: VerticalPosition;\n  vh: number;\n  initialY?: number;\n  elHeight: number;\n  containerRect: DOMRect;\n}\n\n/**\n * Attempts to position the fixed element so that it will appear completely\n * above the container element but also within the viewport boundaries. When\n * swapping is enabled, it will attempt to swap to the below position if it\n * can't fit within the viewport above the container element. If it can't fit in\n * the viewport even after being swapped below or swapping is disabled, it will\n * be positioned to the top viewport boundary.\n *\n * @internal\n */\nexport function createAnchoredAbove(config: FixConfig): YPosition {\n  const {\n    yMargin,\n    vhMargin,\n    screenBottom,\n    elHeight,\n    containerRect,\n    preventOverlap,\n    disableSwapping,\n    disableVHBounds,\n  } = config;\n  let top = getAboveCoord(config);\n  let actualY: VerticalPosition = \"above\";\n\n  if (disableVHBounds) {\n    // can't actually allow a top value as a negative number since browsers\n    // won't scroll upwards past the normal page top\n    return { actualY, top: Math.max(0, top) };\n  }\n\n  if (top > vhMargin) {\n    // don't need to do anything else since the top is still in the viewport and\n    // since it's positioned above, we already know it can't overlap the\n    // container element\n    return { actualY, top };\n  }\n\n  const swappedTop = getBelowCoord(config);\n  if (disableSwapping || swappedTop + elHeight > screenBottom) {\n    top = Math.min(top, vhMargin);\n  } else {\n    actualY = \"below\";\n    top = swappedTop;\n  }\n\n  let bottom: number | undefined;\n  if (\n    preventOverlap &&\n    // can't overlap if it's positioned below\n    actualY === \"above\" &&\n    top + elHeight > containerRect.top\n  ) {\n    bottom = screenBottom - containerRect.top + yMargin;\n  }\n\n  return { actualY, top, bottom };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear fixed to the\n * top of the container element but also within the viewport boundaries. When\n * swapping is enabled, it will attempt to swap to the bottom position if it\n * can't fit within the viewport. If it can't fit in the viewport even after\n * being swapped to the bottom position or swapping is disabled, it will be\n * positioned to the top viewport boundary.\n *\n * @internal\n */\nexport function createAnchoredTop(config: FixConfig): YPosition {\n  const { vhMargin, screenBottom, elHeight, disableSwapping, disableVHBounds } =\n    config;\n  let top = getTopCoord(config);\n  let actualY: VerticalPosition = \"top\";\n\n  if (disableVHBounds || top + elHeight <= screenBottom) {\n    return { actualY, top };\n  }\n\n  const swappedTop = getBottomCoord(config);\n  if (disableSwapping || swappedTop < vhMargin) {\n    top = Math.max(top, vhMargin);\n  } else {\n    actualY = \"bottom\";\n    top = swappedTop;\n  }\n\n  return { actualY, top };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear at the center\n * of the container element but also within the viewport boundaries. If the\n * entered element can't fit within the viewport, it'll update the top value\n * to either be the vhMargin or position to the screen bottom boundary\n *\n * @internal\n */\nexport function createAnchoredCenter(config: FixConfig): YPosition {\n  const { vhMargin, screenBottom, elHeight, disableVHBounds } = config;\n  let top = getCenterYCoord(config);\n  const actualY: VerticalPosition = \"center\";\n  if (disableVHBounds) {\n    return { actualY, top: Math.max(0, top) };\n  }\n\n  top = Math.max(vhMargin, top);\n  if (top + elHeight > screenBottom) {\n    top = screenBottom - elHeight;\n  }\n\n  return { actualY, top };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear fixed to the\n * bottom of the container element but also within the viewport boundaries. When\n * swapping is enabled, it will attempt to swap to the top position if it can't\n * fit within the viewport. If it can't fit in the viewport even after being\n * swapped to the top position or swapping is disabled, it will be positioned to\n * the bottom viewport boundary.\n *\n * @internal\n */\nexport function createAnchoredBottom(config: FixConfig): YPosition {\n  const { vhMargin, screenBottom, elHeight, disableSwapping, disableVHBounds } =\n    config;\n  let top = getBottomCoord(config);\n  let actualY: VerticalPosition = \"bottom\";\n  if (disableVHBounds || top > vhMargin) {\n    return { actualY, top };\n  }\n\n  const swappedTop = getTopCoord(config);\n  if (disableSwapping || swappedTop + elHeight > screenBottom) {\n    top = Math.min(top, screenBottom - elHeight);\n  } else {\n    actualY = \"top\";\n    top = swappedTop;\n  }\n\n  return { actualY, top };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear completely\n * below the container element but also within the viewport boundaries. When\n * swapping is enabled, it will attempt to swap to the above position if it\n * can't fit within the viewport below the container element. If it can't fit in\n * the viewport even after being swapped above or swapping is disabled, it will\n * be positioned to the bottom viewport boundary.\n *\n * @internal\n */\nexport function createAnchoredBelow(config: FixConfig): YPosition {\n  const {\n    yMargin,\n    vhMargin,\n    elHeight,\n    screenBottom,\n    containerRect,\n    preventOverlap,\n    disableSwapping,\n    disableVHBounds,\n  } = config;\n  let top = getBelowCoord(config);\n  let actualY: VerticalPosition = \"below\";\n  if (disableVHBounds || top + elHeight <= screenBottom) {\n    return { actualY, top };\n  }\n\n  if (preventOverlap) {\n    const availableTop = containerRect.top - yMargin;\n    if (disableSwapping || availableTop < screenBottom - top) {\n      return {\n        actualY,\n        top,\n        bottom: vhMargin,\n      };\n    }\n\n    return {\n      actualY: \"above\",\n      top: Math.max(vhMargin, availableTop - elHeight),\n      // this makes it so that the bottom of the fixed element is the top of the container\n      // element. this ensures that it won't ever overlap the container element\n      bottom: window.innerHeight - availableTop,\n    };\n  }\n\n  const swappedTop = getAboveCoord(config);\n  if (disableSwapping || swappedTop < vhMargin) {\n    top = Math.min(top, screenBottom - elHeight);\n  } else {\n    actualY = \"above\";\n    top = swappedTop;\n  }\n\n  return { actualY, top };\n}\n\n/**\n * Creates the vertical position for a fixed element with the provided options.\n *\n * @internal\n */\nexport function createVerticalPosition(\n  options: CreateVerticalPositionOptions\n): YPosition {\n  const {\n    y,\n    vh,\n    vhMargin,\n    yMargin,\n    elHeight,\n    initialY,\n    containerRect,\n    disableSwapping,\n    preventOverlap,\n    disableVHBounds,\n  } = options;\n\n  if (!disableVHBounds && !preventOverlap && elHeight > vh - vhMargin * 2) {\n    // the element is too big to be displayed in the viewport, so just span the\n    // full viewport excluding margins\n    return {\n      top: vhMargin,\n      bottom: vhMargin,\n      actualY: \"center\",\n      transformOriginY: containerRect.top,\n    };\n  }\n\n  const config: FixConfig = {\n    vhMargin,\n    yMargin,\n    elHeight,\n    initialY,\n    containerRect,\n    screenBottom: vh - vhMargin,\n    preventOverlap,\n    disableSwapping,\n    disableVHBounds,\n  };\n\n  switch (y) {\n    case \"above\":\n      return createAnchoredAbove(config);\n    case \"top\":\n      return createAnchoredTop(config);\n    case \"center\":\n      return createAnchoredCenter(config);\n    case \"bottom\":\n      return createAnchoredBottom(config);\n    case \"below\":\n      return createAnchoredBelow(config);\n  }\n}\n"],"names":["getAboveCoord","getBelowCoord","getBottomCoord","getCenterYCoord","getTopCoord","createAnchoredAbove","config","yMargin","vhMargin","screenBottom","elHeight","containerRect","preventOverlap","disableSwapping","disableVHBounds","top","actualY","Math","max","swappedTop","min","bottom","createAnchoredTop","createAnchoredCenter","createAnchoredBottom","createAnchoredBelow","availableTop","window","innerHeight","createVerticalPosition","options","y","vh","initialY","transformOriginY"],"mappings":"AACA,SACEA,aAAa,EACbC,aAAa,EACbC,cAAc,EACdC,eAAe,EACfC,WAAW,QACN,aAAa;AAwCpB;;;;;;;;;CASC,GACD,OAAO,SAASC,oBAAoBC,MAAiB;IACnD,MAAM,EACJC,OAAO,EACPC,QAAQ,EACRC,YAAY,EACZC,QAAQ,EACRC,aAAa,EACbC,cAAc,EACdC,eAAe,EACfC,eAAe,EAChB,GAAGR;IACJ,IAAIS,MAAMf,cAAcM;IACxB,IAAIU,UAA4B;IAEhC,IAAIF,iBAAiB;QACnB,uEAAuE;QACvE,gDAAgD;QAChD,OAAO;YAAEE;YAASD,KAAKE,KAAKC,GAAG,CAAC,GAAGH;QAAK;IAC1C;IAEA,IAAIA,MAAMP,UAAU;QAClB,4EAA4E;QAC5E,oEAAoE;QACpE,oBAAoB;QACpB,OAAO;YAAEQ;YAASD;QAAI;IACxB;IAEA,MAAMI,aAAalB,cAAcK;IACjC,IAAIO,mBAAmBM,aAAaT,WAAWD,cAAc;QAC3DM,MAAME,KAAKG,GAAG,CAACL,KAAKP;IACtB,OAAO;QACLQ,UAAU;QACVD,MAAMI;IACR;IAEA,IAAIE;IACJ,IACET,kBACA,yCAAyC;IACzCI,YAAY,WACZD,MAAML,WAAWC,cAAcI,GAAG,EAClC;QACAM,SAASZ,eAAeE,cAAcI,GAAG,GAAGR;IAC9C;IAEA,OAAO;QAAES;QAASD;QAAKM;IAAO;AAChC;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASC,kBAAkBhB,MAAiB;IACjD,MAAM,EAAEE,QAAQ,EAAEC,YAAY,EAAEC,QAAQ,EAAEG,eAAe,EAAEC,eAAe,EAAE,GAC1ER;IACF,IAAIS,MAAMX,YAAYE;IACtB,IAAIU,UAA4B;IAEhC,IAAIF,mBAAmBC,MAAML,YAAYD,cAAc;QACrD,OAAO;YAAEO;YAASD;QAAI;IACxB;IAEA,MAAMI,aAAajB,eAAeI;IAClC,IAAIO,mBAAmBM,aAAaX,UAAU;QAC5CO,MAAME,KAAKC,GAAG,CAACH,KAAKP;IACtB,OAAO;QACLQ,UAAU;QACVD,MAAMI;IACR;IAEA,OAAO;QAAEH;QAASD;IAAI;AACxB;AAEA;;;;;;;CAOC,GACD,OAAO,SAASQ,qBAAqBjB,MAAiB;IACpD,MAAM,EAAEE,QAAQ,EAAEC,YAAY,EAAEC,QAAQ,EAAEI,eAAe,EAAE,GAAGR;IAC9D,IAAIS,MAAMZ,gBAAgBG;IAC1B,MAAMU,UAA4B;IAClC,IAAIF,iBAAiB;QACnB,OAAO;YAAEE;YAASD,KAAKE,KAAKC,GAAG,CAAC,GAAGH;QAAK;IAC1C;IAEAA,MAAME,KAAKC,GAAG,CAACV,UAAUO;IACzB,IAAIA,MAAML,WAAWD,cAAc;QACjCM,MAAMN,eAAeC;IACvB;IAEA,OAAO;QAAEM;QAASD;IAAI;AACxB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASS,qBAAqBlB,MAAiB;IACpD,MAAM,EAAEE,QAAQ,EAAEC,YAAY,EAAEC,QAAQ,EAAEG,eAAe,EAAEC,eAAe,EAAE,GAC1ER;IACF,IAAIS,MAAMb,eAAeI;IACzB,IAAIU,UAA4B;IAChC,IAAIF,mBAAmBC,MAAMP,UAAU;QACrC,OAAO;YAAEQ;YAASD;QAAI;IACxB;IAEA,MAAMI,aAAaf,YAAYE;IAC/B,IAAIO,mBAAmBM,aAAaT,WAAWD,cAAc;QAC3DM,MAAME,KAAKG,GAAG,CAACL,KAAKN,eAAeC;IACrC,OAAO;QACLM,UAAU;QACVD,MAAMI;IACR;IAEA,OAAO;QAAEH;QAASD;IAAI;AACxB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASU,oBAAoBnB,MAAiB;IACnD,MAAM,EACJC,OAAO,EACPC,QAAQ,EACRE,QAAQ,EACRD,YAAY,EACZE,aAAa,EACbC,cAAc,EACdC,eAAe,EACfC,eAAe,EAChB,GAAGR;IACJ,IAAIS,MAAMd,cAAcK;IACxB,IAAIU,UAA4B;IAChC,IAAIF,mBAAmBC,MAAML,YAAYD,cAAc;QACrD,OAAO;YAAEO;YAASD;QAAI;IACxB;IAEA,IAAIH,gBAAgB;QAClB,MAAMc,eAAef,cAAcI,GAAG,GAAGR;QACzC,IAAIM,mBAAmBa,eAAejB,eAAeM,KAAK;YACxD,OAAO;gBACLC;gBACAD;gBACAM,QAAQb;YACV;QACF;QAEA,OAAO;YACLQ,SAAS;YACTD,KAAKE,KAAKC,GAAG,CAACV,UAAUkB,eAAehB;YACvC,oFAAoF;YACpF,yEAAyE;YACzEW,QAAQM,OAAOC,WAAW,GAAGF;QAC/B;IACF;IAEA,MAAMP,aAAanB,cAAcM;IACjC,IAAIO,mBAAmBM,aAAaX,UAAU;QAC5CO,MAAME,KAAKG,GAAG,CAACL,KAAKN,eAAeC;IACrC,OAAO;QACLM,UAAU;QACVD,MAAMI;IACR;IAEA,OAAO;QAAEH;QAASD;IAAI;AACxB;AAEA;;;;CAIC,GACD,OAAO,SAASc,uBACdC,OAAsC;IAEtC,MAAM,EACJC,CAAC,EACDC,EAAE,EACFxB,QAAQ,EACRD,OAAO,EACPG,QAAQ,EACRuB,QAAQ,EACRtB,aAAa,EACbE,eAAe,EACfD,cAAc,EACdE,eAAe,EAChB,GAAGgB;IAEJ,IAAI,CAAChB,mBAAmB,CAACF,kBAAkBF,WAAWsB,KAAKxB,WAAW,GAAG;QACvE,2EAA2E;QAC3E,kCAAkC;QAClC,OAAO;YACLO,KAAKP;YACLa,QAAQb;YACRQ,SAAS;YACTkB,kBAAkBvB,cAAcI,GAAG;QACrC;IACF;IAEA,MAAMT,SAAoB;QACxBE;QACAD;QACAG;QACAuB;QACAtB;QACAF,cAAcuB,KAAKxB;QACnBI;QACAC;QACAC;IACF;IAEA,OAAQiB;QACN,KAAK;YACH,OAAO1B,oBAAoBC;QAC7B,KAAK;YACH,OAAOgB,kBAAkBhB;QAC3B,KAAK;YACH,OAAOiB,qBAAqBjB;QAC9B,KAAK;YACH,OAAOkB,qBAAqBlB;QAC9B,KAAK;YACH,OAAOmB,oBAAoBnB;IAC/B;AACF"}
+{"version":3,"sources":["../../src/positioning/createVerticalPosition.ts"],"sourcesContent":["import { type FixedPositionOptions, type VerticalPosition } from \"./types.js\";\nimport {\n  type YCoordConfig,\n  getAboveCoord,\n  getBelowCoord,\n  getBottomCoord,\n  getCenterYCoord,\n  getTopCoord,\n} from \"./utils.js\";\n\n/** @internal */\ninterface YPosition {\n  top: number;\n  bottom?: number;\n  actualY: VerticalPosition;\n  /** @since 5.1.6 */\n  transformOriginY?: number;\n}\n\n/** @internal */\nexport interface FixConfig extends YCoordConfig {\n  vhMargin: number;\n  screenBottom: number;\n  preventOverlap: boolean;\n  disableSwapping: boolean;\n  disableVHBounds: boolean;\n}\n\n/** @internal */\nexport interface CreateVerticalPositionOptions\n  extends Required<\n    Pick<\n      FixedPositionOptions,\n      | \"yMargin\"\n      | \"vhMargin\"\n      | \"preventOverlap\"\n      | \"disableSwapping\"\n      | \"disableVHBounds\"\n    >\n  > {\n  y: VerticalPosition;\n  vh: number;\n  initialY?: number;\n  elHeight: number;\n  containerRect: DOMRect;\n}\n\n/**\n * Attempts to position the fixed element so that it will appear completely\n * above the container element but also within the viewport boundaries. When\n * swapping is enabled, it will attempt to swap to the below position if it\n * can't fit within the viewport above the container element. If it can't fit in\n * the viewport even after being swapped below or swapping is disabled, it will\n * be positioned to the top viewport boundary.\n *\n * @internal\n */\nexport function createAnchoredAbove(config: FixConfig): YPosition {\n  const {\n    yMargin,\n    vhMargin,\n    screenBottom,\n    elHeight,\n    containerRect,\n    preventOverlap,\n    disableSwapping,\n    disableVHBounds,\n  } = config;\n  let top = getAboveCoord(config);\n  let actualY: VerticalPosition = \"above\";\n\n  if (disableVHBounds) {\n    // can't actually allow a top value as a negative number since browsers\n    // won't scroll upwards past the normal page top\n    return { actualY, top: Math.max(0, top) };\n  }\n\n  if (top > vhMargin) {\n    // don't need to do anything else since the top is still in the viewport and\n    // since it's positioned above, we already know it can't overlap the\n    // container element\n    return { actualY, top };\n  }\n\n  const swappedTop = getBelowCoord(config);\n  if (disableSwapping || swappedTop + elHeight > screenBottom) {\n    top = Math.min(top, vhMargin);\n  } else {\n    actualY = \"below\";\n    top = swappedTop;\n  }\n\n  let bottom: number | undefined;\n  if (\n    preventOverlap &&\n    // can't overlap if it's positioned below\n    actualY === \"above\" &&\n    top + elHeight > containerRect.top\n  ) {\n    bottom = screenBottom - containerRect.top + yMargin;\n  }\n\n  return { actualY, top, bottom };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear fixed to the\n * top of the container element but also within the viewport boundaries. When\n * swapping is enabled, it will attempt to swap to the bottom position if it\n * can't fit within the viewport. If it can't fit in the viewport even after\n * being swapped to the bottom position or swapping is disabled, it will be\n * positioned to the top viewport boundary.\n *\n * @internal\n */\nexport function createAnchoredTop(config: FixConfig): YPosition {\n  const { vhMargin, screenBottom, elHeight, disableSwapping, disableVHBounds } =\n    config;\n  let top = getTopCoord(config);\n  let actualY: VerticalPosition = \"top\";\n\n  if (disableVHBounds || top + elHeight <= screenBottom) {\n    return { actualY, top };\n  }\n\n  const swappedTop = getBottomCoord(config);\n  if (disableSwapping || swappedTop < vhMargin) {\n    top = Math.max(top, vhMargin);\n  } else {\n    actualY = \"bottom\";\n    top = swappedTop;\n  }\n\n  return { actualY, top };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear at the center\n * of the container element but also within the viewport boundaries. If the\n * entered element can't fit within the viewport, it'll update the top value\n * to either be the vhMargin or position to the screen bottom boundary\n *\n * @internal\n */\nexport function createAnchoredCenter(config: FixConfig): YPosition {\n  const { vhMargin, screenBottom, elHeight, disableVHBounds } = config;\n  let top = getCenterYCoord(config);\n  const actualY: VerticalPosition = \"center\";\n  if (disableVHBounds) {\n    return { actualY, top: Math.max(0, top) };\n  }\n\n  top = Math.max(vhMargin, top);\n  if (top + elHeight > screenBottom) {\n    top = screenBottom - elHeight;\n  }\n\n  return { actualY, top };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear fixed to the\n * bottom of the container element but also within the viewport boundaries. When\n * swapping is enabled, it will attempt to swap to the top position if it can't\n * fit within the viewport. If it can't fit in the viewport even after being\n * swapped to the top position or swapping is disabled, it will be positioned to\n * the bottom viewport boundary.\n *\n * @internal\n */\nexport function createAnchoredBottom(config: FixConfig): YPosition {\n  const { vhMargin, screenBottom, elHeight, disableSwapping, disableVHBounds } =\n    config;\n  let top = getBottomCoord(config);\n  let actualY: VerticalPosition = \"bottom\";\n  if (disableVHBounds || top > vhMargin) {\n    return { actualY, top };\n  }\n\n  const swappedTop = getTopCoord(config);\n  if (disableSwapping || swappedTop + elHeight > screenBottom) {\n    top = Math.min(top, screenBottom - elHeight);\n  } else {\n    actualY = \"top\";\n    top = swappedTop;\n  }\n\n  return { actualY, top };\n}\n\n/**\n * Attempts to position the fixed element so that it will appear completely\n * below the container element but also within the viewport boundaries. When\n * swapping is enabled, it will attempt to swap to the above position if it\n * can't fit within the viewport below the container element. If it can't fit in\n * the viewport even after being swapped above or swapping is disabled, it will\n * be positioned to the bottom viewport boundary.\n *\n * @internal\n */\nexport function createAnchoredBelow(config: FixConfig): YPosition {\n  const {\n    yMargin,\n    vhMargin,\n    elHeight,\n    screenBottom,\n    containerRect,\n    preventOverlap,\n    disableSwapping,\n    disableVHBounds,\n  } = config;\n  let top = getBelowCoord(config);\n  let actualY: VerticalPosition = \"below\";\n  if (disableVHBounds || top + elHeight <= screenBottom) {\n    return { actualY, top };\n  }\n\n  if (preventOverlap) {\n    const availableTop = containerRect.top - yMargin;\n    if (disableSwapping || availableTop < screenBottom - top) {\n      return {\n        actualY,\n        top,\n        bottom: vhMargin,\n      };\n    }\n\n    return {\n      actualY: \"above\",\n      top: Math.max(vhMargin, availableTop - elHeight),\n      // this makes it so that the bottom of the fixed element is the top of the container\n      // element. this ensures that it won't ever overlap the container element\n      bottom: window.innerHeight - availableTop,\n    };\n  }\n\n  const swappedTop = getAboveCoord(config);\n  if (disableSwapping || swappedTop < vhMargin) {\n    top = Math.min(top, screenBottom - elHeight);\n  } else {\n    actualY = \"above\";\n    top = swappedTop;\n  }\n\n  return { actualY, top };\n}\n\n/**\n * Creates the vertical position for a fixed element with the provided options.\n *\n * @internal\n */\nexport function createVerticalPosition(\n  options: CreateVerticalPositionOptions\n): YPosition {\n  const {\n    y,\n    vh,\n    vhMargin,\n    yMargin,\n    elHeight,\n    initialY,\n    containerRect,\n    disableSwapping,\n    preventOverlap,\n    disableVHBounds,\n  } = options;\n\n  if (!disableVHBounds && !preventOverlap && elHeight > vh - vhMargin * 2) {\n    // the element is too big to be displayed in the viewport, so just span the\n    // full viewport excluding margins\n    return {\n      top: vhMargin,\n      bottom: vhMargin,\n      actualY: \"center\",\n      transformOriginY: containerRect.top,\n    };\n  }\n\n  const config: FixConfig = {\n    vhMargin,\n    yMargin,\n    elHeight,\n    initialY,\n    containerRect,\n    screenBottom: vh - vhMargin,\n    preventOverlap,\n    disableSwapping,\n    disableVHBounds,\n  };\n\n  switch (y) {\n    case \"above\":\n      return createAnchoredAbove(config);\n    case \"top\":\n      return createAnchoredTop(config);\n    case \"center\":\n      return createAnchoredCenter(config);\n    case \"bottom\":\n      return createAnchoredBottom(config);\n    case \"below\":\n      return createAnchoredBelow(config);\n  }\n}\n"],"names":["getAboveCoord","getBelowCoord","getBottomCoord","getCenterYCoord","getTopCoord","createAnchoredAbove","config","yMargin","vhMargin","screenBottom","elHeight","containerRect","preventOverlap","disableSwapping","disableVHBounds","top","actualY","Math","max","swappedTop","min","bottom","createAnchoredTop","createAnchoredCenter","createAnchoredBottom","createAnchoredBelow","availableTop","window","innerHeight","createVerticalPosition","options","y","vh","initialY","transformOriginY"],"mappings":"AACA,SAEEA,aAAa,EACbC,aAAa,EACbC,cAAc,EACdC,eAAe,EACfC,WAAW,QACN,aAAa;AAuCpB;;;;;;;;;CASC,GACD,OAAO,SAASC,oBAAoBC,MAAiB;IACnD,MAAM,EACJC,OAAO,EACPC,QAAQ,EACRC,YAAY,EACZC,QAAQ,EACRC,aAAa,EACbC,cAAc,EACdC,eAAe,EACfC,eAAe,EAChB,GAAGR;IACJ,IAAIS,MAAMf,cAAcM;IACxB,IAAIU,UAA4B;IAEhC,IAAIF,iBAAiB;QACnB,uEAAuE;QACvE,gDAAgD;QAChD,OAAO;YAAEE;YAASD,KAAKE,KAAKC,GAAG,CAAC,GAAGH;QAAK;IAC1C;IAEA,IAAIA,MAAMP,UAAU;QAClB,4EAA4E;QAC5E,oEAAoE;QACpE,oBAAoB;QACpB,OAAO;YAAEQ;YAASD;QAAI;IACxB;IAEA,MAAMI,aAAalB,cAAcK;IACjC,IAAIO,mBAAmBM,aAAaT,WAAWD,cAAc;QAC3DM,MAAME,KAAKG,GAAG,CAACL,KAAKP;IACtB,OAAO;QACLQ,UAAU;QACVD,MAAMI;IACR;IAEA,IAAIE;IACJ,IACET,kBACA,yCAAyC;IACzCI,YAAY,WACZD,MAAML,WAAWC,cAAcI,GAAG,EAClC;QACAM,SAASZ,eAAeE,cAAcI,GAAG,GAAGR;IAC9C;IAEA,OAAO;QAAES;QAASD;QAAKM;IAAO;AAChC;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASC,kBAAkBhB,MAAiB;IACjD,MAAM,EAAEE,QAAQ,EAAEC,YAAY,EAAEC,QAAQ,EAAEG,eAAe,EAAEC,eAAe,EAAE,GAC1ER;IACF,IAAIS,MAAMX,YAAYE;IACtB,IAAIU,UAA4B;IAEhC,IAAIF,mBAAmBC,MAAML,YAAYD,cAAc;QACrD,OAAO;YAAEO;YAASD;QAAI;IACxB;IAEA,MAAMI,aAAajB,eAAeI;IAClC,IAAIO,mBAAmBM,aAAaX,UAAU;QAC5CO,MAAME,KAAKC,GAAG,CAACH,KAAKP;IACtB,OAAO;QACLQ,UAAU;QACVD,MAAMI;IACR;IAEA,OAAO;QAAEH;QAASD;IAAI;AACxB;AAEA;;;;;;;CAOC,GACD,OAAO,SAASQ,qBAAqBjB,MAAiB;IACpD,MAAM,EAAEE,QAAQ,EAAEC,YAAY,EAAEC,QAAQ,EAAEI,eAAe,EAAE,GAAGR;IAC9D,IAAIS,MAAMZ,gBAAgBG;IAC1B,MAAMU,UAA4B;IAClC,IAAIF,iBAAiB;QACnB,OAAO;YAAEE;YAASD,KAAKE,KAAKC,GAAG,CAAC,GAAGH;QAAK;IAC1C;IAEAA,MAAME,KAAKC,GAAG,CAACV,UAAUO;IACzB,IAAIA,MAAML,WAAWD,cAAc;QACjCM,MAAMN,eAAeC;IACvB;IAEA,OAAO;QAAEM;QAASD;IAAI;AACxB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASS,qBAAqBlB,MAAiB;IACpD,MAAM,EAAEE,QAAQ,EAAEC,YAAY,EAAEC,QAAQ,EAAEG,eAAe,EAAEC,eAAe,EAAE,GAC1ER;IACF,IAAIS,MAAMb,eAAeI;IACzB,IAAIU,UAA4B;IAChC,IAAIF,mBAAmBC,MAAMP,UAAU;QACrC,OAAO;YAAEQ;YAASD;QAAI;IACxB;IAEA,MAAMI,aAAaf,YAAYE;IAC/B,IAAIO,mBAAmBM,aAAaT,WAAWD,cAAc;QAC3DM,MAAME,KAAKG,GAAG,CAACL,KAAKN,eAAeC;IACrC,OAAO;QACLM,UAAU;QACVD,MAAMI;IACR;IAEA,OAAO;QAAEH;QAASD;IAAI;AACxB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASU,oBAAoBnB,MAAiB;IACnD,MAAM,EACJC,OAAO,EACPC,QAAQ,EACRE,QAAQ,EACRD,YAAY,EACZE,aAAa,EACbC,cAAc,EACdC,eAAe,EACfC,eAAe,EAChB,GAAGR;IACJ,IAAIS,MAAMd,cAAcK;IACxB,IAAIU,UAA4B;IAChC,IAAIF,mBAAmBC,MAAML,YAAYD,cAAc;QACrD,OAAO;YAAEO;YAASD;QAAI;IACxB;IAEA,IAAIH,gBAAgB;QAClB,MAAMc,eAAef,cAAcI,GAAG,GAAGR;QACzC,IAAIM,mBAAmBa,eAAejB,eAAeM,KAAK;YACxD,OAAO;gBACLC;gBACAD;gBACAM,QAAQb;YACV;QACF;QAEA,OAAO;YACLQ,SAAS;YACTD,KAAKE,KAAKC,GAAG,CAACV,UAAUkB,eAAehB;YACvC,oFAAoF;YACpF,yEAAyE;YACzEW,QAAQM,OAAOC,WAAW,GAAGF;QAC/B;IACF;IAEA,MAAMP,aAAanB,cAAcM;IACjC,IAAIO,mBAAmBM,aAAaX,UAAU;QAC5CO,MAAME,KAAKG,GAAG,CAACL,KAAKN,eAAeC;IACrC,OAAO;QACLM,UAAU;QACVD,MAAMI;IACR;IAEA,OAAO;QAAEH;QAASD;IAAI;AACxB;AAEA;;;;CAIC,GACD,OAAO,SAASc,uBACdC,OAAsC;IAEtC,MAAM,EACJC,CAAC,EACDC,EAAE,EACFxB,QAAQ,EACRD,OAAO,EACPG,QAAQ,EACRuB,QAAQ,EACRtB,aAAa,EACbE,eAAe,EACfD,cAAc,EACdE,eAAe,EAChB,GAAGgB;IAEJ,IAAI,CAAChB,mBAAmB,CAACF,kBAAkBF,WAAWsB,KAAKxB,WAAW,GAAG;QACvE,2EAA2E;QAC3E,kCAAkC;QAClC,OAAO;YACLO,KAAKP;YACLa,QAAQb;YACRQ,SAAS;YACTkB,kBAAkBvB,cAAcI,GAAG;QACrC;IACF;IAEA,MAAMT,SAAoB;QACxBE;QACAD;QACAG;QACAuB;QACAtB;QACAF,cAAcuB,KAAKxB;QACnBI;QACAC;QACAC;IACF;IAEA,OAAQiB;QACN,KAAK;YACH,OAAO1B,oBAAoBC;QAC7B,KAAK;YACH,OAAOgB,kBAAkBhB;QAC3B,KAAK;YACH,OAAOiB,qBAAqBjB;QAC9B,KAAK;YACH,OAAOkB,qBAAqBlB;QAC9B,KAAK;YACH,OAAOmB,oBAAoBnB;IAC/B;AACF"}

package/dist/positioning/getFixedPosition.d.ts

@@ -1,4 +1,4 @@
-import type { FixedPosition, FixedPositionOptions } from "./types.js";
+import { type FixedPosition, type FixedPositionOptions } from "./types.js";
 /**
  * One of the most complicated functions in this project that will attempt to
  * position an element relative to another container element while still being

package/dist/positioning/getFixedPosition.js

@@ -9,7 +9,7 @@ import { findSizingContainer, getElementRect, getTransformOrigin } from "./utils
  * `initialX` and `initialY` options have been provided.
  *
  * @internal
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  */ const FALLBACK_DOM_RECT = {
     x: 0,
     y: 0,

package/dist/positioning/getFixedPosition.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/positioning/getFixedPosition.ts"],"sourcesContent":["import { getScrollbarWidth } from \"../scroll/getScrollbarWidth.js\";\nimport { BELOW_CENTER_ANCHOR } from \"./constants.js\";\nimport { createHorizontalPosition } from \"./createHorizontalPosition.js\";\nimport { createVerticalPosition } from \"./createVerticalPosition.js\";\nimport type { FixedPosition, FixedPositionOptions } from \"./types.js\";\nimport {\n  findSizingContainer,\n  getElementRect,\n  getTransformOrigin,\n} from \"./utils.js\";\n\n/**\n * This is used when there is no `container` element so that some styles can\n * still be created. The main use-case for this is context menus and when the\n * `initialX` and `initialY` options have been provided.\n *\n * @internal\n * @remarks \\@since 5.0.0\n */\nconst FALLBACK_DOM_RECT: DOMRect = {\n  x: 0,\n  y: 0,\n  height: 0,\n  width: 0,\n  left: 0,\n  right: 0,\n  top: 0,\n  bottom: 0,\n  toJSON() {\n    // do nothing\n  },\n};\n\n/**\n * One of the most complicated functions in this project that will attempt to\n * position an element relative to another container element while still being\n * visible within the viewport. Below is the logical flow for attempting to fix\n * the element to the container:\n *\n * No Container: If there is no container element, return the provided x and y\n * positions and no styles since there's nothing we can use to calculate the\n * position.\n *\n * No Element: If the container was provided but the element to position does\n * not exist, return an style object containing the `left` and `top` values for\n * the container and apply as many of the positioning options as possible so\n * that the styles are \"as close as possible\" before the fixed element is added\n * to the DOM. This will also return the provided x and y positions since\n * nothing could be swapped around yet.\n *\n * Container and Element: If both the container and fixed element were provided,\n * apply all the positioning options to the `left` and `top` values of the\n * container based on the sizes of both elements.\n *\n * Now that the `left` and `top` values were applied, check to see if the\n * element is fully visible within the viewport with the provided positioning\n * options. If it is fully visible, do nothing else. If it isn't... follow the\n * next flow:\n *\n * First, check the horizontal sizes and make sure that the element is still\n * within the viewport with the provided view width margin. If it isn't, first\n * try to swap only to a `right` style instead of left to see if that fixes it,\n * otherwise keep both the `left` and `right` styles.\n */\nexport function getFixedPosition(options: FixedPositionOptions): FixedPosition {\n  const {\n    element,\n    anchor = BELOW_CENTER_ANCHOR,\n    initialX,\n    vwMargin = 16,\n    vhMargin = 16,\n    xMargin = 0,\n    yMargin = 0,\n    width: widthType = \"auto\",\n    preventOverlap = false,\n    transformOrigin = false,\n    disableSwapping = false,\n    disableVHBounds = false,\n  } = options;\n  let { initialY } = options;\n  const container = findSizingContainer(options.container);\n\n  if (process.env.NODE_ENV !== \"production\") {\n    if (preventOverlap && anchor.y !== \"above\" && anchor.y !== \"below\") {\n      throw new Error(\n        'Unable to prevent overlap when the vertical anchor is not `\"above\"` or `\"below\"`'\n      );\n    }\n  }\n\n  if (!element) {\n    return {\n      actualX: anchor.x,\n      actualY: anchor.y,\n      style: {\n        left: initialX,\n        top: initialY,\n        position: disableVHBounds ? \"absolute\" : \"fixed\",\n        transformOrigin: transformOrigin\n          ? getTransformOrigin({ x: anchor.x, y: anchor.y })\n          : undefined,\n      },\n    };\n  }\n\n  const containerRect = container?.getBoundingClientRect() ?? FALLBACK_DOM_RECT;\n  const vh = window.innerHeight;\n  const vw = window.innerWidth;\n\n  const { minWidth: elMinWidth } = element.style;\n  // Note: This makes it \"min-content\" or \"min-container-width\"\n  if (widthType === \"min\") {\n    element.style.overflow = \"visible\";\n    element.style.minWidth = \"\";\n  }\n  const elementRect = getElementRect(element);\n  const { height } = elementRect;\n  let elWidth = elementRect.width;\n  if (widthType === \"min\") {\n    elWidth += getScrollbarWidth();\n    element.style.overflow = \"\";\n    element.style.minWidth = elMinWidth;\n  }\n  if (disableVHBounds) {\n    const dialog = element.closest(\"[role='dialog']\");\n    if (!dialog) {\n      initialY = (initialY ?? 0) + window.scrollY;\n    }\n  }\n\n  const { left, right, width, minWidth, actualX } = createHorizontalPosition({\n    x: anchor.x,\n    vw,\n    vwMargin,\n    xMargin,\n    width: widthType,\n    elWidth,\n    initialX,\n    containerRect,\n    disableSwapping,\n  });\n  const { top, bottom, actualY, transformOriginY } = createVerticalPosition({\n    y: anchor.y,\n    vh,\n    vhMargin,\n    yMargin,\n    initialY,\n    elHeight: height,\n    containerRect,\n    disableSwapping,\n    preventOverlap,\n    disableVHBounds,\n  });\n\n  return {\n    actualX,\n    actualY,\n    style: {\n      left,\n      top,\n      right,\n      bottom,\n      width,\n      minWidth,\n      position: disableVHBounds ? \"absolute\" : \"fixed\",\n      transformOrigin: transformOrigin\n        ? getTransformOrigin({\n            x: actualX,\n            y: actualY,\n            transformOriginY,\n          })\n        : undefined,\n    },\n  };\n}\n"],"names":["getScrollbarWidth","BELOW_CENTER_ANCHOR","createHorizontalPosition","createVerticalPosition","findSizingContainer","getElementRect","getTransformOrigin","FALLBACK_DOM_RECT","x","y","height","width","left","right","top","bottom","toJSON","getFixedPosition","options","element","anchor","initialX","vwMargin","vhMargin","xMargin","yMargin","widthType","preventOverlap","transformOrigin","disableSwapping","disableVHBounds","initialY","container","process","env","NODE_ENV","Error","actualX","actualY","style","position","undefined","containerRect","getBoundingClientRect","vh","window","innerHeight","vw","innerWidth","minWidth","elMinWidth","overflow","elementRect","elWidth","dialog","closest","scrollY","transformOriginY","elHeight"],"mappings":"AAAA,SAASA,iBAAiB,QAAQ,iCAAiC;AACnE,SAASC,mBAAmB,QAAQ,iBAAiB;AACrD,SAASC,wBAAwB,QAAQ,gCAAgC;AACzE,SAASC,sBAAsB,QAAQ,8BAA8B;AAErE,SACEC,mBAAmB,EACnBC,cAAc,EACdC,kBAAkB,QACb,aAAa;AAEpB;;;;;;;CAOC,GACD,MAAMC,oBAA6B;IACjCC,GAAG;IACHC,GAAG;IACHC,QAAQ;IACRC,OAAO;IACPC,MAAM;IACNC,OAAO;IACPC,KAAK;IACLC,QAAQ;IACRC;IACE,aAAa;IACf;AACF;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BC,GACD,OAAO,SAASC,iBAAiBC,OAA6B;IAC5D,MAAM,EACJC,OAAO,EACPC,SAASnB,mBAAmB,EAC5BoB,QAAQ,EACRC,WAAW,EAAE,EACbC,WAAW,EAAE,EACbC,UAAU,CAAC,EACXC,UAAU,CAAC,EACXd,OAAOe,YAAY,MAAM,EACzBC,iBAAiB,KAAK,EACtBC,kBAAkB,KAAK,EACvBC,kBAAkB,KAAK,EACvBC,kBAAkB,KAAK,EACxB,GAAGZ;IACJ,IAAI,EAAEa,QAAQ,EAAE,GAAGb;IACnB,MAAMc,YAAY5B,oBAAoBc,QAAQc,SAAS;IAEvD,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QACzC,IAAIR,kBAAkBP,OAAOX,CAAC,KAAK,WAAWW,OAAOX,CAAC,KAAK,SAAS;YAClE,MAAM,IAAI2B,MACR;QAEJ;IACF;IAEA,IAAI,CAACjB,SAAS;QACZ,OAAO;YACLkB,SAASjB,OAAOZ,CAAC;YACjB8B,SAASlB,OAAOX,CAAC;YACjB8B,OAAO;gBACL3B,MAAMS;gBACNP,KAAKiB;gBACLS,UAAUV,kBAAkB,aAAa;gBACzCF,iBAAiBA,kBACbtB,mBAAmB;oBAAEE,GAAGY,OAAOZ,CAAC;oBAAEC,GAAGW,OAAOX,CAAC;gBAAC,KAC9CgC;YACN;QACF;IACF;IAEA,MAAMC,gBAAgBV,WAAWW,2BAA2BpC;IAC5D,MAAMqC,KAAKC,OAAOC,WAAW;IAC7B,MAAMC,KAAKF,OAAOG,UAAU;IAE5B,MAAM,EAAEC,UAAUC,UAAU,EAAE,GAAG/B,QAAQoB,KAAK;IAC9C,6DAA6D;IAC7D,IAAIb,cAAc,OAAO;QACvBP,QAAQoB,KAAK,CAACY,QAAQ,GAAG;QACzBhC,QAAQoB,KAAK,CAACU,QAAQ,GAAG;IAC3B;IACA,MAAMG,cAAc/C,eAAec;IACnC,MAAM,EAAET,MAAM,EAAE,GAAG0C;IACnB,IAAIC,UAAUD,YAAYzC,KAAK;IAC/B,IAAIe,cAAc,OAAO;QACvB2B,WAAWrD;QACXmB,QAAQoB,KAAK,CAACY,QAAQ,GAAG;QACzBhC,QAAQoB,KAAK,CAACU,QAAQ,GAAGC;IAC3B;IACA,IAAIpB,iBAAiB;QACnB,MAAMwB,SAASnC,QAAQoC,OAAO,CAAC;QAC/B,IAAI,CAACD,QAAQ;YACXvB,WAAW,AAACA,CAAAA,YAAY,CAAA,IAAKc,OAAOW,OAAO;QAC7C;IACF;IAEA,MAAM,EAAE5C,IAAI,EAAEC,KAAK,EAAEF,KAAK,EAAEsC,QAAQ,EAAEZ,OAAO,EAAE,GAAGnC,yBAAyB;QACzEM,GAAGY,OAAOZ,CAAC;QACXuC;QACAzB;QACAE;QACAb,OAAOe;QACP2B;QACAhC;QACAqB;QACAb;IACF;IACA,MAAM,EAAEf,GAAG,EAAEC,MAAM,EAAEuB,OAAO,EAAEmB,gBAAgB,EAAE,GAAGtD,uBAAuB;QACxEM,GAAGW,OAAOX,CAAC;QACXmC;QACArB;QACAE;QACAM;QACA2B,UAAUhD;QACVgC;QACAb;QACAF;QACAG;IACF;IAEA,OAAO;QACLO;QACAC;QACAC,OAAO;YACL3B;YACAE;YACAD;YACAE;YACAJ;YACAsC;YACAT,UAAUV,kBAAkB,aAAa;YACzCF,iBAAiBA,kBACbtB,mBAAmB;gBACjBE,GAAG6B;gBACH5B,GAAG6B;gBACHmB;YACF,KACAhB;QACN;IACF;AACF"}
+{"version":3,"sources":["../../src/positioning/getFixedPosition.ts"],"sourcesContent":["import { getScrollbarWidth } from \"../scroll/getScrollbarWidth.js\";\nimport { BELOW_CENTER_ANCHOR } from \"./constants.js\";\nimport { createHorizontalPosition } from \"./createHorizontalPosition.js\";\nimport { createVerticalPosition } from \"./createVerticalPosition.js\";\nimport { type FixedPosition, type FixedPositionOptions } from \"./types.js\";\nimport {\n  findSizingContainer,\n  getElementRect,\n  getTransformOrigin,\n} from \"./utils.js\";\n\n/**\n * This is used when there is no `container` element so that some styles can\n * still be created. The main use-case for this is context menus and when the\n * `initialX` and `initialY` options have been provided.\n *\n * @internal\n * @since 5.0.0\n */\nconst FALLBACK_DOM_RECT: DOMRect = {\n  x: 0,\n  y: 0,\n  height: 0,\n  width: 0,\n  left: 0,\n  right: 0,\n  top: 0,\n  bottom: 0,\n  toJSON() {\n    // do nothing\n  },\n};\n\n/**\n * One of the most complicated functions in this project that will attempt to\n * position an element relative to another container element while still being\n * visible within the viewport. Below is the logical flow for attempting to fix\n * the element to the container:\n *\n * No Container: If there is no container element, return the provided x and y\n * positions and no styles since there's nothing we can use to calculate the\n * position.\n *\n * No Element: If the container was provided but the element to position does\n * not exist, return an style object containing the `left` and `top` values for\n * the container and apply as many of the positioning options as possible so\n * that the styles are \"as close as possible\" before the fixed element is added\n * to the DOM. This will also return the provided x and y positions since\n * nothing could be swapped around yet.\n *\n * Container and Element: If both the container and fixed element were provided,\n * apply all the positioning options to the `left` and `top` values of the\n * container based on the sizes of both elements.\n *\n * Now that the `left` and `top` values were applied, check to see if the\n * element is fully visible within the viewport with the provided positioning\n * options. If it is fully visible, do nothing else. If it isn't... follow the\n * next flow:\n *\n * First, check the horizontal sizes and make sure that the element is still\n * within the viewport with the provided view width margin. If it isn't, first\n * try to swap only to a `right` style instead of left to see if that fixes it,\n * otherwise keep both the `left` and `right` styles.\n */\nexport function getFixedPosition(options: FixedPositionOptions): FixedPosition {\n  const {\n    element,\n    anchor = BELOW_CENTER_ANCHOR,\n    initialX,\n    vwMargin = 16,\n    vhMargin = 16,\n    xMargin = 0,\n    yMargin = 0,\n    width: widthType = \"auto\",\n    preventOverlap = false,\n    transformOrigin = false,\n    disableSwapping = false,\n    disableVHBounds = false,\n  } = options;\n  let { initialY } = options;\n  const container = findSizingContainer(options.container);\n\n  if (process.env.NODE_ENV !== \"production\") {\n    if (preventOverlap && anchor.y !== \"above\" && anchor.y !== \"below\") {\n      throw new Error(\n        'Unable to prevent overlap when the vertical anchor is not `\"above\"` or `\"below\"`'\n      );\n    }\n  }\n\n  if (!element) {\n    return {\n      actualX: anchor.x,\n      actualY: anchor.y,\n      style: {\n        left: initialX,\n        top: initialY,\n        position: disableVHBounds ? \"absolute\" : \"fixed\",\n        transformOrigin: transformOrigin\n          ? getTransformOrigin({ x: anchor.x, y: anchor.y })\n          : undefined,\n      },\n    };\n  }\n\n  const containerRect = container?.getBoundingClientRect() ?? FALLBACK_DOM_RECT;\n  const vh = window.innerHeight;\n  const vw = window.innerWidth;\n\n  const { minWidth: elMinWidth } = element.style;\n  // Note: This makes it \"min-content\" or \"min-container-width\"\n  if (widthType === \"min\") {\n    element.style.overflow = \"visible\";\n    element.style.minWidth = \"\";\n  }\n  const elementRect = getElementRect(element);\n  const { height } = elementRect;\n  let elWidth = elementRect.width;\n  if (widthType === \"min\") {\n    elWidth += getScrollbarWidth();\n    element.style.overflow = \"\";\n    element.style.minWidth = elMinWidth;\n  }\n  if (disableVHBounds) {\n    const dialog = element.closest(\"[role='dialog']\");\n    if (!dialog) {\n      initialY = (initialY ?? 0) + window.scrollY;\n    }\n  }\n\n  const { left, right, width, minWidth, actualX } = createHorizontalPosition({\n    x: anchor.x,\n    vw,\n    vwMargin,\n    xMargin,\n    width: widthType,\n    elWidth,\n    initialX,\n    containerRect,\n    disableSwapping,\n  });\n  const { top, bottom, actualY, transformOriginY } = createVerticalPosition({\n    y: anchor.y,\n    vh,\n    vhMargin,\n    yMargin,\n    initialY,\n    elHeight: height,\n    containerRect,\n    disableSwapping,\n    preventOverlap,\n    disableVHBounds,\n  });\n\n  return {\n    actualX,\n    actualY,\n    style: {\n      left,\n      top,\n      right,\n      bottom,\n      width,\n      minWidth,\n      position: disableVHBounds ? \"absolute\" : \"fixed\",\n      transformOrigin: transformOrigin\n        ? getTransformOrigin({\n            x: actualX,\n            y: actualY,\n            transformOriginY,\n          })\n        : undefined,\n    },\n  };\n}\n"],"names":["getScrollbarWidth","BELOW_CENTER_ANCHOR","createHorizontalPosition","createVerticalPosition","findSizingContainer","getElementRect","getTransformOrigin","FALLBACK_DOM_RECT","x","y","height","width","left","right","top","bottom","toJSON","getFixedPosition","options","element","anchor","initialX","vwMargin","vhMargin","xMargin","yMargin","widthType","preventOverlap","transformOrigin","disableSwapping","disableVHBounds","initialY","container","process","env","NODE_ENV","Error","actualX","actualY","style","position","undefined","containerRect","getBoundingClientRect","vh","window","innerHeight","vw","innerWidth","minWidth","elMinWidth","overflow","elementRect","elWidth","dialog","closest","scrollY","transformOriginY","elHeight"],"mappings":"AAAA,SAASA,iBAAiB,QAAQ,iCAAiC;AACnE,SAASC,mBAAmB,QAAQ,iBAAiB;AACrD,SAASC,wBAAwB,QAAQ,gCAAgC;AACzE,SAASC,sBAAsB,QAAQ,8BAA8B;AAErE,SACEC,mBAAmB,EACnBC,cAAc,EACdC,kBAAkB,QACb,aAAa;AAEpB;;;;;;;CAOC,GACD,MAAMC,oBAA6B;IACjCC,GAAG;IACHC,GAAG;IACHC,QAAQ;IACRC,OAAO;IACPC,MAAM;IACNC,OAAO;IACPC,KAAK;IACLC,QAAQ;IACRC;IACE,aAAa;IACf;AACF;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BC,GACD,OAAO,SAASC,iBAAiBC,OAA6B;IAC5D,MAAM,EACJC,OAAO,EACPC,SAASnB,mBAAmB,EAC5BoB,QAAQ,EACRC,WAAW,EAAE,EACbC,WAAW,EAAE,EACbC,UAAU,CAAC,EACXC,UAAU,CAAC,EACXd,OAAOe,YAAY,MAAM,EACzBC,iBAAiB,KAAK,EACtBC,kBAAkB,KAAK,EACvBC,kBAAkB,KAAK,EACvBC,kBAAkB,KAAK,EACxB,GAAGZ;IACJ,IAAI,EAAEa,QAAQ,EAAE,GAAGb;IACnB,MAAMc,YAAY5B,oBAAoBc,QAAQc,SAAS;IAEvD,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QACzC,IAAIR,kBAAkBP,OAAOX,CAAC,KAAK,WAAWW,OAAOX,CAAC,KAAK,SAAS;YAClE,MAAM,IAAI2B,MACR;QAEJ;IACF;IAEA,IAAI,CAACjB,SAAS;QACZ,OAAO;YACLkB,SAASjB,OAAOZ,CAAC;YACjB8B,SAASlB,OAAOX,CAAC;YACjB8B,OAAO;gBACL3B,MAAMS;gBACNP,KAAKiB;gBACLS,UAAUV,kBAAkB,aAAa;gBACzCF,iBAAiBA,kBACbtB,mBAAmB;oBAAEE,GAAGY,OAAOZ,CAAC;oBAAEC,GAAGW,OAAOX,CAAC;gBAAC,KAC9CgC;YACN;QACF;IACF;IAEA,MAAMC,gBAAgBV,WAAWW,2BAA2BpC;IAC5D,MAAMqC,KAAKC,OAAOC,WAAW;IAC7B,MAAMC,KAAKF,OAAOG,UAAU;IAE5B,MAAM,EAAEC,UAAUC,UAAU,EAAE,GAAG/B,QAAQoB,KAAK;IAC9C,6DAA6D;IAC7D,IAAIb,cAAc,OAAO;QACvBP,QAAQoB,KAAK,CAACY,QAAQ,GAAG;QACzBhC,QAAQoB,KAAK,CAACU,QAAQ,GAAG;IAC3B;IACA,MAAMG,cAAc/C,eAAec;IACnC,MAAM,EAAET,MAAM,EAAE,GAAG0C;IACnB,IAAIC,UAAUD,YAAYzC,KAAK;IAC/B,IAAIe,cAAc,OAAO;QACvB2B,WAAWrD;QACXmB,QAAQoB,KAAK,CAACY,QAAQ,GAAG;QACzBhC,QAAQoB,KAAK,CAACU,QAAQ,GAAGC;IAC3B;IACA,IAAIpB,iBAAiB;QACnB,MAAMwB,SAASnC,QAAQoC,OAAO,CAAC;QAC/B,IAAI,CAACD,QAAQ;YACXvB,WAAW,AAACA,CAAAA,YAAY,CAAA,IAAKc,OAAOW,OAAO;QAC7C;IACF;IAEA,MAAM,EAAE5C,IAAI,EAAEC,KAAK,EAAEF,KAAK,EAAEsC,QAAQ,EAAEZ,OAAO,EAAE,GAAGnC,yBAAyB;QACzEM,GAAGY,OAAOZ,CAAC;QACXuC;QACAzB;QACAE;QACAb,OAAOe;QACP2B;QACAhC;QACAqB;QACAb;IACF;IACA,MAAM,EAAEf,GAAG,EAAEC,MAAM,EAAEuB,OAAO,EAAEmB,gBAAgB,EAAE,GAAGtD,uBAAuB;QACxEM,GAAGW,OAAOX,CAAC;QACXmC;QACArB;QACAE;QACAM;QACA2B,UAAUhD;QACVgC;QACAb;QACAF;QACAG;IACF;IAEA,OAAO;QACLO;QACAC;QACAC,OAAO;YACL3B;YACAE;YACAD;YACAE;YACAJ;YACAsC;YACAT,UAAUV,kBAAkB,aAAa;YACzCF,iBAAiBA,kBACbtB,mBAAmB;gBACjBE,GAAG6B;gBACH5B,GAAG6B;gBACHmB;YACF,KACAhB;QACN;IACF;AACF"}

package/dist/positioning/types.d.ts

@@ -78,7 +78,7 @@ export interface InitialCoords {
      */
     initialY?: number;
 }
-/** @remarks \@since 4.0.0 */
+/** @since 4.0.0 */
 export interface CalculateFixedPositionOptions extends InitialCoords {
     /**
      * The configuration to anchor the fixed element to the container element.
@@ -138,9 +138,9 @@ export interface CalculateFixedPositionOptions extends InitialCoords {
      * screen.
      *
      * @defaultValue `false`
-     * @remarks \@since 5.0.0 This will always be `true` if the
+     * @since 5.0.0 This will always be `true` if the
      * {@link FixedPositionOptions.container} is `null`.
-     * \@remarks \@since 6.0.0 Allow this to be `false` while the `container` is
+     * @since 5.1.6 Allow this to be `false` while the `container` is
      * null. I can't figure out why I prevented that.
      */
     disableSwapping?: boolean;
@@ -190,7 +190,7 @@ export interface Coords {
  * Note: The fixed element styles **will not** contain styles for `z-index` or
  * `background-color` so you'll need to add that manually.
  *
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface FixedPositionStyle extends Coords {
     /**

package/dist/positioning/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/positioning/types.ts"],"sourcesContent":["/**\n * Above:\n * - the container top is in-line with the bottom of the element.\n *\n * Below:\n * - the container bottom is in-line with the top of the element\n *\n * Center:\n * - the container center is in-line with the top of the element\n *\n * Top:\n * - the container top is in-line with the top of the element\n *\n * Bottom:\n * - the container bottom is in-line with the bottom of the element\n */\nexport type VerticalPosition = \"above\" | \"below\" | \"center\" | \"top\" | \"bottom\";\n\n/**\n * Left:\n * - the container left is in-line with the right of the element\n *\n * Right:\n * - the container right is in-line with the left of the element\n *\n * Center:\n * - the container's horizontal center point will be aligned with the element's\n *   horizontal center point\n *\n * Inner Left:\n * - the container's left is in-line with the left of the element\n *\n * Inner Right:\n * - the container's right is in-line with the right of the element\n */\nexport type HorizontalPosition =\n  | \"left\"\n  | \"right\"\n  | \"center\"\n  | \"inner-left\"\n  | \"inner-right\";\n\n/**\n * An object containing the x and y positions to anchor a fixed element to\n * another container element.\n */\nexport interface PositionAnchor {\n  x: HorizontalPosition;\n  y: VerticalPosition;\n}\n\n/**\n * A \"simple\" version of all the positioning options. These are generally used\n * across all of react-md as it'll use the \"center\" version of the opposite type\n * when creating a fixed position.\n */\nexport type SimplePosition = \"above\" | \"below\" | \"left\" | \"right\";\n\n/**\n * An optional configuration for calculating and setting the width of the\n * element relative to the width of the container. When this value is set to\n * `\"auto\"` (default), the width will be based on content width but still\n * ensuring it can fit within the viewport. Setting this to `\"equal\"` will just\n * apply the container's width to the fixed element. Finally, setting this to\n * `\"min\"` will set the container's width as the `minWidth` for the fixed\n * element so that it is at least the same width as the container.\n *\n * If this is set to `\"equal\"` or `\"min\"` and the horizontal anchor is not set\n * to `\"center\"`, an error will be thrown.\n *\n * @defaultValue `\"auto\"`\n */\nexport type PositionWidth = \"auto\" | \"equal\" | \"min\";\n\nexport interface InitialCoords {\n  /**\n   * The initial x value to use when calculating the position instead of\n   * finding the container element to determine the the correct position. All\n   * the other positioning logic will still be in effect to ensure the element\n   * will be visible within the viewport.\n   */\n  initialX?: number;\n\n  /**\n   * The initial y value to use when calculating the position instead of\n   * finding the container element to determine the the correct position. All\n   * the other positioning logic will still be in effect to ensure the element\n   * will be visible within the viewport.\n   */\n  initialY?: number;\n}\n\n/** @remarks \\@since 4.0.0 */\nexport interface CalculateFixedPositionOptions extends InitialCoords {\n  /**\n   * The configuration to anchor the fixed element to the container element.\n   *\n   * @defaultValue `BELOW_CENTER_ANCHOR`\n   */\n  anchor?: PositionAnchor;\n\n  /**\n   * The viewwidth margin to apply so that the element doesn't need to be\n   * directly on the screen edge.\n   *\n   * @defaultValue `16`\n   */\n  vwMargin?: number;\n\n  /**\n   * The viewwidth margin to apply so that the element doesn't need to be\n   * directly on the screen edge.\n   *\n   * @defaultValue `16`\n   */\n  vhMargin?: number;\n\n  /**\n   * The container width margin to apply so that the element doesn't need to be\n   * directly on the container's edge.\n   *\n   * @defaultValue `0`\n   */\n  xMargin?: number;\n\n  /**\n   * The container height margin to apply so that the element doesn't need to be\n   * directly on the container's edge\n   *\n   * @defaultValue `0`\n   */\n  yMargin?: number;\n\n  /** {@inheritDoc PositionWidth} */\n  width?: PositionWidth;\n\n  /**\n   * Boolean if the style object should include the `transformOrigin` value\n   * based on the x and y positions.\n   *\n   * @defaultValue `false`\n   */\n  transformOrigin?: boolean;\n\n  /**\n   * Boolean if the fixed element should no longer be able to overlap the\n   * container element. This is useful for autocomplete menus or other\n   * components that retain focus on the container element while the fixed\n   * element becomes visible.\n   *\n   * @defaultValue `false`\n   */\n  preventOverlap?: boolean;\n\n  /**\n   * Boolean if the auto-swapping behavior should be disabled. It's normally\n   * recommended to not disable this since it'll allow elements to appear off\n   * screen.\n   *\n   * @defaultValue `false`\n   * @remarks \\@since 5.0.0 This will always be `true` if the\n   * {@link FixedPositionOptions.container} is `null`.\n   * \\@remarks \\@since 6.0.0 Allow this to be `false` while the `container` is\n   * null. I can't figure out why I prevented that.\n   */\n  disableSwapping?: boolean;\n\n  /**\n   * Boolean if the fixed positioning should no longer prevent the fixed element\n   * to be positioned within the viewport. This is nice if you want to allow for\n   * full page scrolling instead and manually set a max-height on your element.\n   *\n   * @defaultValue `false`\n   */\n  disableVHBounds?: boolean;\n}\n\nexport interface FixedPositionOptions extends CalculateFixedPositionOptions {\n  /**\n   * The container element that the `element` should be fixed to.\n   */\n  container: HTMLElement | null;\n\n  /**\n   * The element that is fixed to a `container` element.\n   */\n  element: HTMLElement | null;\n}\n\n/**\n * This is more of a private interface that is used to help show how fixed\n * elements are placed within the viewport. Most of the time the `top` and\n * `left` values will be provided, but there are a few flows where the `right`\n * and `bottom` could be added or the `top` and `left` are removed.\n *\n * The `width` values will only be used when the `equalWidth` or `minEqualWidth`\n * options are enabled.\n *\n * @internal\n */\nexport interface Coords {\n  top?: number;\n  right?: number;\n  bottom?: number;\n  left?: number;\n  width?: number;\n  minWidth?: number;\n}\n\n/**\n * The style object that should be applied to the fixed element so it will be\n * fixed to the container element. This will be `undefined` if the container\n * element doesn't exist within the DOM.\n *\n * Note: The fixed element styles **will not** contain styles for `z-index` or\n * `background-color` so you'll need to add that manually.\n *\n * @remarks \\@since 4.0.0\n */\nexport interface FixedPositionStyle extends Coords {\n  /**\n   * This will be `\"fixed\"` unless\n   * {@link CalculateFixedPositionOptions.disableVHBounds} is set to `true`.\n   */\n  position: \"fixed\" | \"absolute\";\n\n  /**\n   * This will be `undefined` unless\n   * {@link CalculateFixedPositionOptions.transformOrigin} is set to `true`\n   */\n  transformOrigin?: string;\n}\n\n/**\n * Since the position can be \"swapped\" to help fit the fixed element within the\n * viewport, this interface is used to contain the calculated positions as well\n * as an optional style object to apply.\n */\nexport interface FixedPosition {\n  /**\n   * The calculated horizontal position that can be used to compare to the\n   * provided horizontal position anchor if additional manual updates should be\n   * applied.\n   */\n  actualX: HorizontalPosition;\n\n  /**\n   * The calculated vertical position that can be used to compare to the\n   * provided horizontal position anchor if additional manual updates should be\n   * applied.\n   */\n  actualY: VerticalPosition;\n  /** {@inheritDoc FixedPositionStyle} */\n  style?: FixedPositionStyle;\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GA0ND;;;;CAIC,GACD,WAgBC"}
+{"version":3,"sources":["../../src/positioning/types.ts"],"sourcesContent":["/**\n * Above:\n * - the container top is in-line with the bottom of the element.\n *\n * Below:\n * - the container bottom is in-line with the top of the element\n *\n * Center:\n * - the container center is in-line with the top of the element\n *\n * Top:\n * - the container top is in-line with the top of the element\n *\n * Bottom:\n * - the container bottom is in-line with the bottom of the element\n */\nexport type VerticalPosition = \"above\" | \"below\" | \"center\" | \"top\" | \"bottom\";\n\n/**\n * Left:\n * - the container left is in-line with the right of the element\n *\n * Right:\n * - the container right is in-line with the left of the element\n *\n * Center:\n * - the container's horizontal center point will be aligned with the element's\n *   horizontal center point\n *\n * Inner Left:\n * - the container's left is in-line with the left of the element\n *\n * Inner Right:\n * - the container's right is in-line with the right of the element\n */\nexport type HorizontalPosition =\n  | \"left\"\n  | \"right\"\n  | \"center\"\n  | \"inner-left\"\n  | \"inner-right\";\n\n/**\n * An object containing the x and y positions to anchor a fixed element to\n * another container element.\n */\nexport interface PositionAnchor {\n  x: HorizontalPosition;\n  y: VerticalPosition;\n}\n\n/**\n * A \"simple\" version of all the positioning options. These are generally used\n * across all of react-md as it'll use the \"center\" version of the opposite type\n * when creating a fixed position.\n */\nexport type SimplePosition = \"above\" | \"below\" | \"left\" | \"right\";\n\n/**\n * An optional configuration for calculating and setting the width of the\n * element relative to the width of the container. When this value is set to\n * `\"auto\"` (default), the width will be based on content width but still\n * ensuring it can fit within the viewport. Setting this to `\"equal\"` will just\n * apply the container's width to the fixed element. Finally, setting this to\n * `\"min\"` will set the container's width as the `minWidth` for the fixed\n * element so that it is at least the same width as the container.\n *\n * If this is set to `\"equal\"` or `\"min\"` and the horizontal anchor is not set\n * to `\"center\"`, an error will be thrown.\n *\n * @defaultValue `\"auto\"`\n */\nexport type PositionWidth = \"auto\" | \"equal\" | \"min\";\n\nexport interface InitialCoords {\n  /**\n   * The initial x value to use when calculating the position instead of\n   * finding the container element to determine the the correct position. All\n   * the other positioning logic will still be in effect to ensure the element\n   * will be visible within the viewport.\n   */\n  initialX?: number;\n\n  /**\n   * The initial y value to use when calculating the position instead of\n   * finding the container element to determine the the correct position. All\n   * the other positioning logic will still be in effect to ensure the element\n   * will be visible within the viewport.\n   */\n  initialY?: number;\n}\n\n/** @since 4.0.0 */\nexport interface CalculateFixedPositionOptions extends InitialCoords {\n  /**\n   * The configuration to anchor the fixed element to the container element.\n   *\n   * @defaultValue `BELOW_CENTER_ANCHOR`\n   */\n  anchor?: PositionAnchor;\n\n  /**\n   * The viewwidth margin to apply so that the element doesn't need to be\n   * directly on the screen edge.\n   *\n   * @defaultValue `16`\n   */\n  vwMargin?: number;\n\n  /**\n   * The viewwidth margin to apply so that the element doesn't need to be\n   * directly on the screen edge.\n   *\n   * @defaultValue `16`\n   */\n  vhMargin?: number;\n\n  /**\n   * The container width margin to apply so that the element doesn't need to be\n   * directly on the container's edge.\n   *\n   * @defaultValue `0`\n   */\n  xMargin?: number;\n\n  /**\n   * The container height margin to apply so that the element doesn't need to be\n   * directly on the container's edge\n   *\n   * @defaultValue `0`\n   */\n  yMargin?: number;\n\n  /** {@inheritDoc PositionWidth} */\n  width?: PositionWidth;\n\n  /**\n   * Boolean if the style object should include the `transformOrigin` value\n   * based on the x and y positions.\n   *\n   * @defaultValue `false`\n   */\n  transformOrigin?: boolean;\n\n  /**\n   * Boolean if the fixed element should no longer be able to overlap the\n   * container element. This is useful for autocomplete menus or other\n   * components that retain focus on the container element while the fixed\n   * element becomes visible.\n   *\n   * @defaultValue `false`\n   */\n  preventOverlap?: boolean;\n\n  /**\n   * Boolean if the auto-swapping behavior should be disabled. It's normally\n   * recommended to not disable this since it'll allow elements to appear off\n   * screen.\n   *\n   * @defaultValue `false`\n   * @since 5.0.0 This will always be `true` if the\n   * {@link FixedPositionOptions.container} is `null`.\n   * @since 5.1.6 Allow this to be `false` while the `container` is\n   * null. I can't figure out why I prevented that.\n   */\n  disableSwapping?: boolean;\n\n  /**\n   * Boolean if the fixed positioning should no longer prevent the fixed element\n   * to be positioned within the viewport. This is nice if you want to allow for\n   * full page scrolling instead and manually set a max-height on your element.\n   *\n   * @defaultValue `false`\n   */\n  disableVHBounds?: boolean;\n}\n\nexport interface FixedPositionOptions extends CalculateFixedPositionOptions {\n  /**\n   * The container element that the `element` should be fixed to.\n   */\n  container: HTMLElement | null;\n\n  /**\n   * The element that is fixed to a `container` element.\n   */\n  element: HTMLElement | null;\n}\n\n/**\n * This is more of a private interface that is used to help show how fixed\n * elements are placed within the viewport. Most of the time the `top` and\n * `left` values will be provided, but there are a few flows where the `right`\n * and `bottom` could be added or the `top` and `left` are removed.\n *\n * The `width` values will only be used when the `equalWidth` or `minEqualWidth`\n * options are enabled.\n *\n * @internal\n */\nexport interface Coords {\n  top?: number;\n  right?: number;\n  bottom?: number;\n  left?: number;\n  width?: number;\n  minWidth?: number;\n}\n\n/**\n * The style object that should be applied to the fixed element so it will be\n * fixed to the container element. This will be `undefined` if the container\n * element doesn't exist within the DOM.\n *\n * Note: The fixed element styles **will not** contain styles for `z-index` or\n * `background-color` so you'll need to add that manually.\n *\n * @since 4.0.0\n */\nexport interface FixedPositionStyle extends Coords {\n  /**\n   * This will be `\"fixed\"` unless\n   * {@link CalculateFixedPositionOptions.disableVHBounds} is set to `true`.\n   */\n  position: \"fixed\" | \"absolute\";\n\n  /**\n   * This will be `undefined` unless\n   * {@link CalculateFixedPositionOptions.transformOrigin} is set to `true`\n   */\n  transformOrigin?: string;\n}\n\n/**\n * Since the position can be \"swapped\" to help fit the fixed element within the\n * viewport, this interface is used to contain the calculated positions as well\n * as an optional style object to apply.\n */\nexport interface FixedPosition {\n  /**\n   * The calculated horizontal position that can be used to compare to the\n   * provided horizontal position anchor if additional manual updates should be\n   * applied.\n   */\n  actualX: HorizontalPosition;\n\n  /**\n   * The calculated vertical position that can be used to compare to the\n   * provided horizontal position anchor if additional manual updates should be\n   * applied.\n   */\n  actualY: VerticalPosition;\n  /** {@inheritDoc FixedPositionStyle} */\n  style?: FixedPositionStyle;\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GA0ND;;;;CAIC,GACD,WAgBC"}

package/dist/positioning/useFixedPositioning.d.ts

@@ -1,8 +1,8 @@
-import type { CSSProperties, Ref, RefCallback, RefObject } from "react";
-import type { TransitionCallbacks } from "../transition/types.js";
-import type { CalculateFixedPositionOptions } from "./types.js";
+import { type CSSProperties, type Ref, type RefCallback, type RefObject } from "react";
+import { type TransitionCallbacks } from "../transition/types.js";
+import { type CalculateFixedPositionOptions } from "./types.js";
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export type FixedPositioningTransitionCallbacks = Pick<TransitionCallbacks, "onEnter" | "onEntering" | "onEntered" | "onExited">;
 /**
@@ -11,7 +11,7 @@ export type FixedPositioningTransitionCallbacks = Pick<TransitionCallbacks, "onE
  *
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface FixedPositioningTransitionOptions<E extends HTMLElement> extends FixedPositioningTransitionCallbacks {
     /** {@inheritDoc TransitionOptions.nodeRef} */
@@ -20,7 +20,7 @@ export interface FixedPositioningTransitionOptions<E extends HTMLElement> extend
 /**
  * @typeParam FixedToElement - An HTMLElement type for the static element.
  * @typeParam FixedElement - An HTMLElement type for the fixed element.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface FixedPositioningScrollData<FixedToElement extends HTMLElement, FixedElement extends HTMLElement> {
     fixedElement: FixedElement;
@@ -40,13 +40,13 @@ export interface FixedPositioningScrollData<FixedToElement extends HTMLElement,
  * @param event - The scroll event
  * @param data - The {@link FixedPositioningScrollData} that can be used for
  * custom scroll behavior.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export type TransitionScrollCallback<FixedToElement extends HTMLElement, FixedElement extends HTMLElement> = (event: Event, data: Readonly<FixedPositioningScrollData<FixedToElement, FixedElement>>) => void;
 /**
  * @typeParam FixedToElement - An HTMLElement type for the static element.
  * @typeParam FixedElement - An HTMLElement type for the fixed element.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface FixedPositioningOptions<FixedToElement extends HTMLElement, FixedElement extends HTMLElement> extends FixedPositioningTransitionOptions<FixedElement>, CalculateFixedPositionOptions {
     /**
@@ -66,7 +66,7 @@ export interface FixedPositioningOptions<FixedToElement extends HTMLElement, Fix
      * some options require the element to be in the DOM for specific
      * calculations.
      */
-    getFixedPositionOptions?(): CalculateFixedPositionOptions;
+    getFixedPositionOptions?: () => CalculateFixedPositionOptions;
     /**
      * An optional function to call if the page resizes while the `FixedElement`
      * is visible.
@@ -74,12 +74,24 @@ export interface FixedPositioningOptions<FixedToElement extends HTMLElement, Fix
     onResize?: EventListener;
     /** @see {@link TransitionScrollCallback} */
     onScroll?: TransitionScrollCallback<FixedToElement, FixedElement>;
+    /**
+     * Set this to `true` to disable the fixed positioning behavior so it can be
+     * customized within CSS or manually instead. This was added mostly to just
+     * support rendering menus inline with other content (like autocompletes
+     * within a dialog).
+     *
+     * @defaultValue `false`
+     * @since 6.0.0
+     */
+    disabled?: boolean;
 }
 /**
  * @typeParam E - An HTMLElement type for the fixed element.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
+ * @since 6.0.0 Renamed from `FixedPositioningHookReturnValue` to
+ * `FixedPositioningImplementation` to match naming conventions.
  */
-export interface FixedPositioningHookReturnValue<E extends HTMLElement> {
+export interface FixedPositioningImplementation<E extends HTMLElement> {
     /**
      * A ref that should be passed to a component for the fixed positioning
      * behavior to work correctly.
@@ -89,9 +101,12 @@ export interface FixedPositioningHookReturnValue<E extends HTMLElement> {
      */
     ref: RefCallback<E>;
     /**
-     * @see {@link FixedPositionStyle}
+     * This is the {@link FixedPositionStyle} merged with the
+     * {@link FixedPositioningOptions.style}. This will only return `undefined`
+     * when {@link FixedPositioningOptions.disabled} is `true` and no `style` was
+     * provided.
      */
-    style: CSSProperties;
+    style: CSSProperties | undefined;
     /**
      * This should really only be used if the {@link transitionOptions} is not
      * being used.
@@ -100,7 +115,7 @@ export interface FixedPositioningHookReturnValue<E extends HTMLElement> {
     /**
      * A function that can be called to update the style for the fixed element.
      */
-    updateStyle(): void;
+    updateStyle: () => void;
     /** {@inheritDoc FixedPositioningTransitionOptions} */
     transitionOptions: Readonly<Required<FixedPositioningTransitionOptions<E>>>;
 }
@@ -110,11 +125,14 @@ export interface FixedPositioningHookReturnValue<E extends HTMLElement> {
  * `position: fixed` as if it were `position: absolute` to a parent element that
  * had `position: relative`.
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
- * import { ReactElement, useRef, useState } from "react";
- * import { Button, useCSSTransition, useFixedPositioning } from "@react-md/core";
+ * "use client";
+ *
+ * import { Button } from "@react-md/core/button/Button";
+ * import { useFixedPositioning } from "@react-md/core/positioning/useFixedPositioning";
+ * import { useCSSTransition } from "@react-md/core/transition/useCSSTransition";
+ * import { type ReactElement, useRef, useState } from "react";
  *
  * function Example(): ReactElement {
  *   const fixedTo = useRef<HTMLButtonElement>(null);
@@ -140,10 +158,7 @@ export interface FixedPositioningHookReturnValue<E extends HTMLElement> {
  *
  *   return (
  *     <>
- *       <Button
- *         ref={fixedTo}
- *         onClick={() => setTransitionIn(!transitionIn)}
- *       >
+ *       <Button ref={fixedTo} onClick={() => setTransitionIn(!transitionIn)}>
  *         Toggle
  *       </Button>
  *       {rendered && (
@@ -158,6 +173,6 @@ export interface FixedPositioningHookReturnValue<E extends HTMLElement> {
  *
  * @typeParam FixedToElement - An HTMLElement type for the static element.
  * @typeParam FixedElement - An HTMLElement type for the fixed element.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
-export declare function useFixedPositioning<FixedToElement extends HTMLElement, FixedElement extends HTMLElement>(options: FixedPositioningOptions<FixedToElement, FixedElement>): FixedPositioningHookReturnValue<FixedElement>;
+export declare function useFixedPositioning<FixedToElement extends HTMLElement, FixedElement extends HTMLElement>(options: FixedPositioningOptions<FixedToElement, FixedElement>): FixedPositioningImplementation<FixedElement>;

package/dist/positioning/useFixedPositioning.js

@@ -13,11 +13,14 @@ const noop = ()=>undefined;
  * `position: fixed` as if it were `position: absolute` to a parent element that
  * had `position: relative`.
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
- * import { ReactElement, useRef, useState } from "react";
- * import { Button, useCSSTransition, useFixedPositioning } from "@react-md/core";
+ * "use client";
+ *
+ * import { Button } from "@react-md/core/button/Button";
+ * import { useFixedPositioning } from "@react-md/core/positioning/useFixedPositioning";
+ * import { useCSSTransition } from "@react-md/core/transition/useCSSTransition";
+ * import { type ReactElement, useRef, useState } from "react";
  *
  * function Example(): ReactElement {
  *   const fixedTo = useRef<HTMLButtonElement>(null);
@@ -43,10 +46,7 @@ const noop = ()=>undefined;
  *
  *   return (
  *     <>
- *       <Button
- *         ref={fixedTo}
- *         onClick={() => setTransitionIn(!transitionIn)}
- *       >
+ *       <Button ref={fixedTo} onClick={() => setTransitionIn(!transitionIn)}>
  *         Toggle
  *       </Button>
  *       {rendered && (
@@ -61,9 +61,9 @@ const noop = ()=>undefined;
  *
  * @typeParam FixedToElement - An HTMLElement type for the static element.
  * @typeParam FixedElement - An HTMLElement type for the fixed element.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */ export function useFixedPositioning(options) {
-    const { style: propStyle, nodeRef, fixedTo, onEnter = noop, onEntering = noop, onEntered = noop, onExited = noop, anchor = BELOW_CENTER_ANCHOR, disableSwapping, disableVHBounds, initialX, initialY, preventOverlap, transformOrigin, vhMargin, vwMargin, width, xMargin, yMargin, getFixedPositionOptions = noop, onScroll, onResize = noop } = options;
+    const { style: propStyle, nodeRef, fixedTo, disabled, onEnter = noop, onEntering = noop, onEntered = noop, onExited = noop, anchor = BELOW_CENTER_ANCHOR, disableSwapping, disableVHBounds, initialX, initialY, preventOverlap, transformOrigin, vhMargin, vwMargin, width, xMargin, yMargin, getFixedPositionOptions = noop, onScroll, onResize = noop } = options;
     const [active, setActive] = useState(false);
     const [ref, refHandler] = useEnsuredRef(nodeRef);
     const optionsRef = useRef({
@@ -130,6 +130,9 @@ const noop = ()=>undefined;
             ...getFixedPositionOptions()
         }).style);
     const updateStyle = useCallback(()=>{
+        if (disabled) {
+            return;
+        }
         const { ref, fixedTo, anchor, disableSwapping, disableVHBounds, preventOverlap, transformOrigin, vhMargin, vwMargin, width, xMargin, yMargin, getFixedPositionOptions } = optionsRef.current;
         const element = ref.current;
         const container = fixedTo.current;
@@ -152,14 +155,15 @@ const noop = ()=>undefined;
         });
         setStyle(style);
         setActive(!!element && !element.hidden);
-    // Only changing the initialX and initialY should cause the useEffect below
-    // to trigger, which is why everything else is set in a ref.
+    // Only changing the initialX, initialY, or disabled should cause the
+    // useEffect below to trigger, which is why everything else is set in a ref.
     }, [
+        disabled,
         initialX,
         initialY
     ]);
     useEffect(()=>{
-        if (!active) {
+        if (!active || disabled) {
             return;
         }
         const resizeCallback = (event)=>{
@@ -193,20 +197,13 @@ const noop = ()=>undefined;
         };
     }, [
         active,
+        disabled,
         fixedTo,
         onResize,
         onScroll,
         ref,
         updateStyle
     ]);
-    useEffect(()=>{
-        if (!ref.current || !ref.current.hidden) {
-            updateStyle();
-        }
-    }, [
-        ref,
-        updateStyle
-    ]);
     const callbacks = {
         onEnter (appearing) {
             onEnter(appearing);
@@ -227,7 +224,7 @@ const noop = ()=>undefined;
     };
     return {
         ref: refHandler,
-        style: {
+        style: disabled ? propStyle : {
             ...style,
             ...propStyle
         },

package/dist/positioning/useFixedPositioning.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/positioning/useFixedPositioning.ts"],"sourcesContent":["\"use client\";\nimport type { CSSProperties, Ref, RefCallback, RefObject } from \"react\";\nimport { useCallback, useEffect, useRef, useState } from \"react\";\nimport { delegateEvent } from \"../delegateEvent.js\";\nimport type { TransitionCallbacks } from \"../transition/types.js\";\nimport { useEnsuredRef } from \"../useEnsuredRef.js\";\nimport { useIsomorphicLayoutEffect } from \"../useIsomorphicLayoutEffect.js\";\nimport { BELOW_CENTER_ANCHOR } from \"./constants.js\";\nimport { getFixedPosition } from \"./getFixedPosition.js\";\nimport type { CalculateFixedPositionOptions } from \"./types.js\";\nimport { isWithinViewport } from \"./utils.js\";\n\nconst noop = (): undefined => undefined;\n\n/**\n * @remarks \\@since 4.0.0\n */\nexport type FixedPositioningTransitionCallbacks = Pick<\n  TransitionCallbacks,\n  \"onEnter\" | \"onEntering\" | \"onEntered\" | \"onExited\"\n>;\n\n/**\n * This options should be passed to the {@link useCSSTransition} for the styling\n * and positioning to work correctly.\n *\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface FixedPositioningTransitionOptions<E extends HTMLElement>\n  extends FixedPositioningTransitionCallbacks {\n  /** {@inheritDoc TransitionOptions.nodeRef} */\n  nodeRef?: Ref<E>;\n}\n\n/**\n * @typeParam FixedToElement - An HTMLElement type for the static element.\n * @typeParam FixedElement - An HTMLElement type for the fixed element.\n * @remarks \\@since 4.0.0\n */\nexport interface FixedPositioningScrollData<\n  FixedToElement extends HTMLElement,\n  FixedElement extends HTMLElement,\n> {\n  fixedElement: FixedElement;\n  fixedToElement: FixedToElement;\n\n  /**\n   * Boolean if the {@link fixedToElement} is visible within the viewport.\n   */\n  visible: boolean;\n}\n\n/**\n * This function is called when the page is scrolled while the fixed element is\n * visible. This is generally used to reposition the fixed element or hide it if\n * it is no longer visible within the viewport.\n *\n * @typeParam FixedToElement - An HTMLElement type for the static element.\n * @typeParam FixedElement - An HTMLElement type for the fixed element.\n * @param event - The scroll event\n * @param data - The {@link FixedPositioningScrollData} that can be used for\n * custom scroll behavior.\n * @remarks \\@since 4.0.0\n */\nexport type TransitionScrollCallback<\n  FixedToElement extends HTMLElement,\n  FixedElement extends HTMLElement,\n> = (\n  event: Event,\n  data: Readonly<FixedPositioningScrollData<FixedToElement, FixedElement>>\n) => void;\n\n/**\n * @typeParam FixedToElement - An HTMLElement type for the static element.\n * @typeParam FixedElement - An HTMLElement type for the fixed element.\n * @remarks \\@since 4.0.0\n */\nexport interface FixedPositioningOptions<\n  FixedToElement extends HTMLElement,\n  FixedElement extends HTMLElement,\n> extends FixedPositioningTransitionOptions<FixedElement>,\n    CalculateFixedPositionOptions {\n  /**\n   * An optional style that will be merged with the fixed positioning required\n   * styles.\n   *\n   * @see {@link FixedPositionStyle}\n   */\n  style?: CSSProperties;\n\n  /**\n   * A ref pointing to an element that another element should be fixed to. This\n   * **must** be provided for the positioning to work.\n   */\n  fixedTo: RefObject<FixedToElement>;\n\n  /**\n   * An optional function that can be used to override positioning options if\n   * some options require the element to be in the DOM for specific\n   * calculations.\n   */\n  getFixedPositionOptions?(): CalculateFixedPositionOptions;\n\n  /**\n   * An optional function to call if the page resizes while the `FixedElement`\n   * is visible.\n   */\n  onResize?: EventListener;\n  /** @see {@link TransitionScrollCallback} */\n  onScroll?: TransitionScrollCallback<FixedToElement, FixedElement>;\n}\n\n/**\n * @typeParam E - An HTMLElement type for the fixed element.\n * @remarks \\@since 4.0.0\n */\nexport interface FixedPositioningHookReturnValue<E extends HTMLElement> {\n  /**\n   * A ref that should be passed to a component for the fixed positioning\n   * behavior to work correctly.\n   *\n   * This should really only be used if the {@link TransitionOptions} is not\n   * being used.\n   */\n  ref: RefCallback<E>;\n\n  /**\n   * @see {@link FixedPositionStyle}\n   */\n  style: CSSProperties;\n\n  /**\n   * This should really only be used if the {@link transitionOptions} is not\n   * being used.\n   */\n  callbacks: Readonly<Required<FixedPositioningTransitionCallbacks>>;\n\n  /**\n   * A function that can be called to update the style for the fixed element.\n   */\n  updateStyle(): void;\n\n  /** {@inheritDoc FixedPositioningTransitionOptions} */\n  transitionOptions: Readonly<Required<FixedPositioningTransitionOptions<E>>>;\n}\n\n/**\n * This hook is used to attach a temporary (fixed) element to another element\n * within the page. In other words, this is a way to have an element with\n * `position: fixed` as if it were `position: absolute` to a parent element that\n * had `position: relative`.\n *\n * @example\n * Simple Example\n * ```tsx\n * import { ReactElement, useRef, useState } from \"react\";\n * import { Button, useCSSTransition, useFixedPositioning } from \"@react-md/core\";\n *\n * function Example(): ReactElement {\n *   const fixedTo = useRef<HTMLButtonElement>(null);\n *   const [transitionIn, setTransitionIn] = useState(false);\n *   const { style, transitionOptions } = useFixedPositioning({\n *     fixedTo,\n *   });\n *   const { elementProps, rendered } = useCSSTransition({\n *     ...transitionOptions,\n *     transitionIn,\n *     temporary: true,\n *     timeout: {\n *       enter: 200,\n *       exit: 150,\n *     },\n *     classNames: {\n *       enter: \"enter\",\n *       enterActive: \"enter--active\",\n *       exit: \"exit\",\n *       exitActive: \"exit--active\",\n *     },\n *   });\n *\n *   return (\n *     <>\n *       <Button\n *         ref={fixedTo}\n *         onClick={() => setTransitionIn(!transitionIn)}\n *       >\n *         Toggle\n *       </Button>\n *       {rendered && (\n *         <div {...elementProps} style={style}>\n *           Fixed Temporary Element\n *         </div>\n *       )}\n *     </>\n *   );\n * }\n * ```\n *\n * @typeParam FixedToElement - An HTMLElement type for the static element.\n * @typeParam FixedElement - An HTMLElement type for the fixed element.\n * @remarks \\@since 4.0.0\n */\nexport function useFixedPositioning<\n  FixedToElement extends HTMLElement,\n  FixedElement extends HTMLElement,\n>(\n  options: FixedPositioningOptions<FixedToElement, FixedElement>\n): FixedPositioningHookReturnValue<FixedElement> {\n  const {\n    style: propStyle,\n    nodeRef,\n    fixedTo,\n    onEnter = noop,\n    onEntering = noop,\n    onEntered = noop,\n    onExited = noop,\n    anchor = BELOW_CENTER_ANCHOR,\n    disableSwapping,\n    disableVHBounds,\n    initialX,\n    initialY,\n    preventOverlap,\n    transformOrigin,\n    vhMargin,\n    vwMargin,\n    width,\n    xMargin,\n    yMargin,\n    getFixedPositionOptions = noop,\n    onScroll,\n    onResize = noop,\n  } = options;\n\n  const [active, setActive] = useState(false);\n  const [ref, refHandler] = useEnsuredRef(nodeRef);\n  const optionsRef = useRef({\n    ref,\n    fixedTo,\n    anchor,\n    disableSwapping,\n    disableVHBounds,\n    preventOverlap,\n    transformOrigin,\n    vhMargin,\n    vwMargin,\n    width,\n    xMargin,\n    yMargin,\n    getFixedPositionOptions,\n  } as const);\n  useIsomorphicLayoutEffect(() => {\n    optionsRef.current = {\n      ref,\n      fixedTo,\n      anchor,\n      disableSwapping,\n      disableVHBounds,\n      preventOverlap,\n      transformOrigin,\n      vhMargin,\n      vwMargin,\n      width,\n      xMargin,\n      yMargin,\n      getFixedPositionOptions,\n    };\n  }, [\n    ref,\n    fixedTo,\n    anchor,\n    disableSwapping,\n    disableVHBounds,\n    preventOverlap,\n    transformOrigin,\n    vhMargin,\n    vwMargin,\n    width,\n    xMargin,\n    yMargin,\n    getFixedPositionOptions,\n  ]);\n  const [style, setStyle] = useState<CSSProperties | undefined>(\n    () =>\n      getFixedPosition({\n        container: ref.current,\n        element: fixedTo.current,\n        anchor,\n        disableSwapping,\n        disableVHBounds,\n        initialX,\n        initialY,\n        preventOverlap,\n        transformOrigin,\n        vhMargin,\n        vwMargin,\n        width,\n        xMargin,\n        yMargin,\n        ...getFixedPositionOptions(),\n      }).style\n  );\n\n  const updateStyle = useCallback(() => {\n    const {\n      ref,\n      fixedTo,\n      anchor,\n      disableSwapping,\n      disableVHBounds,\n      preventOverlap,\n      transformOrigin,\n      vhMargin,\n      vwMargin,\n      width,\n      xMargin,\n      yMargin,\n      getFixedPositionOptions,\n    } = optionsRef.current;\n    const element = ref.current;\n    const container = fixedTo.current;\n    const { style } = getFixedPosition({\n      container,\n      element,\n      anchor,\n      disableSwapping,\n      disableVHBounds,\n      initialX,\n      initialY,\n      preventOverlap,\n      transformOrigin,\n      vhMargin,\n      vwMargin,\n      width,\n      xMargin,\n      yMargin,\n      ...getFixedPositionOptions(),\n    });\n\n    setStyle(style);\n    setActive(!!element && !element.hidden);\n\n    // Only changing the initialX and initialY should cause the useEffect below\n    // to trigger, which is why everything else is set in a ref.\n  }, [initialX, initialY]);\n\n  useEffect(() => {\n    if (!active) {\n      return;\n    }\n\n    const resizeCallback = (event: Event): void => {\n      onResize(event);\n      updateStyle();\n    };\n    const scrollCallback = (event: Event): void => {\n      const fixedElement = ref.current;\n      const fixedToElement = fixedTo.current;\n      if (onScroll && fixedElement && fixedToElement) {\n        onScroll(event, {\n          visible: isWithinViewport({ fixedElement, fixedToElement }),\n          fixedElement,\n          fixedToElement,\n        });\n      }\n\n      updateStyle();\n    };\n\n    const resizeHandler = delegateEvent(\"resize\", window, true);\n    const scrollHandler = delegateEvent(\"scroll\", window, true, {\n      passive: true,\n    });\n    resizeHandler.add(resizeCallback);\n    scrollHandler.add(scrollCallback);\n    return () => {\n      resizeHandler.remove(resizeCallback);\n      scrollHandler.remove(scrollCallback);\n    };\n  }, [active, fixedTo, onResize, onScroll, ref, updateStyle]);\n\n  useEffect(() => {\n    if (!ref.current || !ref.current.hidden) {\n      updateStyle();\n    }\n  }, [ref, updateStyle]);\n\n  const callbacks: Required<FixedPositioningTransitionCallbacks> = {\n    onEnter(appearing) {\n      onEnter(appearing);\n      updateStyle();\n    },\n    onEntering(appearing) {\n      onEntering(appearing);\n      updateStyle();\n    },\n    onEntered(appearing) {\n      onEntered(appearing);\n      updateStyle();\n    },\n    onExited() {\n      onExited();\n      setActive(false);\n    },\n  };\n\n  return {\n    ref: refHandler,\n    style: { ...style, ...propStyle },\n    callbacks,\n    updateStyle,\n    transitionOptions: {\n      ...callbacks,\n      nodeRef: refHandler,\n    },\n  };\n}\n"],"names":["useCallback","useEffect","useRef","useState","delegateEvent","useEnsuredRef","useIsomorphicLayoutEffect","BELOW_CENTER_ANCHOR","getFixedPosition","isWithinViewport","noop","undefined","useFixedPositioning","options","style","propStyle","nodeRef","fixedTo","onEnter","onEntering","onEntered","onExited","anchor","disableSwapping","disableVHBounds","initialX","initialY","preventOverlap","transformOrigin","vhMargin","vwMargin","width","xMargin","yMargin","getFixedPositionOptions","onScroll","onResize","active","setActive","ref","refHandler","optionsRef","current","setStyle","container","element","updateStyle","hidden","resizeCallback","event","scrollCallback","fixedElement","fixedToElement","visible","resizeHandler","window","scrollHandler","passive","add","remove","callbacks","appearing","transitionOptions"],"mappings":"AAAA;AAEA,SAASA,WAAW,EAAEC,SAAS,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,QAAQ;AACjE,SAASC,aAAa,QAAQ,sBAAsB;AAEpD,SAASC,aAAa,QAAQ,sBAAsB;AACpD,SAASC,yBAAyB,QAAQ,kCAAkC;AAC5E,SAASC,mBAAmB,QAAQ,iBAAiB;AACrD,SAASC,gBAAgB,QAAQ,wBAAwB;AAEzD,SAASC,gBAAgB,QAAQ,aAAa;AAE9C,MAAMC,OAAO,IAAiBC;AAwI9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuDC,GACD,OAAO,SAASC,oBAIdC,OAA8D;IAE9D,MAAM,EACJC,OAAOC,SAAS,EAChBC,OAAO,EACPC,OAAO,EACPC,UAAUR,IAAI,EACdS,aAAaT,IAAI,EACjBU,YAAYV,IAAI,EAChBW,WAAWX,IAAI,EACfY,SAASf,mBAAmB,EAC5BgB,eAAe,EACfC,eAAe,EACfC,QAAQ,EACRC,QAAQ,EACRC,cAAc,EACdC,eAAe,EACfC,QAAQ,EACRC,QAAQ,EACRC,KAAK,EACLC,OAAO,EACPC,OAAO,EACPC,0BAA0BxB,IAAI,EAC9ByB,QAAQ,EACRC,WAAW1B,IAAI,EAChB,GAAGG;IAEJ,MAAM,CAACwB,QAAQC,UAAU,GAAGnC,SAAS;IACrC,MAAM,CAACoC,KAAKC,WAAW,GAAGnC,cAAcW;IACxC,MAAMyB,aAAavC,OAAO;QACxBqC;QACAtB;QACAK;QACAC;QACAC;QACAG;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;IACF;IACA5B,0BAA0B;QACxBmC,WAAWC,OAAO,GAAG;YACnBH;YACAtB;YACAK;YACAC;YACAC;YACAG;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;QACF;IACF,GAAG;QACDK;QACAtB;QACAK;QACAC;QACAC;QACAG;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;KACD;IACD,MAAM,CAACpB,OAAO6B,SAAS,GAAGxC,SACxB,IACEK,iBAAiB;YACfoC,WAAWL,IAAIG,OAAO;YACtBG,SAAS5B,QAAQyB,OAAO;YACxBpB;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACA,GAAGC,yBAAyB;QAC9B,GAAGpB,KAAK;IAGZ,MAAMgC,cAAc9C,YAAY;QAC9B,MAAM,EACJuC,GAAG,EACHtB,OAAO,EACPK,MAAM,EACNC,eAAe,EACfC,eAAe,EACfG,cAAc,EACdC,eAAe,EACfC,QAAQ,EACRC,QAAQ,EACRC,KAAK,EACLC,OAAO,EACPC,OAAO,EACPC,uBAAuB,EACxB,GAAGO,WAAWC,OAAO;QACtB,MAAMG,UAAUN,IAAIG,OAAO;QAC3B,MAAME,YAAY3B,QAAQyB,OAAO;QACjC,MAAM,EAAE5B,KAAK,EAAE,GAAGN,iBAAiB;YACjCoC;YACAC;YACAvB;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACA,GAAGC,yBAAyB;QAC9B;QAEAS,SAAS7B;QACTwB,UAAU,CAAC,CAACO,WAAW,CAACA,QAAQE,MAAM;IAEtC,2EAA2E;IAC3E,4DAA4D;IAC9D,GAAG;QAACtB;QAAUC;KAAS;IAEvBzB,UAAU;QACR,IAAI,CAACoC,QAAQ;YACX;QACF;QAEA,MAAMW,iBAAiB,CAACC;YACtBb,SAASa;YACTH;QACF;QACA,MAAMI,iBAAiB,CAACD;YACtB,MAAME,eAAeZ,IAAIG,OAAO;YAChC,MAAMU,iBAAiBnC,QAAQyB,OAAO;YACtC,IAAIP,YAAYgB,gBAAgBC,gBAAgB;gBAC9CjB,SAASc,OAAO;oBACdI,SAAS5C,iBAAiB;wBAAE0C;wBAAcC;oBAAe;oBACzDD;oBACAC;gBACF;YACF;YAEAN;QACF;QAEA,MAAMQ,gBAAgBlD,cAAc,UAAUmD,QAAQ;QACtD,MAAMC,gBAAgBpD,cAAc,UAAUmD,QAAQ,MAAM;YAC1DE,SAAS;QACX;QACAH,cAAcI,GAAG,CAACV;QAClBQ,cAAcE,GAAG,CAACR;QAClB,OAAO;YACLI,cAAcK,MAAM,CAACX;YACrBQ,cAAcG,MAAM,CAACT;QACvB;IACF,GAAG;QAACb;QAAQpB;QAASmB;QAAUD;QAAUI;QAAKO;KAAY;IAE1D7C,UAAU;QACR,IAAI,CAACsC,IAAIG,OAAO,IAAI,CAACH,IAAIG,OAAO,CAACK,MAAM,EAAE;YACvCD;QACF;IACF,GAAG;QAACP;QAAKO;KAAY;IAErB,MAAMc,YAA2D;QAC/D1C,SAAQ2C,SAAS;YACf3C,QAAQ2C;YACRf;QACF;QACA3B,YAAW0C,SAAS;YAClB1C,WAAW0C;YACXf;QACF;QACA1B,WAAUyC,SAAS;YACjBzC,UAAUyC;YACVf;QACF;QACAzB;YACEA;YACAiB,UAAU;QACZ;IACF;IAEA,OAAO;QACLC,KAAKC;QACL1B,OAAO;YAAE,GAAGA,KAAK;YAAE,GAAGC,SAAS;QAAC;QAChC6C;QACAd;QACAgB,mBAAmB;YACjB,GAAGF,SAAS;YACZ5C,SAASwB;QACX;IACF;AACF"}
+{"version":3,"sources":["../../src/positioning/useFixedPositioning.ts"],"sourcesContent":["\"use client\";\n\nimport {\n  type CSSProperties,\n  type Ref,\n  type RefCallback,\n  type RefObject,\n  useCallback,\n  useEffect,\n  useRef,\n  useState,\n} from \"react\";\n\nimport { delegateEvent } from \"../delegateEvent.js\";\nimport { type TransitionCallbacks } from \"../transition/types.js\";\nimport { useEnsuredRef } from \"../useEnsuredRef.js\";\nimport { useIsomorphicLayoutEffect } from \"../useIsomorphicLayoutEffect.js\";\nimport { BELOW_CENTER_ANCHOR } from \"./constants.js\";\nimport { getFixedPosition } from \"./getFixedPosition.js\";\nimport {\n  type CalculateFixedPositionOptions,\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  type FixedPositionStyle,\n} from \"./types.js\";\nimport { isWithinViewport } from \"./utils.js\";\n\nconst noop = (): undefined => undefined;\n\n/**\n * @since 4.0.0\n */\nexport type FixedPositioningTransitionCallbacks = Pick<\n  TransitionCallbacks,\n  \"onEnter\" | \"onEntering\" | \"onEntered\" | \"onExited\"\n>;\n\n/**\n * This options should be passed to the {@link useCSSTransition} for the styling\n * and positioning to work correctly.\n *\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface FixedPositioningTransitionOptions<E extends HTMLElement>\n  extends FixedPositioningTransitionCallbacks {\n  /** {@inheritDoc TransitionOptions.nodeRef} */\n  nodeRef?: Ref<E>;\n}\n\n/**\n * @typeParam FixedToElement - An HTMLElement type for the static element.\n * @typeParam FixedElement - An HTMLElement type for the fixed element.\n * @since 4.0.0\n */\nexport interface FixedPositioningScrollData<\n  FixedToElement extends HTMLElement,\n  FixedElement extends HTMLElement,\n> {\n  fixedElement: FixedElement;\n  fixedToElement: FixedToElement;\n\n  /**\n   * Boolean if the {@link fixedToElement} is visible within the viewport.\n   */\n  visible: boolean;\n}\n\n/**\n * This function is called when the page is scrolled while the fixed element is\n * visible. This is generally used to reposition the fixed element or hide it if\n * it is no longer visible within the viewport.\n *\n * @typeParam FixedToElement - An HTMLElement type for the static element.\n * @typeParam FixedElement - An HTMLElement type for the fixed element.\n * @param event - The scroll event\n * @param data - The {@link FixedPositioningScrollData} that can be used for\n * custom scroll behavior.\n * @since 4.0.0\n */\nexport type TransitionScrollCallback<\n  FixedToElement extends HTMLElement,\n  FixedElement extends HTMLElement,\n> = (\n  event: Event,\n  data: Readonly<FixedPositioningScrollData<FixedToElement, FixedElement>>\n) => void;\n\n/**\n * @typeParam FixedToElement - An HTMLElement type for the static element.\n * @typeParam FixedElement - An HTMLElement type for the fixed element.\n * @since 4.0.0\n */\nexport interface FixedPositioningOptions<\n  FixedToElement extends HTMLElement,\n  FixedElement extends HTMLElement,\n> extends FixedPositioningTransitionOptions<FixedElement>,\n    CalculateFixedPositionOptions {\n  /**\n   * An optional style that will be merged with the fixed positioning required\n   * styles.\n   *\n   * @see {@link FixedPositionStyle}\n   */\n  style?: CSSProperties;\n\n  /**\n   * A ref pointing to an element that another element should be fixed to. This\n   * **must** be provided for the positioning to work.\n   */\n  fixedTo: RefObject<FixedToElement>;\n\n  /**\n   * An optional function that can be used to override positioning options if\n   * some options require the element to be in the DOM for specific\n   * calculations.\n   */\n  getFixedPositionOptions?: () => CalculateFixedPositionOptions;\n\n  /**\n   * An optional function to call if the page resizes while the `FixedElement`\n   * is visible.\n   */\n  onResize?: EventListener;\n  /** @see {@link TransitionScrollCallback} */\n  onScroll?: TransitionScrollCallback<FixedToElement, FixedElement>;\n\n  /**\n   * Set this to `true` to disable the fixed positioning behavior so it can be\n   * customized within CSS or manually instead. This was added mostly to just\n   * support rendering menus inline with other content (like autocompletes\n   * within a dialog).\n   *\n   * @defaultValue `false`\n   * @since 6.0.0\n   */\n  disabled?: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type for the fixed element.\n * @since 4.0.0\n * @since 6.0.0 Renamed from `FixedPositioningHookReturnValue` to\n * `FixedPositioningImplementation` to match naming conventions.\n */\nexport interface FixedPositioningImplementation<E extends HTMLElement> {\n  /**\n   * A ref that should be passed to a component for the fixed positioning\n   * behavior to work correctly.\n   *\n   * This should really only be used if the {@link TransitionOptions} is not\n   * being used.\n   */\n  ref: RefCallback<E>;\n\n  /**\n   * This is the {@link FixedPositionStyle} merged with the\n   * {@link FixedPositioningOptions.style}. This will only return `undefined`\n   * when {@link FixedPositioningOptions.disabled} is `true` and no `style` was\n   * provided.\n   */\n  style: CSSProperties | undefined;\n\n  /**\n   * This should really only be used if the {@link transitionOptions} is not\n   * being used.\n   */\n  callbacks: Readonly<Required<FixedPositioningTransitionCallbacks>>;\n\n  /**\n   * A function that can be called to update the style for the fixed element.\n   */\n  updateStyle: () => void;\n\n  /** {@inheritDoc FixedPositioningTransitionOptions} */\n  transitionOptions: Readonly<Required<FixedPositioningTransitionOptions<E>>>;\n}\n\n/**\n * This hook is used to attach a temporary (fixed) element to another element\n * within the page. In other words, this is a way to have an element with\n * `position: fixed` as if it were `position: absolute` to a parent element that\n * had `position: relative`.\n *\n * @example Simple Example\n * ```tsx\n * \"use client\";\n *\n * import { Button } from \"@react-md/core/button/Button\";\n * import { useFixedPositioning } from \"@react-md/core/positioning/useFixedPositioning\";\n * import { useCSSTransition } from \"@react-md/core/transition/useCSSTransition\";\n * import { type ReactElement, useRef, useState } from \"react\";\n *\n * function Example(): ReactElement {\n *   const fixedTo = useRef<HTMLButtonElement>(null);\n *   const [transitionIn, setTransitionIn] = useState(false);\n *   const { style, transitionOptions } = useFixedPositioning({\n *     fixedTo,\n *   });\n *   const { elementProps, rendered } = useCSSTransition({\n *     ...transitionOptions,\n *     transitionIn,\n *     temporary: true,\n *     timeout: {\n *       enter: 200,\n *       exit: 150,\n *     },\n *     classNames: {\n *       enter: \"enter\",\n *       enterActive: \"enter--active\",\n *       exit: \"exit\",\n *       exitActive: \"exit--active\",\n *     },\n *   });\n *\n *   return (\n *     <>\n *       <Button ref={fixedTo} onClick={() => setTransitionIn(!transitionIn)}>\n *         Toggle\n *       </Button>\n *       {rendered && (\n *         <div {...elementProps} style={style}>\n *           Fixed Temporary Element\n *         </div>\n *       )}\n *     </>\n *   );\n * }\n * ```\n *\n * @typeParam FixedToElement - An HTMLElement type for the static element.\n * @typeParam FixedElement - An HTMLElement type for the fixed element.\n * @since 4.0.0\n */\nexport function useFixedPositioning<\n  FixedToElement extends HTMLElement,\n  FixedElement extends HTMLElement,\n>(\n  options: FixedPositioningOptions<FixedToElement, FixedElement>\n): FixedPositioningImplementation<FixedElement> {\n  const {\n    style: propStyle,\n    nodeRef,\n    fixedTo,\n    disabled,\n    onEnter = noop,\n    onEntering = noop,\n    onEntered = noop,\n    onExited = noop,\n    anchor = BELOW_CENTER_ANCHOR,\n    disableSwapping,\n    disableVHBounds,\n    initialX,\n    initialY,\n    preventOverlap,\n    transformOrigin,\n    vhMargin,\n    vwMargin,\n    width,\n    xMargin,\n    yMargin,\n    getFixedPositionOptions = noop,\n    onScroll,\n    onResize = noop,\n  } = options;\n\n  const [active, setActive] = useState(false);\n  const [ref, refHandler] = useEnsuredRef(nodeRef);\n  const optionsRef = useRef({\n    ref,\n    fixedTo,\n    anchor,\n    disableSwapping,\n    disableVHBounds,\n    preventOverlap,\n    transformOrigin,\n    vhMargin,\n    vwMargin,\n    width,\n    xMargin,\n    yMargin,\n    getFixedPositionOptions,\n  } as const);\n  useIsomorphicLayoutEffect(() => {\n    optionsRef.current = {\n      ref,\n      fixedTo,\n      anchor,\n      disableSwapping,\n      disableVHBounds,\n      preventOverlap,\n      transformOrigin,\n      vhMargin,\n      vwMargin,\n      width,\n      xMargin,\n      yMargin,\n      getFixedPositionOptions,\n    };\n  }, [\n    ref,\n    fixedTo,\n    anchor,\n    disableSwapping,\n    disableVHBounds,\n    preventOverlap,\n    transformOrigin,\n    vhMargin,\n    vwMargin,\n    width,\n    xMargin,\n    yMargin,\n    getFixedPositionOptions,\n  ]);\n  const [style, setStyle] = useState<CSSProperties | undefined>(\n    () =>\n      getFixedPosition({\n        container: ref.current,\n        element: fixedTo.current,\n        anchor,\n        disableSwapping,\n        disableVHBounds,\n        initialX,\n        initialY,\n        preventOverlap,\n        transformOrigin,\n        vhMargin,\n        vwMargin,\n        width,\n        xMargin,\n        yMargin,\n        ...getFixedPositionOptions(),\n      }).style\n  );\n\n  const updateStyle = useCallback(() => {\n    if (disabled) {\n      return;\n    }\n\n    const {\n      ref,\n      fixedTo,\n      anchor,\n      disableSwapping,\n      disableVHBounds,\n      preventOverlap,\n      transformOrigin,\n      vhMargin,\n      vwMargin,\n      width,\n      xMargin,\n      yMargin,\n      getFixedPositionOptions,\n    } = optionsRef.current;\n    const element = ref.current;\n    const container = fixedTo.current;\n    const { style } = getFixedPosition({\n      container,\n      element,\n      anchor,\n      disableSwapping,\n      disableVHBounds,\n      initialX,\n      initialY,\n      preventOverlap,\n      transformOrigin,\n      vhMargin,\n      vwMargin,\n      width,\n      xMargin,\n      yMargin,\n      ...getFixedPositionOptions(),\n    });\n\n    setStyle(style);\n    setActive(!!element && !element.hidden);\n\n    // Only changing the initialX, initialY, or disabled should cause the\n    // useEffect below to trigger, which is why everything else is set in a ref.\n  }, [disabled, initialX, initialY]);\n\n  useEffect(() => {\n    if (!active || disabled) {\n      return;\n    }\n\n    const resizeCallback = (event: Event): void => {\n      onResize(event);\n      updateStyle();\n    };\n    const scrollCallback = (event: Event): void => {\n      const fixedElement = ref.current;\n      const fixedToElement = fixedTo.current;\n      if (onScroll && fixedElement && fixedToElement) {\n        onScroll(event, {\n          visible: isWithinViewport({ fixedElement, fixedToElement }),\n          fixedElement,\n          fixedToElement,\n        });\n      }\n\n      updateStyle();\n    };\n\n    const resizeHandler = delegateEvent(\"resize\", window, true);\n    const scrollHandler = delegateEvent(\"scroll\", window, true, {\n      passive: true,\n    });\n    resizeHandler.add(resizeCallback);\n    scrollHandler.add(scrollCallback);\n    return () => {\n      resizeHandler.remove(resizeCallback);\n      scrollHandler.remove(scrollCallback);\n    };\n  }, [active, disabled, fixedTo, onResize, onScroll, ref, updateStyle]);\n\n  const callbacks: Required<FixedPositioningTransitionCallbacks> = {\n    onEnter(appearing) {\n      onEnter(appearing);\n      updateStyle();\n    },\n    onEntering(appearing) {\n      onEntering(appearing);\n      updateStyle();\n    },\n    onEntered(appearing) {\n      onEntered(appearing);\n      updateStyle();\n    },\n    onExited() {\n      onExited();\n      setActive(false);\n    },\n  };\n\n  return {\n    ref: refHandler,\n    style: disabled ? propStyle : { ...style, ...propStyle },\n    callbacks,\n    updateStyle,\n    transitionOptions: {\n      ...callbacks,\n      nodeRef: refHandler,\n    },\n  };\n}\n"],"names":["useCallback","useEffect","useRef","useState","delegateEvent","useEnsuredRef","useIsomorphicLayoutEffect","BELOW_CENTER_ANCHOR","getFixedPosition","isWithinViewport","noop","undefined","useFixedPositioning","options","style","propStyle","nodeRef","fixedTo","disabled","onEnter","onEntering","onEntered","onExited","anchor","disableSwapping","disableVHBounds","initialX","initialY","preventOverlap","transformOrigin","vhMargin","vwMargin","width","xMargin","yMargin","getFixedPositionOptions","onScroll","onResize","active","setActive","ref","refHandler","optionsRef","current","setStyle","container","element","updateStyle","hidden","resizeCallback","event","scrollCallback","fixedElement","fixedToElement","visible","resizeHandler","window","scrollHandler","passive","add","remove","callbacks","appearing","transitionOptions"],"mappings":"AAAA;AAEA,SAKEA,WAAW,EACXC,SAAS,EACTC,MAAM,EACNC,QAAQ,QACH,QAAQ;AAEf,SAASC,aAAa,QAAQ,sBAAsB;AAEpD,SAASC,aAAa,QAAQ,sBAAsB;AACpD,SAASC,yBAAyB,QAAQ,kCAAkC;AAC5E,SAASC,mBAAmB,QAAQ,iBAAiB;AACrD,SAASC,gBAAgB,QAAQ,wBAAwB;AAMzD,SAASC,gBAAgB,QAAQ,aAAa;AAE9C,MAAMC,OAAO,IAAiBC;AAwJ9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuDC,GACD,OAAO,SAASC,oBAIdC,OAA8D;IAE9D,MAAM,EACJC,OAAOC,SAAS,EAChBC,OAAO,EACPC,OAAO,EACPC,QAAQ,EACRC,UAAUT,IAAI,EACdU,aAAaV,IAAI,EACjBW,YAAYX,IAAI,EAChBY,WAAWZ,IAAI,EACfa,SAAShB,mBAAmB,EAC5BiB,eAAe,EACfC,eAAe,EACfC,QAAQ,EACRC,QAAQ,EACRC,cAAc,EACdC,eAAe,EACfC,QAAQ,EACRC,QAAQ,EACRC,KAAK,EACLC,OAAO,EACPC,OAAO,EACPC,0BAA0BzB,IAAI,EAC9B0B,QAAQ,EACRC,WAAW3B,IAAI,EAChB,GAAGG;IAEJ,MAAM,CAACyB,QAAQC,UAAU,GAAGpC,SAAS;IACrC,MAAM,CAACqC,KAAKC,WAAW,GAAGpC,cAAcW;IACxC,MAAM0B,aAAaxC,OAAO;QACxBsC;QACAvB;QACAM;QACAC;QACAC;QACAG;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;IACF;IACA7B,0BAA0B;QACxBoC,WAAWC,OAAO,GAAG;YACnBH;YACAvB;YACAM;YACAC;YACAC;YACAG;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;QACF;IACF,GAAG;QACDK;QACAvB;QACAM;QACAC;QACAC;QACAG;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;KACD;IACD,MAAM,CAACrB,OAAO8B,SAAS,GAAGzC,SACxB,IACEK,iBAAiB;YACfqC,WAAWL,IAAIG,OAAO;YACtBG,SAAS7B,QAAQ0B,OAAO;YACxBpB;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACA,GAAGC,yBAAyB;QAC9B,GAAGrB,KAAK;IAGZ,MAAMiC,cAAc/C,YAAY;QAC9B,IAAIkB,UAAU;YACZ;QACF;QAEA,MAAM,EACJsB,GAAG,EACHvB,OAAO,EACPM,MAAM,EACNC,eAAe,EACfC,eAAe,EACfG,cAAc,EACdC,eAAe,EACfC,QAAQ,EACRC,QAAQ,EACRC,KAAK,EACLC,OAAO,EACPC,OAAO,EACPC,uBAAuB,EACxB,GAAGO,WAAWC,OAAO;QACtB,MAAMG,UAAUN,IAAIG,OAAO;QAC3B,MAAME,YAAY5B,QAAQ0B,OAAO;QACjC,MAAM,EAAE7B,KAAK,EAAE,GAAGN,iBAAiB;YACjCqC;YACAC;YACAvB;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACA,GAAGC,yBAAyB;QAC9B;QAEAS,SAAS9B;QACTyB,UAAU,CAAC,CAACO,WAAW,CAACA,QAAQE,MAAM;IAEtC,qEAAqE;IACrE,4EAA4E;IAC9E,GAAG;QAAC9B;QAAUQ;QAAUC;KAAS;IAEjC1B,UAAU;QACR,IAAI,CAACqC,UAAUpB,UAAU;YACvB;QACF;QAEA,MAAM+B,iBAAiB,CAACC;YACtBb,SAASa;YACTH;QACF;QACA,MAAMI,iBAAiB,CAACD;YACtB,MAAME,eAAeZ,IAAIG,OAAO;YAChC,MAAMU,iBAAiBpC,QAAQ0B,OAAO;YACtC,IAAIP,YAAYgB,gBAAgBC,gBAAgB;gBAC9CjB,SAASc,OAAO;oBACdI,SAAS7C,iBAAiB;wBAAE2C;wBAAcC;oBAAe;oBACzDD;oBACAC;gBACF;YACF;YAEAN;QACF;QAEA,MAAMQ,gBAAgBnD,cAAc,UAAUoD,QAAQ;QACtD,MAAMC,gBAAgBrD,cAAc,UAAUoD,QAAQ,MAAM;YAC1DE,SAAS;QACX;QACAH,cAAcI,GAAG,CAACV;QAClBQ,cAAcE,GAAG,CAACR;QAClB,OAAO;YACLI,cAAcK,MAAM,CAACX;YACrBQ,cAAcG,MAAM,CAACT;QACvB;IACF,GAAG;QAACb;QAAQpB;QAAUD;QAASoB;QAAUD;QAAUI;QAAKO;KAAY;IAEpE,MAAMc,YAA2D;QAC/D1C,SAAQ2C,SAAS;YACf3C,QAAQ2C;YACRf;QACF;QACA3B,YAAW0C,SAAS;YAClB1C,WAAW0C;YACXf;QACF;QACA1B,WAAUyC,SAAS;YACjBzC,UAAUyC;YACVf;QACF;QACAzB;YACEA;YACAiB,UAAU;QACZ;IACF;IAEA,OAAO;QACLC,KAAKC;QACL3B,OAAOI,WAAWH,YAAY;YAAE,GAAGD,KAAK;YAAE,GAAGC,SAAS;QAAC;QACvD8C;QACAd;QACAgB,mBAAmB;YACjB,GAAGF,SAAS;YACZ7C,SAASyB;QACX;IACF;AACF"}