@react-md/core 1.0.0-next.7 → 1.0.0-next.9

package/dist/movement/utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/movement/utils.ts"],"sourcesContent":["import type { KeyboardEvent } from \"react\";\nimport { loop } from \"../utils/loop.js\";\nimport type { FocusableIndexOptions, TabIndexBehavior } from \"./types.js\";\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport const isElementDisabled = (element: HTMLElement): boolean =>\n  element.getAttribute(\"disabled\") !== null ||\n  element.getAttribute(\"aria-disabled\") === \"true\";\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const isNotFocusable = (\n  element: HTMLElement | undefined,\n  includeDisabled: boolean\n): boolean => {\n  if (!element) {\n    return true;\n  }\n\n  if (includeDisabled) {\n    return false;\n  }\n\n  return isElementDisabled(element);\n};\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface VirtualFocusableIndexOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n  activeDescendantId: string;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport const getVirtualFocusDefaultIndex = (\n  options: VirtualFocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled, activeDescendantId } = options;\n  if (!focusables.length || (!activeDescendantId && includeDisabled)) {\n    return 0;\n  }\n\n  const activeIndex = focusables.findIndex((element) => {\n    if (activeDescendantId) {\n      return element.id === activeDescendantId;\n    }\n\n    return !isElementDisabled(element);\n  });\n  return Math.max(0, activeIndex);\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getFirstFocusableIndex = (\n  options: FocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled } = options;\n\n  if (!focusables.length) {\n    return -1;\n  }\n\n  let firstIndex = 0;\n  while (\n    firstIndex < focusables.length - 1 &&\n    isNotFocusable(focusables[firstIndex], includeDisabled)\n  ) {\n    firstIndex += 1;\n  }\n\n  if (isNotFocusable(focusables[firstIndex], includeDisabled)) {\n    return -1;\n  }\n\n  return firstIndex;\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getLastFocusableIndex = (\n  options: FocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled } = options;\n\n  if (!focusables.length) {\n    return -1;\n  }\n\n  let lastIndex = focusables.length - 1;\n  while (\n    lastIndex > 0 &&\n    isNotFocusable(focusables[lastIndex], includeDisabled)\n  ) {\n    lastIndex -= 1;\n  }\n\n  if (isNotFocusable(focusables[lastIndex], includeDisabled)) {\n    return -1;\n  }\n\n  return lastIndex;\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\ninterface NextFocusableIndexOptions extends FocusableIndexOptions {\n  loopable: boolean;\n  increment: boolean;\n  currentFocusIndex: number;\n}\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getNextFocusableIndex = (\n  options: NextFocusableIndexOptions\n): number => {\n  const {\n    loopable,\n    increment,\n    focusables,\n    includeDisabled,\n    currentFocusIndex,\n  } = options;\n  if (!focusables.length) {\n    return currentFocusIndex;\n  }\n\n  const min = getFirstFocusableIndex({ focusables, includeDisabled });\n  const max = getLastFocusableIndex({ focusables, includeDisabled });\n  let nextIndex = loop({\n    min,\n    max,\n    value: currentFocusIndex,\n    minmax: !loopable,\n    increment,\n  });\n  while (\n    isNotFocusable(focusables[nextIndex], includeDisabled) &&\n    (loopable || nextIndex !== (increment ? max : min))\n  ) {\n    nextIndex = loop({\n      min,\n      max,\n      value: nextIndex,\n      minmax: !loopable,\n      increment,\n    });\n  }\n\n  // Since the `min` and `max` values are \"safely\" set, I don't need to verify\n  // the nextIndex is still focusable\n  return nextIndex;\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport function getSearchText(\n  element: HTMLElement,\n  searchable: boolean\n): string {\n  if (!searchable) {\n    return \"\";\n  }\n\n  const cloned = element.cloneNode(true) as HTMLElement;\n  cloned\n    .querySelectorAll(\n      // Note: do not include DISPLAY_NONE_CLASS since it is presentational only\n      \".rmd-icon--font,[aria-hidden=true],[hidden],[role=presentation]\"\n    )\n    .forEach((element) => {\n      element.parentNode?.removeChild(element);\n    });\n\n  // Note: It would be good to use `cloned.innerText` (maybe?) at some point,\n  // but it returns `undefined` in jsdom. It also does cause a reflow, so maybe\n  // this is fine?\n  // https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent#differences_from_innertext\n  return (cloned.textContent || \"\")[0].toUpperCase();\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface RecalculateOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n  tabIndexBehavior: TabIndexBehavior | undefined;\n  activeDescendantId: string;\n}\n\n/**\n * This was added to help with specific widgets that cause focus index to change\n * between renders (i.e. expanding all tree items on the same level with `*`).\n * There might be a better way to handle this in the future.\n *\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function recalculateFocusIndex(options: RecalculateOptions): number {\n  const { focusables, includeDisabled, tabIndexBehavior, activeDescendantId } =\n    options;\n  if (tabIndexBehavior === \"virtual\") {\n    return getVirtualFocusDefaultIndex({\n      focusables,\n      includeDisabled,\n      activeDescendantId,\n    });\n  }\n\n  const { activeElement } = document;\n  return focusables.findIndex((element) => element === activeElement);\n}\n\n/**\n * Checks if a keyboard event can trigger a search through focusable elements\n * by:\n *\n * - checking if the key is a single letter that is not the space key\n * - checking that the alt, ctrl, and meta keys are not being held\n *\n * The shift key **is allowed** because holding shift means \"search from the\n * beginning\" instead of \"search from current location\".\n *\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function isSearchableEvent(event: KeyboardEvent): boolean {\n  const { key, altKey, ctrlKey, metaKey } = event;\n\n  return (\n    key.length === 1 &&\n    // can't search with space since it is generally a click event\n    key !== \" \" &&\n    !altKey &&\n    !ctrlKey &&\n    !metaKey\n  );\n}\n"],"names":["loop","isElementDisabled","element","getAttribute","isNotFocusable","includeDisabled","getVirtualFocusDefaultIndex","options","focusables","activeDescendantId","length","activeIndex","findIndex","id","Math","max","getFirstFocusableIndex","firstIndex","getLastFocusableIndex","lastIndex","getNextFocusableIndex","loopable","increment","currentFocusIndex","min","nextIndex","value","minmax","getSearchText","searchable","cloned","cloneNode","querySelectorAll","forEach","parentNode","removeChild","textContent","toUpperCase","recalculateFocusIndex","tabIndexBehavior","activeElement","document","isSearchableEvent","event","key","altKey","ctrlKey","metaKey"],"mappings":"AACA,SAASA,IAAI,QAAQ,mBAAmB;AAGxC;;;CAGC,GACD,OAAO,MAAMC,oBAAoB,CAACC,UAChCA,QAAQC,YAAY,CAAC,gBAAgB,QACrCD,QAAQC,YAAY,CAAC,qBAAqB,OAAO;AAEnD;;;CAGC,GACD,OAAO,MAAMC,iBAAiB,CAC5BF,SACAG;IAEA,IAAI,CAACH,SAAS;QACZ,OAAO;IACT;IAEA,IAAIG,iBAAiB;QACnB,OAAO;IACT;IAEA,OAAOJ,kBAAkBC;AAC3B,EAAE;AAYF;;;CAGC,GACD,OAAO,MAAMI,8BAA8B,CACzCC;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAEI,kBAAkB,EAAE,GAAGF;IAC5D,IAAI,CAACC,WAAWE,MAAM,IAAK,CAACD,sBAAsBJ,iBAAkB;QAClE,OAAO;IACT;IAEA,MAAMM,cAAcH,WAAWI,SAAS,CAAC,CAACV;QACxC,IAAIO,oBAAoB;YACtB,OAAOP,QAAQW,EAAE,KAAKJ;QACxB;QAEA,OAAO,CAACR,kBAAkBC;IAC5B;IACA,OAAOY,KAAKC,GAAG,CAAC,GAAGJ;AACrB,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMK,yBAAyB,CACpCT;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAE,GAAGE;IAExC,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAO,CAAC;IACV;IAEA,IAAIO,aAAa;IACjB,MACEA,aAAaT,WAAWE,MAAM,GAAG,KACjCN,eAAeI,UAAU,CAACS,WAAW,EAAEZ,iBACvC;QACAY,cAAc;IAChB;IAEA,IAAIb,eAAeI,UAAU,CAACS,WAAW,EAAEZ,kBAAkB;QAC3D,OAAO,CAAC;IACV;IAEA,OAAOY;AACT,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMC,wBAAwB,CACnCX;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAE,GAAGE;IAExC,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAO,CAAC;IACV;IAEA,IAAIS,YAAYX,WAAWE,MAAM,GAAG;IACpC,MACES,YAAY,KACZf,eAAeI,UAAU,CAACW,UAAU,EAAEd,iBACtC;QACAc,aAAa;IACf;IAEA,IAAIf,eAAeI,UAAU,CAACW,UAAU,EAAEd,kBAAkB;QAC1D,OAAO,CAAC;IACV;IAEA,OAAOc;AACT,EAAE;AAYF;;;CAGC,GACD,OAAO,MAAMC,wBAAwB,CACnCb;IAEA,MAAM,EACJc,QAAQ,EACRC,SAAS,EACTd,UAAU,EACVH,eAAe,EACfkB,iBAAiB,EAClB,GAAGhB;IACJ,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAOa;IACT;IAEA,MAAMC,MAAMR,uBAAuB;QAAER;QAAYH;IAAgB;IACjE,MAAMU,MAAMG,sBAAsB;QAAEV;QAAYH;IAAgB;IAChE,IAAIoB,YAAYzB,KAAK;QACnBwB;QACAT;QACAW,OAAOH;QACPI,QAAQ,CAACN;QACTC;IACF;IACA,MACElB,eAAeI,UAAU,CAACiB,UAAU,EAAEpB,oBACrCgB,CAAAA,YAAYI,cAAeH,CAAAA,YAAYP,MAAMS,GAAE,CAAC,EACjD;QACAC,YAAYzB,KAAK;YACfwB;YACAT;YACAW,OAAOD;YACPE,QAAQ,CAACN;YACTC;QACF;IACF;IAEA,4EAA4E;IAC5E,mCAAmC;IACnC,OAAOG;AACT,EAAE;AAEF;;;CAGC,GACD,OAAO,SAASG,cACd1B,OAAoB,EACpB2B,UAAmB;IAEnB,IAAI,CAACA,YAAY;QACf,OAAO;IACT;IAEA,MAAMC,SAAS5B,QAAQ6B,SAAS,CAAC;IACjCD,OACGE,gBAAgB,CACf,0EAA0E;IAC1E,mEAEDC,OAAO,CAAC,CAAC/B;QACRA,QAAQgC,UAAU,EAAEC,YAAYjC;IAClC;IAEF,2EAA2E;IAC3E,6EAA6E;IAC7E,gBAAgB;IAChB,+FAA+F;IAC/F,OAAO,AAAC4B,CAAAA,OAAOM,WAAW,IAAI,EAAC,CAAE,CAAC,EAAE,CAACC,WAAW;AAClD;AAaA;;;;;;;CAOC,GACD,OAAO,SAASC,sBAAsB/B,OAA2B;IAC/D,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAEkC,gBAAgB,EAAE9B,kBAAkB,EAAE,GACzEF;IACF,IAAIgC,qBAAqB,WAAW;QAClC,OAAOjC,4BAA4B;YACjCE;YACAH;YACAI;QACF;IACF;IAEA,MAAM,EAAE+B,aAAa,EAAE,GAAGC;IAC1B,OAAOjC,WAAWI,SAAS,CAAC,CAACV,UAAYA,YAAYsC;AACvD;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,SAASE,kBAAkBC,KAAoB;IACpD,MAAM,EAAEC,GAAG,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAE,GAAGJ;IAE1C,OACEC,IAAIlC,MAAM,KAAK,KACf,8DAA8D;IAC9DkC,QAAQ,OACR,CAACC,UACD,CAACC,WACD,CAACC;AAEL"}
+{"version":3,"sources":["../../src/movement/utils.ts"],"sourcesContent":["import { type KeyboardEvent } from \"react\";\nimport { loop } from \"../utils/loop.js\";\nimport { type FocusableIndexOptions, type TabIndexBehavior } from \"./types.js\";\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport const isElementDisabled = (element: HTMLElement): boolean =>\n  element.getAttribute(\"disabled\") !== null ||\n  element.getAttribute(\"aria-disabled\") === \"true\";\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const isNotFocusable = (\n  element: HTMLElement | undefined,\n  includeDisabled: boolean\n): boolean => {\n  if (!element) {\n    return true;\n  }\n\n  if (includeDisabled) {\n    return false;\n  }\n\n  return isElementDisabled(element);\n};\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface VirtualFocusableIndexOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n  activeDescendantId: string;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport const getVirtualFocusDefaultIndex = (\n  options: VirtualFocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled, activeDescendantId } = options;\n  if (!focusables.length || (!activeDescendantId && includeDisabled)) {\n    return 0;\n  }\n\n  const activeIndex = focusables.findIndex((element) => {\n    if (activeDescendantId) {\n      return element.id === activeDescendantId;\n    }\n\n    return !isElementDisabled(element);\n  });\n  return Math.max(0, activeIndex);\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getFirstFocusableIndex = (\n  options: FocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled } = options;\n\n  if (!focusables.length) {\n    return -1;\n  }\n\n  let firstIndex = 0;\n  while (\n    firstIndex < focusables.length - 1 &&\n    isNotFocusable(focusables[firstIndex], includeDisabled)\n  ) {\n    firstIndex += 1;\n  }\n\n  if (isNotFocusable(focusables[firstIndex], includeDisabled)) {\n    return -1;\n  }\n\n  return firstIndex;\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getLastFocusableIndex = (\n  options: FocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled } = options;\n\n  if (!focusables.length) {\n    return -1;\n  }\n\n  let lastIndex = focusables.length - 1;\n  while (\n    lastIndex > 0 &&\n    isNotFocusable(focusables[lastIndex], includeDisabled)\n  ) {\n    lastIndex -= 1;\n  }\n\n  if (isNotFocusable(focusables[lastIndex], includeDisabled)) {\n    return -1;\n  }\n\n  return lastIndex;\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\ninterface NextFocusableIndexOptions extends FocusableIndexOptions {\n  loopable: boolean;\n  increment: boolean;\n  currentFocusIndex: number;\n}\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getNextFocusableIndex = (\n  options: NextFocusableIndexOptions\n): number => {\n  const {\n    loopable,\n    increment,\n    focusables,\n    includeDisabled,\n    currentFocusIndex,\n  } = options;\n  if (!focusables.length) {\n    return currentFocusIndex;\n  }\n\n  const min = getFirstFocusableIndex({ focusables, includeDisabled });\n  const max = getLastFocusableIndex({ focusables, includeDisabled });\n  let nextIndex = loop({\n    min,\n    max,\n    value: currentFocusIndex,\n    minmax: !loopable,\n    increment,\n  });\n  while (\n    isNotFocusable(focusables[nextIndex], includeDisabled) &&\n    (loopable || nextIndex !== (increment ? max : min))\n  ) {\n    nextIndex = loop({\n      min,\n      max,\n      value: nextIndex,\n      minmax: !loopable,\n      increment,\n    });\n  }\n\n  // Since the `min` and `max` values are \"safely\" set, I don't need to verify\n  // the nextIndex is still focusable\n  return nextIndex;\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport function getSearchText(\n  element: HTMLElement,\n  searchable: boolean\n): string {\n  if (!searchable) {\n    return \"\";\n  }\n\n  const cloned = element.cloneNode(true) as HTMLElement;\n  cloned\n    .querySelectorAll(\n      // Note: do not include DISPLAY_NONE_CLASS since it is presentational only\n      \".rmd-icon--font,[aria-hidden=true],[hidden],[role=presentation]\"\n    )\n    .forEach((element) => {\n      element.parentNode?.removeChild(element);\n    });\n\n  // Note: It would be good to use `cloned.innerText` (maybe?) at some point,\n  // but it returns `undefined` in jsdom. It also does cause a reflow, so maybe\n  // this is fine?\n  // https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent#differences_from_innertext\n  return (cloned.textContent || \"\")[0].toUpperCase();\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface RecalculateOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n  tabIndexBehavior: TabIndexBehavior | undefined;\n  activeDescendantId: string;\n}\n\n/**\n * This was added to help with specific widgets that cause focus index to change\n * between renders (i.e. expanding all tree items on the same level with `*`).\n * There might be a better way to handle this in the future.\n *\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function recalculateFocusIndex(options: RecalculateOptions): number {\n  const { focusables, includeDisabled, tabIndexBehavior, activeDescendantId } =\n    options;\n  if (tabIndexBehavior === \"virtual\") {\n    return getVirtualFocusDefaultIndex({\n      focusables,\n      includeDisabled,\n      activeDescendantId,\n    });\n  }\n\n  const { activeElement } = document;\n  return focusables.findIndex((element) => element === activeElement);\n}\n\n/**\n * Checks if a keyboard event can trigger a search through focusable elements\n * by:\n *\n * - checking if the key is a single letter that is not the space key\n * - checking that the alt, ctrl, and meta keys are not being held\n *\n * The shift key **is allowed** because holding shift means \"search from the\n * beginning\" instead of \"search from current location\".\n *\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function isSearchableEvent(event: KeyboardEvent): boolean {\n  const { key, altKey, ctrlKey, metaKey } = event;\n\n  return (\n    key.length === 1 &&\n    // can't search with space since it is generally a click event\n    key !== \" \" &&\n    !altKey &&\n    !ctrlKey &&\n    !metaKey\n  );\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function isTypeEvent(event: KeyboardEvent): boolean {\n  return (\n    isSearchableEvent(event) || [\"Backspace\", \"Delete\", \" \"].includes(event.key)\n  );\n}\n"],"names":["loop","isElementDisabled","element","getAttribute","isNotFocusable","includeDisabled","getVirtualFocusDefaultIndex","options","focusables","activeDescendantId","length","activeIndex","findIndex","id","Math","max","getFirstFocusableIndex","firstIndex","getLastFocusableIndex","lastIndex","getNextFocusableIndex","loopable","increment","currentFocusIndex","min","nextIndex","value","minmax","getSearchText","searchable","cloned","cloneNode","querySelectorAll","forEach","parentNode","removeChild","textContent","toUpperCase","recalculateFocusIndex","tabIndexBehavior","activeElement","document","isSearchableEvent","event","key","altKey","ctrlKey","metaKey","isTypeEvent","includes"],"mappings":"AACA,SAASA,IAAI,QAAQ,mBAAmB;AAGxC;;;CAGC,GACD,OAAO,MAAMC,oBAAoB,CAACC,UAChCA,QAAQC,YAAY,CAAC,gBAAgB,QACrCD,QAAQC,YAAY,CAAC,qBAAqB,OAAO;AAEnD;;;CAGC,GACD,OAAO,MAAMC,iBAAiB,CAC5BF,SACAG;IAEA,IAAI,CAACH,SAAS;QACZ,OAAO;IACT;IAEA,IAAIG,iBAAiB;QACnB,OAAO;IACT;IAEA,OAAOJ,kBAAkBC;AAC3B,EAAE;AAYF;;;CAGC,GACD,OAAO,MAAMI,8BAA8B,CACzCC;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAEI,kBAAkB,EAAE,GAAGF;IAC5D,IAAI,CAACC,WAAWE,MAAM,IAAK,CAACD,sBAAsBJ,iBAAkB;QAClE,OAAO;IACT;IAEA,MAAMM,cAAcH,WAAWI,SAAS,CAAC,CAACV;QACxC,IAAIO,oBAAoB;YACtB,OAAOP,QAAQW,EAAE,KAAKJ;QACxB;QAEA,OAAO,CAACR,kBAAkBC;IAC5B;IACA,OAAOY,KAAKC,GAAG,CAAC,GAAGJ;AACrB,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMK,yBAAyB,CACpCT;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAE,GAAGE;IAExC,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAO,CAAC;IACV;IAEA,IAAIO,aAAa;IACjB,MACEA,aAAaT,WAAWE,MAAM,GAAG,KACjCN,eAAeI,UAAU,CAACS,WAAW,EAAEZ,iBACvC;QACAY,cAAc;IAChB;IAEA,IAAIb,eAAeI,UAAU,CAACS,WAAW,EAAEZ,kBAAkB;QAC3D,OAAO,CAAC;IACV;IAEA,OAAOY;AACT,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMC,wBAAwB,CACnCX;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAE,GAAGE;IAExC,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAO,CAAC;IACV;IAEA,IAAIS,YAAYX,WAAWE,MAAM,GAAG;IACpC,MACES,YAAY,KACZf,eAAeI,UAAU,CAACW,UAAU,EAAEd,iBACtC;QACAc,aAAa;IACf;IAEA,IAAIf,eAAeI,UAAU,CAACW,UAAU,EAAEd,kBAAkB;QAC1D,OAAO,CAAC;IACV;IAEA,OAAOc;AACT,EAAE;AAYF;;;CAGC,GACD,OAAO,MAAMC,wBAAwB,CACnCb;IAEA,MAAM,EACJc,QAAQ,EACRC,SAAS,EACTd,UAAU,EACVH,eAAe,EACfkB,iBAAiB,EAClB,GAAGhB;IACJ,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAOa;IACT;IAEA,MAAMC,MAAMR,uBAAuB;QAAER;QAAYH;IAAgB;IACjE,MAAMU,MAAMG,sBAAsB;QAAEV;QAAYH;IAAgB;IAChE,IAAIoB,YAAYzB,KAAK;QACnBwB;QACAT;QACAW,OAAOH;QACPI,QAAQ,CAACN;QACTC;IACF;IACA,MACElB,eAAeI,UAAU,CAACiB,UAAU,EAAEpB,oBACrCgB,CAAAA,YAAYI,cAAeH,CAAAA,YAAYP,MAAMS,GAAE,CAAC,EACjD;QACAC,YAAYzB,KAAK;YACfwB;YACAT;YACAW,OAAOD;YACPE,QAAQ,CAACN;YACTC;QACF;IACF;IAEA,4EAA4E;IAC5E,mCAAmC;IACnC,OAAOG;AACT,EAAE;AAEF;;;CAGC,GACD,OAAO,SAASG,cACd1B,OAAoB,EACpB2B,UAAmB;IAEnB,IAAI,CAACA,YAAY;QACf,OAAO;IACT;IAEA,MAAMC,SAAS5B,QAAQ6B,SAAS,CAAC;IACjCD,OACGE,gBAAgB,CACf,0EAA0E;IAC1E,mEAEDC,OAAO,CAAC,CAAC/B;QACRA,QAAQgC,UAAU,EAAEC,YAAYjC;IAClC;IAEF,2EAA2E;IAC3E,6EAA6E;IAC7E,gBAAgB;IAChB,+FAA+F;IAC/F,OAAO,AAAC4B,CAAAA,OAAOM,WAAW,IAAI,EAAC,CAAE,CAAC,EAAE,CAACC,WAAW;AAClD;AAaA;;;;;;;CAOC,GACD,OAAO,SAASC,sBAAsB/B,OAA2B;IAC/D,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAEkC,gBAAgB,EAAE9B,kBAAkB,EAAE,GACzEF;IACF,IAAIgC,qBAAqB,WAAW;QAClC,OAAOjC,4BAA4B;YACjCE;YACAH;YACAI;QACF;IACF;IAEA,MAAM,EAAE+B,aAAa,EAAE,GAAGC;IAC1B,OAAOjC,WAAWI,SAAS,CAAC,CAACV,UAAYA,YAAYsC;AACvD;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,SAASE,kBAAkBC,KAAoB;IACpD,MAAM,EAAEC,GAAG,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAE,GAAGJ;IAE1C,OACEC,IAAIlC,MAAM,KAAK,KACf,8DAA8D;IAC9DkC,QAAQ,OACR,CAACC,UACD,CAACC,WACD,CAACC;AAEL;AAEA;;;CAGC,GACD,OAAO,SAASC,YAAYL,KAAoB;IAC9C,OACED,kBAAkBC,UAAU;QAAC;QAAa;QAAU;KAAI,CAACM,QAAQ,CAACN,MAAMC,GAAG;AAE/E"}

package/dist/positioning/useFixedPositioning.js

@@ -199,14 +199,6 @@ const noop = ()=>undefined;
         ref,
         updateStyle
     ]);
-    useEffect(()=>{
-        if (!ref.current || !ref.current.hidden) {
-            updateStyle();
-        }
-    }, [
-        ref,
-        updateStyle
-    ]);
     const callbacks = {
         onEnter (appearing) {
             onEnter(appearing);

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\";\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  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;IAE1D,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"}

package/dist/searching/caseInsensitive.d.ts

@@ -0,0 +1,150 @@
+import { type TextExtractor } from "../types.js";
+import { type BaseSearchOptions } from "./types.js";
+/**
+ * @remarks \@since 6.0.0
+ */
+export interface CaseInsensitiveStartsWithOptions {
+    /**
+     * Set this to `true` if the item in the list must start with the query
+     * instead of only including it.
+     *
+     * @example
+     * Search Example
+     * ```ts
+     * const fruits = ["Banana", "Grape", "Apple", "Orange"];
+     *
+     * caseInsensitiveSearch({
+     *   list: fruits,
+     *   query: "ap",
+     *   type: "search",
+     * });
+     * // "Grape"
+     *
+     * caseInsensitiveSearch({
+     *   list: fruits,
+     *   query: "ap",
+     *   type: "search",
+     *   startsWith: true,
+     * });
+     * // "Apple"
+     * ```
+     *
+     * @example
+     * Filter Example
+     * ```ts
+     * const fruits = ["Apple", "Banana", "Grape", "Orange"];
+     *
+     * caseInsensitiveSearch({
+     *   list: fruits,
+     *   query: "ap",
+     * });
+     * // ["Apple", "Grape"]
+     *
+     * caseInsensitiveSearch({
+     *   list: fruits,
+     *   query: "ap",
+     *   startsWith: true,
+     * });
+     * // ["Apple"]
+     * ```
+     *
+     * @defaultValue `false`
+     */
+    startsWith?: boolean;
+}
+/**
+ * @remarks \@since 6.0.0
+ */
+export interface IsCaseInsensitiveMatchOptions extends CaseInsensitiveStartsWithOptions {
+    /**
+     * The current search query.
+     */
+    query: string;
+    /**
+     * The current value to compare against.
+     */
+    value: string;
+}
+/**
+ * @remarks \@since 6.0.0
+ */
+export declare function isCaseInsensitiveMatch(options: IsCaseInsensitiveMatchOptions): boolean;
+/**
+ * @remarks \@since 6.0.0
+ */
+export interface CaseInsensitiveOptions<T> extends BaseSearchOptions<T>, CaseInsensitiveStartsWithOptions {
+}
+/**
+ * @example
+ * String list
+ * ```ts
+ * const fruits = ["Apple", "Banana", "Grape", "Orange"];
+ *
+ * caseInsensitiveSearch({
+ *   list: fruits,
+ *   query: "ap",
+ * });
+ * // ["Apple", "Grape"]
+ *
+ * caseInsensitiveSearch({
+ *   list: fruits,
+ *   query: "ap",
+ *   startsWith: true,
+ * });
+ * // ["Apple"]
+ *
+ * caseInsensitiveSearch({
+ *   list: fruits,
+ *   query: "  a p",
+ * });
+ * // []
+ *
+ * caseInsensitiveSearch({
+ *   list: fruits,
+ *   query: "  a p",
+ *   whitespace: "ignore",
+ * });
+ * // ["Apple", "Grape"]
+ *
+ * caseInsensitiveSearch({
+ *   list: fruits,
+ *   query: "  ap  ",
+ *   whitespace: "trim",
+ * });
+ * // ["Apple", "Grape"]
+ * ```
+ *
+ * @example
+ * Objects
+ * ```ts
+ * const fruits = [
+ *   { name: "Apple", value: 0 },
+ *   { name: "Banana", value: 1 },
+ *   { name: "Grape", value: 2 },
+ *   { name: "Orange", value: 3 },
+ * ];
+ *
+ * caseInsensitiveSearch({
+ *   list: fruits,
+ *   query: "ap",
+ *   extractor: (item) => item.name,
+ * });
+ * // [{ name: "Apple", value: 0 }, { name: "Grape", value: 2 }]
+ * ```
+ *
+ * @remarks \@since 6.0.0
+ */
+export declare function caseInsensitiveSearch<T extends string>(options: Omit<CaseInsensitiveOptions<T>, "extractor"> & {
+    type?: "filter";
+}): readonly T[];
+export declare function caseInsensitiveSearch<T extends string>(options: Omit<CaseInsensitiveOptions<T>, "extractor"> & {
+    type: "search";
+}): T | undefined;
+export declare function caseInsensitiveSearch<T>(options: CaseInsensitiveOptions<T> & {
+    extractor: TextExtractor<T>;
+    type?: "filter";
+}): readonly T[];
+export declare function caseInsensitiveSearch<T>(options: CaseInsensitiveOptions<T> & {
+    extractor: TextExtractor<T>;
+    type: "search";
+}): T | undefined;

package/dist/searching/caseInsensitive.js

@@ -0,0 +1,30 @@
+import { defaultExtractor, search } from "./utils.js";
+/**
+ * @remarks \@since 6.0.0
+ */ export function isCaseInsensitiveMatch(options) {
+    const { query, value, startsWith } = options;
+    const matchIndex = value.indexOf(query);
+    if (startsWith) {
+        return matchIndex === 0;
+    }
+    return matchIndex !== -1;
+}
+export function caseInsensitiveSearch(options) {
+    const { list, type = "filter", query, extractor = defaultExtractor("caseInsensitiveSearch"), startsWith, whitespace } = options;
+    return search({
+        type,
+        list,
+        query,
+        extractor,
+        whitespace,
+        filter (q, value) {
+            return isCaseInsensitiveMatch({
+                query: q,
+                value,
+                startsWith
+            });
+        }
+    });
+}
+
+//# sourceMappingURL=caseInsensitive.js.map

package/dist/searching/caseInsensitive.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/searching/caseInsensitive.ts"],"sourcesContent":["import { type TextExtractor } from \"../types.js\";\nimport { type BaseSearchOptions } from \"./types.js\";\nimport { defaultExtractor, search } from \"./utils.js\";\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface CaseInsensitiveStartsWithOptions {\n  /**\n   * Set this to `true` if the item in the list must start with the query\n   * instead of only including it.\n   *\n   * @example\n   * Search Example\n   * ```ts\n   * const fruits = [\"Banana\", \"Grape\", \"Apple\", \"Orange\"];\n   *\n   * caseInsensitiveSearch({\n   *   list: fruits,\n   *   query: \"ap\",\n   *   type: \"search\",\n   * });\n   * // \"Grape\"\n   *\n   * caseInsensitiveSearch({\n   *   list: fruits,\n   *   query: \"ap\",\n   *   type: \"search\",\n   *   startsWith: true,\n   * });\n   * // \"Apple\"\n   * ```\n   *\n   * @example\n   * Filter Example\n   * ```ts\n   * const fruits = [\"Apple\", \"Banana\", \"Grape\", \"Orange\"];\n   *\n   * caseInsensitiveSearch({\n   *   list: fruits,\n   *   query: \"ap\",\n   * });\n   * // [\"Apple\", \"Grape\"]\n   *\n   * caseInsensitiveSearch({\n   *   list: fruits,\n   *   query: \"ap\",\n   *   startsWith: true,\n   * });\n   * // [\"Apple\"]\n   * ```\n   *\n   * @defaultValue `false`\n   */\n  startsWith?: boolean;\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface IsCaseInsensitiveMatchOptions\n  extends CaseInsensitiveStartsWithOptions {\n  /**\n   * The current search query.\n   */\n  query: string;\n\n  /**\n   * The current value to compare against.\n   */\n  value: string;\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport function isCaseInsensitiveMatch(\n  options: IsCaseInsensitiveMatchOptions\n): boolean {\n  const { query, value, startsWith } = options;\n  const matchIndex = value.indexOf(query);\n  if (startsWith) {\n    return matchIndex === 0;\n  }\n\n  return matchIndex !== -1;\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface CaseInsensitiveOptions<T>\n  extends BaseSearchOptions<T>,\n    CaseInsensitiveStartsWithOptions {}\n\n/**\n * @example\n * String list\n * ```ts\n * const fruits = [\"Apple\", \"Banana\", \"Grape\", \"Orange\"];\n *\n * caseInsensitiveSearch({\n *   list: fruits,\n *   query: \"ap\",\n * });\n * // [\"Apple\", \"Grape\"]\n *\n * caseInsensitiveSearch({\n *   list: fruits,\n *   query: \"ap\",\n *   startsWith: true,\n * });\n * // [\"Apple\"]\n *\n * caseInsensitiveSearch({\n *   list: fruits,\n *   query: \"  a p\",\n * });\n * // []\n *\n * caseInsensitiveSearch({\n *   list: fruits,\n *   query: \"  a p\",\n *   whitespace: \"ignore\",\n * });\n * // [\"Apple\", \"Grape\"]\n *\n * caseInsensitiveSearch({\n *   list: fruits,\n *   query: \"  ap  \",\n *   whitespace: \"trim\",\n * });\n * // [\"Apple\", \"Grape\"]\n * ```\n *\n * @example\n * Objects\n * ```ts\n * const fruits = [\n *   { name: \"Apple\", value: 0 },\n *   { name: \"Banana\", value: 1 },\n *   { name: \"Grape\", value: 2 },\n *   { name: \"Orange\", value: 3 },\n * ];\n *\n * caseInsensitiveSearch({\n *   list: fruits,\n *   query: \"ap\",\n *   extractor: (item) => item.name,\n * });\n * // [{ name: \"Apple\", value: 0 }, { name: \"Grape\", value: 2 }]\n * ```\n *\n * @remarks \\@since 6.0.0\n */\nexport function caseInsensitiveSearch<T extends string>(\n  options: Omit<CaseInsensitiveOptions<T>, \"extractor\"> & { type?: \"filter\" }\n): readonly T[];\nexport function caseInsensitiveSearch<T extends string>(\n  options: Omit<CaseInsensitiveOptions<T>, \"extractor\"> & { type: \"search\" }\n): T | undefined;\nexport function caseInsensitiveSearch<T>(\n  options: CaseInsensitiveOptions<T> & {\n    extractor: TextExtractor<T>;\n    type?: \"filter\";\n  }\n): readonly T[];\nexport function caseInsensitiveSearch<T>(\n  options: CaseInsensitiveOptions<T> & {\n    extractor: TextExtractor<T>;\n    type: \"search\";\n  }\n): T | undefined;\nexport function caseInsensitiveSearch<T>(\n  options: CaseInsensitiveOptions<T>\n): readonly T[] | T | undefined {\n  const {\n    list,\n    type = \"filter\",\n    query,\n    extractor = defaultExtractor(\"caseInsensitiveSearch\"),\n    startsWith,\n    whitespace,\n  } = options;\n\n  return search({\n    type,\n    list,\n    query,\n    extractor,\n    whitespace,\n    filter(q, value) {\n      return isCaseInsensitiveMatch({\n        query: q,\n        value,\n        startsWith,\n      });\n    },\n  });\n}\n"],"names":["defaultExtractor","search","isCaseInsensitiveMatch","options","query","value","startsWith","matchIndex","indexOf","caseInsensitiveSearch","list","type","extractor","whitespace","filter","q"],"mappings":"AAEA,SAASA,gBAAgB,EAAEC,MAAM,QAAQ,aAAa;AAuEtD;;CAEC,GACD,OAAO,SAASC,uBACdC,OAAsC;IAEtC,MAAM,EAAEC,KAAK,EAAEC,KAAK,EAAEC,UAAU,EAAE,GAAGH;IACrC,MAAMI,aAAaF,MAAMG,OAAO,CAACJ;IACjC,IAAIE,YAAY;QACd,OAAOC,eAAe;IACxB;IAEA,OAAOA,eAAe,CAAC;AACzB;AAuFA,OAAO,SAASE,sBACdN,OAAkC;IAElC,MAAM,EACJO,IAAI,EACJC,OAAO,QAAQ,EACfP,KAAK,EACLQ,YAAYZ,iBAAiB,wBAAwB,EACrDM,UAAU,EACVO,UAAU,EACX,GAAGV;IAEJ,OAAOF,OAAO;QACZU;QACAD;QACAN;QACAQ;QACAC;QACAC,QAAOC,CAAC,EAAEV,KAAK;YACb,OAAOH,uBAAuB;gBAC5BE,OAAOW;gBACPV;gBACAC;YACF;QACF;IACF;AACF"}

package/dist/searching/fuzzy.d.ts

@@ -0,0 +1,128 @@
+import { type TextExtractor } from "../types.js";
+import { type BaseSearchOptions } from "./types.js";
+/**
+ * @example
+ * ```tsx
+ * import { createFuzzyRegExp, toSearchQuery } from "@react-md/core":
+ * import { useDeferredValue, useMemo, useState, type ReactElement } from "react";
+ *
+ * function Example(): ReactElement {
+ *   const [value, setValue] = useState("");
+ *   const deferredValue = useDeferredValue(value)
+ *
+ *   const match = useMemo(() => {
+ *     const query = toSearchQuery(deferredValue);
+ *     if (!query) {
+ *       return;
+ *     }
+ *
+ *     const fuzzyRegExp = createFuzzyRegExp(query);
+ *     return options.find(option => fuzzyRegExp.test(option.label)):
+ *   }, [options])
+ *
+ *   if (match) {
+ *     // do something
+ *   }
+ * }
+ *
+ * ```
+ *
+ * @remarks \@since 6.0.0
+ * @see {@link fuzzySearch}
+ */
+export declare function createFuzzyRegExp(query: string): RegExp;
+/**
+ * @remarks \@since 6.0.0
+ */
+export type FuzzySearchOptions<T> = BaseSearchOptions<T>;
+/**
+ * Filters a list by making sure that all the letters appear in order ignoring
+ * case, punctuation, whitespace, and special characters. This is kind of the
+ * same filtering that appears in text editors.
+ *
+ * @example
+ * Simple Example
+ * ```ts
+ * const list = [
+ *   "at",
+ *   "charAt",
+ *   "charCodeAt",
+ *   "codePointAt",
+ *   "concat",
+ *   "constructor",
+ *   "endsWith",
+ *   "includes",
+ *   "indexOf",
+ *   "lastIndexOf",
+ *   "length",
+ *   "localeCompare",
+ *   "match",
+ *   "matchAll",
+ *   "normalize",
+ *   "padEnd",
+ *   "padStart",
+ *   "repeat",
+ *   "replace",
+ *   "replaceAll",
+ *   "search",
+ *   "slice",
+ *   "split",
+ *   "startsWith",
+ *   "substring",
+ *   "toLocaleLowerCase",
+ *   "toLocaleUpperCase",
+ *   "toLowerCase",
+ *   "toString",
+ *   "toUpperCase",
+ *   "trim",
+ *   "trimEnd",
+ *   "trimStart",
+ *   "valueOf",
+ * ];
+ *
+ * fuzzySearch({
+ *   list,
+ *   query: "la",
+ * });
+ * // [
+ * //   "lastIndexOf",
+ * //    ^^
+ * //   "localeCompare",
+ * //    ^  ^
+ * //   "replace",
+ * //       ^^
+ * //   "replaceAll",
+ * //       ^^
+ * //   "toLocaleLowerCase",
+ * //      ^  ^
+ * //   "toLocaleUpperCase",
+ * //      ^  ^
+ * //   "toLowerCase",
+ * //      ^     ^
+ * // ]
+ *
+ * fuzzySearch({
+ *   list,
+ *   query: "ad",
+ *   type: "search",
+ * });
+ * // "charCodeAt"
+ *  //    ^   ^
+ * ```
+ *
+ * @remarks \@since 6.0.0
+ */
+export declare function fuzzySearch<T extends string>(options: Omit<FuzzySearchOptions<T>, "extractor"> & {
+    type?: "filter";
+}): readonly T[];
+export declare function fuzzySearch<T extends string>(options: Omit<FuzzySearchOptions<T>, "extractor"> & {
+    type?: "search";
+}): T | undefined;
+export declare function fuzzySearch<T>(option: FuzzySearchOptions<T> & {
+    extractor: TextExtractor<T>;
+    type?: "filter";
+}): readonly T[];
+export declare function fuzzySearch<T>(option: FuzzySearchOptions<T> & {
+    extractor: TextExtractor<T>;
+    type?: "search";
+}): T | undefined;

package/dist/searching/fuzzy.js

@@ -0,0 +1,54 @@
+import { defaultExtractor, search } from "./utils.js";
+/**
+ * @example
+ * ```tsx
+ * import { createFuzzyRegExp, toSearchQuery } from "@react-md/core":
+ * import { useDeferredValue, useMemo, useState, type ReactElement } from "react";
+ *
+ * function Example(): ReactElement {
+ *   const [value, setValue] = useState("");
+ *   const deferredValue = useDeferredValue(value)
+ *
+ *   const match = useMemo(() => {
+ *     const query = toSearchQuery(deferredValue);
+ *     if (!query) {
+ *       return;
+ *     }
+ *
+ *     const fuzzyRegExp = createFuzzyRegExp(query);
+ *     return options.find(option => fuzzyRegExp.test(option.label)):
+ *   }, [options])
+ *
+ *   if (match) {
+ *     // do something
+ *   }
+ * }
+ *
+ * ```
+ *
+ * @remarks \@since 6.0.0
+ * @see {@link fuzzySearch}
+ */ export function createFuzzyRegExp(query) {
+    return new RegExp(query.split("").join("\\w*").replace(/(\(|\||\)|\\(?!w\*)|\[|\|-|\.|\^|\+|\$|\?|^(?!w)\*)/g, "\\$1")// Couldn't get the matching of two '*' working, so replace them here..
+    .replace(/\*\*/g, "*\\*"), "i");
+}
+export function fuzzySearch(options) {
+    const { list, type = "filter", query, extractor = defaultExtractor("fuzzySearch"), whitespace } = options;
+    // lazy initialize the RegExp since the base `filter` function will modify the
+    // query and never call the filter function if:
+    // - there is no query
+    // - the list is empty
+    let regexp;
+    return search({
+        type,
+        list,
+        query,
+        extractor,
+        whitespace,
+        filter (query, value) {
+            return value.length > 0 && (regexp ??= createFuzzyRegExp(query)).test(value);
+        }
+    });
+}
+
+//# sourceMappingURL=fuzzy.js.map

package/dist/searching/fuzzy.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/searching/fuzzy.ts"],"sourcesContent":["import { type TextExtractor } from \"../types.js\";\nimport { type BaseSearchOptions } from \"./types.js\";\nimport { defaultExtractor, search } from \"./utils.js\";\n\n/**\n * @example\n * ```tsx\n * import { createFuzzyRegExp, toSearchQuery } from \"@react-md/core\":\n * import { useDeferredValue, useMemo, useState, type ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const [value, setValue] = useState(\"\");\n *   const deferredValue = useDeferredValue(value)\n *\n *   const match = useMemo(() => {\n *     const query = toSearchQuery(deferredValue);\n *     if (!query) {\n *       return;\n *     }\n *\n *     const fuzzyRegExp = createFuzzyRegExp(query);\n *     return options.find(option => fuzzyRegExp.test(option.label)):\n *   }, [options])\n *\n *   if (match) {\n *     // do something\n *   }\n * }\n *\n * ```\n *\n * @remarks \\@since 6.0.0\n * @see {@link fuzzySearch}\n */\nexport function createFuzzyRegExp(query: string): RegExp {\n  return new RegExp(\n    query\n      .split(\"\")\n      .join(\"\\\\w*\")\n      .replace(/(\\(|\\||\\)|\\\\(?!w\\*)|\\[|\\|-|\\.|\\^|\\+|\\$|\\?|^(?!w)\\*)/g, \"\\\\$1\")\n      // Couldn't get the matching of two '*' working, so replace them here..\n      .replace(/\\*\\*/g, \"*\\\\*\"),\n    \"i\"\n  );\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport type FuzzySearchOptions<T> = BaseSearchOptions<T>;\n\n/**\n * Filters a list by making sure that all the letters appear in order ignoring\n * case, punctuation, whitespace, and special characters. This is kind of the\n * same filtering that appears in text editors.\n *\n * @example\n * Simple Example\n * ```ts\n * const list = [\n *   \"at\",\n *   \"charAt\",\n *   \"charCodeAt\",\n *   \"codePointAt\",\n *   \"concat\",\n *   \"constructor\",\n *   \"endsWith\",\n *   \"includes\",\n *   \"indexOf\",\n *   \"lastIndexOf\",\n *   \"length\",\n *   \"localeCompare\",\n *   \"match\",\n *   \"matchAll\",\n *   \"normalize\",\n *   \"padEnd\",\n *   \"padStart\",\n *   \"repeat\",\n *   \"replace\",\n *   \"replaceAll\",\n *   \"search\",\n *   \"slice\",\n *   \"split\",\n *   \"startsWith\",\n *   \"substring\",\n *   \"toLocaleLowerCase\",\n *   \"toLocaleUpperCase\",\n *   \"toLowerCase\",\n *   \"toString\",\n *   \"toUpperCase\",\n *   \"trim\",\n *   \"trimEnd\",\n *   \"trimStart\",\n *   \"valueOf\",\n * ];\n *\n * fuzzySearch({\n *   list,\n *   query: \"la\",\n * });\n * // [\n * //   \"lastIndexOf\",\n * //    ^^\n * //   \"localeCompare\",\n * //    ^  ^\n * //   \"replace\",\n * //       ^^\n * //   \"replaceAll\",\n * //       ^^\n * //   \"toLocaleLowerCase\",\n * //      ^  ^\n * //   \"toLocaleUpperCase\",\n * //      ^  ^\n * //   \"toLowerCase\",\n * //      ^     ^\n * // ]\n *\n * fuzzySearch({\n *   list,\n *   query: \"ad\",\n *   type: \"search\",\n * });\n * // \"charCodeAt\"\n *  //    ^   ^\n * ```\n *\n * @remarks \\@since 6.0.0\n */\nexport function fuzzySearch<T extends string>(\n  options: Omit<FuzzySearchOptions<T>, \"extractor\"> & { type?: \"filter\" }\n): readonly T[];\nexport function fuzzySearch<T extends string>(\n  options: Omit<FuzzySearchOptions<T>, \"extractor\"> & { type?: \"search\" }\n): T | undefined;\nexport function fuzzySearch<T>(\n  option: FuzzySearchOptions<T> & {\n    extractor: TextExtractor<T>;\n    type?: \"filter\";\n  }\n): readonly T[];\nexport function fuzzySearch<T>(\n  option: FuzzySearchOptions<T> & {\n    extractor: TextExtractor<T>;\n    type?: \"search\";\n  }\n): T | undefined;\nexport function fuzzySearch<T>(\n  options: FuzzySearchOptions<T>\n): readonly T[] | T | undefined {\n  const {\n    list,\n    type = \"filter\",\n    query,\n    extractor = defaultExtractor(\"fuzzySearch\"),\n    whitespace,\n  } = options;\n\n  // lazy initialize the RegExp since the base `filter` function will modify the\n  // query and never call the filter function if:\n  // - there is no query\n  // - the list is empty\n  let regexp: RegExp;\n  return search({\n    type,\n    list,\n    query,\n    extractor,\n    whitespace,\n    filter(query, value) {\n      return (\n        value.length > 0 && (regexp ??= createFuzzyRegExp(query)).test(value)\n      );\n    },\n  });\n}\n"],"names":["defaultExtractor","search","createFuzzyRegExp","query","RegExp","split","join","replace","fuzzySearch","options","list","type","extractor","whitespace","regexp","filter","value","length","test"],"mappings":"AAEA,SAASA,gBAAgB,EAAEC,MAAM,QAAQ,aAAa;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6BC,GACD,OAAO,SAASC,kBAAkBC,KAAa;IAC7C,OAAO,IAAIC,OACTD,MACGE,KAAK,CAAC,IACNC,IAAI,CAAC,QACLC,OAAO,CAAC,wDAAwD,OACjE,uEAAuE;KACtEA,OAAO,CAAC,SAAS,SACpB;AAEJ;AAsGA,OAAO,SAASC,YACdC,OAA8B;IAE9B,MAAM,EACJC,IAAI,EACJC,OAAO,QAAQ,EACfR,KAAK,EACLS,YAAYZ,iBAAiB,cAAc,EAC3Ca,UAAU,EACX,GAAGJ;IAEJ,8EAA8E;IAC9E,+CAA+C;IAC/C,sBAAsB;IACtB,sBAAsB;IACtB,IAAIK;IACJ,OAAOb,OAAO;QACZU;QACAD;QACAP;QACAS;QACAC;QACAE,QAAOZ,KAAK,EAAEa,KAAK;YACjB,OACEA,MAAMC,MAAM,GAAG,KAAK,AAACH,CAAAA,WAAWZ,kBAAkBC,MAAK,EAAGe,IAAI,CAACF;QAEnE;IACF;AACF"}

package/dist/searching/toSearchQuery.d.ts

@@ -0,0 +1,5 @@
+import { type WhitespaceFilter } from "./types.js";
+/**
+ * @remarks \@since 6.0.0
+ */
+export declare function toSearchQuery(s: string, whitespace?: WhitespaceFilter): string;

package/dist/searching/toSearchQuery.js

@@ -0,0 +1,13 @@
+/**
+ * @remarks \@since 6.0.0
+ */ export function toSearchQuery(s, whitespace = "keep") {
+    let q = s.toLowerCase();
+    if (whitespace === "ignore") {
+        q = q.replace(/\s/g, "");
+    } else if (whitespace === "trim") {
+        q = q.trim();
+    }
+    return q;
+}
+
+//# sourceMappingURL=toSearchQuery.js.map

package/dist/searching/toSearchQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/searching/toSearchQuery.ts"],"sourcesContent":["import { type WhitespaceFilter } from \"./types.js\";\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport function toSearchQuery(\n  s: string,\n  whitespace: WhitespaceFilter = \"keep\"\n): string {\n  let q = s.toLowerCase();\n  if (whitespace === \"ignore\") {\n    q = q.replace(/\\s/g, \"\");\n  } else if (whitespace === \"trim\") {\n    q = q.trim();\n  }\n\n  return q;\n}\n"],"names":["toSearchQuery","s","whitespace","q","toLowerCase","replace","trim"],"mappings":"AAEA;;CAEC,GACD,OAAO,SAASA,cACdC,CAAS,EACTC,aAA+B,MAAM;IAErC,IAAIC,IAAIF,EAAEG,WAAW;IACrB,IAAIF,eAAe,UAAU;QAC3BC,IAAIA,EAAEE,OAAO,CAAC,OAAO;IACvB,OAAO,IAAIH,eAAe,QAAQ;QAChCC,IAAIA,EAAEG,IAAI;IACZ;IAEA,OAAOH;AACT"}

package/dist/searching/types.d.ts

@@ -0,0 +1,28 @@
+import { type TextExtractor } from "../types.js";
+/**
+ * @remarks \@since 6.0.0
+ */
+export type WhitespaceFilter = "ignore" | "trim" | "keep";
+/**
+ * @remarks \@since 6.0.0
+ */
+export interface BaseSearchOptions<T> {
+    list: readonly T[];
+    /**
+     * @defaultValue `"filter"`
+     */
+    type?: "search" | "filter";
+    /**
+     * The current query string. i.e. `"SeArch"`
+     */
+    query: string;
+    /**
+     * This is required if the list includes anything other than strings.
+     * @see {@link TextExtractor}
+     */
+    extractor?: TextExtractor<T>;
+    /**
+     * @defaultValue `"keep"`
+     */
+    whitespace?: WhitespaceFilter;
+}

package/dist/searching/types.js

@@ -0,0 +1,5 @@
+/**
+ * @remarks \@since 6.0.0
+ */ export { };
+
+//# sourceMappingURL=types.js.map

package/dist/searching/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/searching/types.ts"],"sourcesContent":["import { type TextExtractor } from \"../types.js\";\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport type WhitespaceFilter = \"ignore\" | \"trim\" | \"keep\";\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface BaseSearchOptions<T> {\n  list: readonly T[];\n\n  /**\n   * @defaultValue `\"filter\"`\n   */\n  type?: \"search\" | \"filter\";\n\n  /**\n   * The current query string. i.e. `\"SeArch\"`\n   */\n  query: string;\n\n  /**\n   * This is required if the list includes anything other than strings.\n   * @see {@link TextExtractor}\n   */\n  extractor?: TextExtractor<T>;\n\n  /**\n   * @defaultValue `\"keep\"`\n   */\n  whitespace?: WhitespaceFilter;\n}\n"],"names":[],"mappings":"AAOA;;CAEC,GACD,WAuBC"}

package/dist/searching/utils.d.ts

@@ -0,0 +1,21 @@
+import { type TextExtractor } from "../types.js";
+import { type BaseSearchOptions } from "./types.js";
+/**
+ * @remarks \@since 6.0.0
+ * @internal
+ */
+export declare const defaultExtractor: <T>(name: string) => (item: T) => string;
+/**
+ * @internal
+ * @remarks \@since 6.0.0
+ */
+export interface SearchOptions<T> extends BaseSearchOptions<T> {
+    type: "search" | "filter";
+    filter(query: string, value: string): boolean;
+    extractor: TextExtractor<T>;
+}
+/**
+ * @internal
+ * @remarks \@since 6.0.0
+ */
+export declare function search<T>(options: SearchOptions<T>): readonly T[] | T | undefined;