@react-md/core 1.0.0-next.1 → 1.0.0-next.10

package/dist/icon/MaterialSymbolsProvider.d.ts

@@ -1,145 +0,0 @@
-import { type CSSProperties, type ReactElement, type ReactNode } from "react";
-import { type MaterialSymbolFamily } from "./material.js";
-/**
- * Fill gives you the ability to modify the default icon style. A single icon
- * can render both unfilled and filled states.
- *
- * To convey a state transition, use the fill axis for animation or
- * interaction. The values are 0 for default or 1 for completely filled. Along
- * with the weight axis, the fill also impacts the look of the icon.
- *
- * @remarks \@since 6.0.0
- */
-export type MaterialSymbolFill = 0 | 1;
-/**
- * Weight defines the symbol’s stroke weight, with a range of weights between
- * thin (100) and bold (700). Weight can also affect the overall size of the
- * symbol.
- *
- * @remarks \@since 6.0.0
- */
-export type MaterialSymbolWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700;
-/**
- * Weight and grade affect a symbol’s thickness. Adjustments to grade are more
- * granular than adjustments to weight and have a small impact on the size of
- * the symbol.
- *
- * Grade is also available in some text fonts. You can match grade levels
- * between text and symbols for a harmonious visual effect. For example, if
- * the text font has a -25 grade value, the symbols can match it with a
- * suitable value, say -25.
- *
- * You can use grade for different needs:
- *
- * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a
- *   dark background, use a low grade.
- * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the
- *   positive grade.
- *
- * @remarks \@since 6.0.0
- */
-export type MaterialSymbolGrade = -25 | 0 | 200;
-/**
- * Optical Sizes range from 20dp to 48dp.
- *
- * For the image to look the same at different sizes, the stroke weight
- * (thickness) changes as the icon size scales. Optical Size offers a way to
- * automatically adjust the stroke weight when you increase or decrease the
- * symbol size.
- *
- * @remarks \@since 6.0.0
- */
-export type MaterialSymbolOpticalSize = 20 | 24 | 40 | 48;
-/**
- * The comments for each customizable part was copied from
- * https://fonts.google.com/icons?icon.set=Material+Symbols and clicking the
- * info icon next to each property.
- *
- * @see https://fonts.google.com/icons?icon.set=Material+Symbols
- * @remarks \@since 6.0.0
- */
-export interface MaterialSymbolCustomization {
-    /**
-     * Fill gives you the ability to modify the default icon style. A single icon
-     * can render both unfilled and filled states.
-     *
-     * To convey a state transition, use the fill axis for animation or
-     * interaction. The values are 0 for default or 1 for completely filled. Along
-     * with the weight axis, the fill also impacts the look of the icon.
-     *
-     * @defaultValue `0`
-     */
-    fill?: MaterialSymbolFill;
-    /**
-     * Weight defines the symbol’s stroke weight, with a range of weights between
-     * thin (100) and bold (700). Weight can also affect the overall size of the
-     * symbol.
-     *
-     * @defaultValue `400`
-     */
-    weight?: MaterialSymbolWeight;
-    /**
-     * Weight and grade affect a symbol’s thickness. Adjustments to grade are more
-     * granular than adjustments to weight and have a small impact on the size of
-     * the symbol.
-     *
-     * Grade is also available in some text fonts. You can match grade levels
-     * between text and symbols for a harmonious visual effect. For example, if
-     * the text font has a -25 grade value, the symbols can match it with a
-     * suitable value, say -25.
-     *
-     * You can use grade for different needs:
-     *
-     * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a
-     *   dark background, use a low grade.
-     * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the
-     *   positive grade.
-     *
-     * @defaultValue `0`
-     */
-    grade?: MaterialSymbolGrade;
-    /**
-     * Optical Sizes range from 20dp to 48dp.
-     *
-     * For the image to look the same at different sizes, the stroke weight
-     * (thickness) changes as the icon size scales. Optical Size offers a way to
-     * automatically adjust the stroke weight when you increase or decrease the
-     * symbol size.
-     *
-     * @defaultValue `48`
-     */
-    opticalSize?: MaterialSymbolOpticalSize;
-    /**
-     * @defaultValue `"outlined"`
-     */
-    family?: MaterialSymbolFamily;
-}
-/**
- * @remarks \@since 6.0.0
- */
-export type MaterialSymbolConfiguration = Required<MaterialSymbolCustomization>;
-/**
- * @remarks \@since 6.0.0
- */
-export declare function useMaterialSymbolConfiguration(): MaterialSymbolConfiguration;
-/**
- * @remarks \@since 6.0.0
- */
-export declare function useFontVariationSettings(options: MaterialSymbolCustomization & {
-    style?: CSSProperties;
-}): {
-    style?: CSSProperties;
-    family: MaterialSymbolFamily;
-};
-/**
- * @remarks \@since 6.0.0
- */
-export interface MaterialSymbolsProviderProps extends MaterialSymbolCustomization {
-    children: ReactNode;
-}
-/**
- * **Client Component**
- *
- * @remarks \@since 6.0.0
- */
-export declare function MaterialSymbolsProvider(props: MaterialSymbolsProviderProps): ReactElement;

package/dist/icon/MaterialSymbolsProvider.js

@@ -1,60 +0,0 @@
-"use client";
-import { jsx as _jsx } from "react/jsx-runtime";
-import { createContext, useContext, useMemo } from "react";
-const context = /*#__PURE__*/ createContext({
-    fill: 0,
-    weight: 400,
-    grade: 0,
-    opticalSize: 24,
-    family: "outlined"
-});
-context.displayName = "MaterialSymbol";
-const { Provider } = context;
-/**
- * @remarks \@since 6.0.0
- */ export function useMaterialSymbolConfiguration() {
-    return useContext(context);
-}
-/**
- * @remarks \@since 6.0.0
- */ export function useFontVariationSettings(options) {
-    const configuration = useMaterialSymbolConfiguration();
-    let { style } = options;
-    const { fill = configuration.fill, grade = configuration.grade, opticalSize = configuration.opticalSize, weight = configuration.weight, family = configuration.family } = options;
-    if (!style?.fontVariationSettings && (fill !== configuration.fill || grade !== configuration.grade || opticalSize !== configuration.opticalSize || weight !== configuration.weight)) {
-        style = {
-            ...style,
-            fontVariationSettings: `"FILL" ${fill}, "wght" ${weight}, "GRAD" ${grade}, "opsz" ${opticalSize}`
-        };
-    }
-    return {
-        family,
-        style
-    };
-}
-/**
- * **Client Component**
- *
- * @remarks \@since 6.0.0
- */ export function MaterialSymbolsProvider(props) {
-    const { fill = 0, weight = 400, grade = 0, family: type = "outlined", opticalSize = 48, children } = props;
-    const value = useMemo(()=>({
-            fill,
-            weight,
-            grade,
-            family: type,
-            opticalSize
-        }), [
-        fill,
-        grade,
-        opticalSize,
-        type,
-        weight
-    ]);
-    return /*#__PURE__*/ _jsx(Provider, {
-        value: value,
-        children: children
-    });
-}
-
-//# sourceMappingURL=MaterialSymbolsProvider.js.map

package/dist/icon/MaterialSymbolsProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/icon/MaterialSymbolsProvider.tsx"],"sourcesContent":["\"use client\";\nimport {\n  createContext,\n  useContext,\n  useMemo,\n  type CSSProperties,\n  type ReactElement,\n  type ReactNode,\n} from \"react\";\nimport { type MaterialSymbolFamily } from \"./material.js\";\n\n/**\n * Fill gives you the ability to modify the default icon style. A single icon\n * can render both unfilled and filled states.\n *\n * To convey a state transition, use the fill axis for animation or\n * interaction. The values are 0 for default or 1 for completely filled. Along\n * with the weight axis, the fill also impacts the look of the icon.\n *\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolFill = 0 | 1;\n\n/**\n * Weight defines the symbol’s stroke weight, with a range of weights between\n * thin (100) and bold (700). Weight can also affect the overall size of the\n * symbol.\n *\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700;\n\n/**\n * Weight and grade affect a symbol’s thickness. Adjustments to grade are more\n * granular than adjustments to weight and have a small impact on the size of\n * the symbol.\n *\n * Grade is also available in some text fonts. You can match grade levels\n * between text and symbols for a harmonious visual effect. For example, if\n * the text font has a -25 grade value, the symbols can match it with a\n * suitable value, say -25.\n *\n * You can use grade for different needs:\n *\n * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a\n *   dark background, use a low grade.\n * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the\n *   positive grade.\n *\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolGrade = -25 | 0 | 200;\n\n/**\n * Optical Sizes range from 20dp to 48dp.\n *\n * For the image to look the same at different sizes, the stroke weight\n * (thickness) changes as the icon size scales. Optical Size offers a way to\n * automatically adjust the stroke weight when you increase or decrease the\n * symbol size.\n *\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolOpticalSize = 20 | 24 | 40 | 48;\n\n/**\n * The comments for each customizable part was copied from\n * https://fonts.google.com/icons?icon.set=Material+Symbols and clicking the\n * info icon next to each property.\n *\n * @see https://fonts.google.com/icons?icon.set=Material+Symbols\n * @remarks \\@since 6.0.0\n */\nexport interface MaterialSymbolCustomization {\n  /**\n   * Fill gives you the ability to modify the default icon style. A single icon\n   * can render both unfilled and filled states.\n   *\n   * To convey a state transition, use the fill axis for animation or\n   * interaction. The values are 0 for default or 1 for completely filled. Along\n   * with the weight axis, the fill also impacts the look of the icon.\n   *\n   * @defaultValue `0`\n   */\n  fill?: MaterialSymbolFill;\n\n  /**\n   * Weight defines the symbol’s stroke weight, with a range of weights between\n   * thin (100) and bold (700). Weight can also affect the overall size of the\n   * symbol.\n   *\n   * @defaultValue `400`\n   */\n  weight?: MaterialSymbolWeight;\n\n  /**\n   * Weight and grade affect a symbol’s thickness. Adjustments to grade are more\n   * granular than adjustments to weight and have a small impact on the size of\n   * the symbol.\n   *\n   * Grade is also available in some text fonts. You can match grade levels\n   * between text and symbols for a harmonious visual effect. For example, if\n   * the text font has a -25 grade value, the symbols can match it with a\n   * suitable value, say -25.\n   *\n   * You can use grade for different needs:\n   *\n   * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a\n   *   dark background, use a low grade.\n   * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the\n   *   positive grade.\n   *\n   * @defaultValue `0`\n   */\n  grade?: MaterialSymbolGrade;\n\n  /**\n   * Optical Sizes range from 20dp to 48dp.\n   *\n   * For the image to look the same at different sizes, the stroke weight\n   * (thickness) changes as the icon size scales. Optical Size offers a way to\n   * automatically adjust the stroke weight when you increase or decrease the\n   * symbol size.\n   *\n   * @defaultValue `48`\n   */\n  opticalSize?: MaterialSymbolOpticalSize;\n\n  /**\n   * @defaultValue `\"outlined\"`\n   */\n  family?: MaterialSymbolFamily;\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolConfiguration = Required<MaterialSymbolCustomization>;\n\nconst context = createContext<MaterialSymbolConfiguration>({\n  fill: 0,\n  weight: 400,\n  grade: 0,\n  opticalSize: 24,\n  family: \"outlined\",\n});\ncontext.displayName = \"MaterialSymbol\";\nconst { Provider } = context;\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport function useMaterialSymbolConfiguration(): MaterialSymbolConfiguration {\n  return useContext(context);\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport function useFontVariationSettings(\n  options: MaterialSymbolCustomization & { style?: CSSProperties }\n): { style?: CSSProperties; family: MaterialSymbolFamily } {\n  const configuration = useMaterialSymbolConfiguration();\n  let { style } = options;\n  const {\n    fill = configuration.fill,\n    grade = configuration.grade,\n    opticalSize = configuration.opticalSize,\n    weight = configuration.weight,\n    family = configuration.family,\n  } = options;\n  if (\n    !style?.fontVariationSettings &&\n    (fill !== configuration.fill ||\n      grade !== configuration.grade ||\n      opticalSize !== configuration.opticalSize ||\n      weight !== configuration.weight)\n  ) {\n    style = {\n      ...style,\n      fontVariationSettings: `\"FILL\" ${fill}, \"wght\" ${weight}, \"GRAD\" ${grade}, \"opsz\" ${opticalSize}`,\n    };\n  }\n\n  return { family, style };\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface MaterialSymbolsProviderProps\n  extends MaterialSymbolCustomization {\n  children: ReactNode;\n}\n\n/**\n * **Client Component**\n *\n * @remarks \\@since 6.0.0\n */\nexport function MaterialSymbolsProvider(\n  props: MaterialSymbolsProviderProps\n): ReactElement {\n  const {\n    fill = 0,\n    weight = 400,\n    grade = 0,\n    family: type = \"outlined\",\n    opticalSize = 48,\n    children,\n  } = props;\n  const value = useMemo<MaterialSymbolConfiguration>(\n    () => ({\n      fill,\n      weight,\n      grade,\n      family: type,\n      opticalSize,\n    }),\n    [fill, grade, opticalSize, type, weight]\n  );\n\n  return <Provider value={value}>{children}</Provider>;\n}\n"],"names":["createContext","useContext","useMemo","context","fill","weight","grade","opticalSize","family","displayName","Provider","useMaterialSymbolConfiguration","useFontVariationSettings","options","configuration","style","fontVariationSettings","MaterialSymbolsProvider","props","type","children","value"],"mappings":"AAAA;;AACA,SACEA,aAAa,EACbC,UAAU,EACVC,OAAO,QAIF,QAAQ;AAmIf,MAAMC,wBAAUH,cAA2C;IACzDI,MAAM;IACNC,QAAQ;IACRC,OAAO;IACPC,aAAa;IACbC,QAAQ;AACV;AACAL,QAAQM,WAAW,GAAG;AACtB,MAAM,EAAEC,QAAQ,EAAE,GAAGP;AAErB;;CAEC,GACD,OAAO,SAASQ;IACd,OAAOV,WAAWE;AACpB;AAEA;;CAEC,GACD,OAAO,SAASS,yBACdC,OAAgE;IAEhE,MAAMC,gBAAgBH;IACtB,IAAI,EAAEI,KAAK,EAAE,GAAGF;IAChB,MAAM,EACJT,OAAOU,cAAcV,IAAI,EACzBE,QAAQQ,cAAcR,KAAK,EAC3BC,cAAcO,cAAcP,WAAW,EACvCF,SAASS,cAAcT,MAAM,EAC7BG,SAASM,cAAcN,MAAM,EAC9B,GAAGK;IACJ,IACE,CAACE,OAAOC,yBACPZ,CAAAA,SAASU,cAAcV,IAAI,IAC1BE,UAAUQ,cAAcR,KAAK,IAC7BC,gBAAgBO,cAAcP,WAAW,IACzCF,WAAWS,cAAcT,MAAM,AAAD,GAChC;QACAU,QAAQ;YACN,GAAGA,KAAK;YACRC,uBAAuB,CAAC,OAAO,EAAEZ,KAAK,SAAS,EAAEC,OAAO,SAAS,EAAEC,MAAM,SAAS,EAAEC,YAAY,CAAC;QACnG;IACF;IAEA,OAAO;QAAEC;QAAQO;IAAM;AACzB;AAUA;;;;CAIC,GACD,OAAO,SAASE,wBACdC,KAAmC;IAEnC,MAAM,EACJd,OAAO,CAAC,EACRC,SAAS,GAAG,EACZC,QAAQ,CAAC,EACTE,QAAQW,OAAO,UAAU,EACzBZ,cAAc,EAAE,EAChBa,QAAQ,EACT,GAAGF;IACJ,MAAMG,QAAQnB,QACZ,IAAO,CAAA;YACLE;YACAC;YACAC;YACAE,QAAQW;YACRZ;QACF,CAAA,GACA;QAACH;QAAME;QAAOC;QAAaY;QAAMd;KAAO;IAG1C,qBAAO,KAACK;QAASW,OAAOA;kBAAQD;;AAClC"}

package/dist/link/LinkProvider.d.ts

@@ -1,29 +0,0 @@
-import { type ForwardRefExoticComponent, type ReactElement, type ReactNode } from "react";
-/**
- * @remarks \@since 6.0.0
- */
-export type CustomLinkComponent = ForwardRefExoticComponent<{
-    href: string;
-}> | ForwardRefExoticComponent<{
-    to: string;
-}> | "a";
-/**
- * @remarks \@since 6.0.0
- */
-export declare function useLink(): CustomLinkComponent;
-/**
- * @remarks \@since 6.0.0
- */
-export interface LinkProviderProps {
-    /**
-     * @defaultValue `useLink() ?? Link`
-     */
-    value?: CustomLinkComponent;
-    children: ReactNode;
-}
-/**
- * **Client Component**
- *
- * @remarks \@since 6.0.0
- */
-export declare function LinkProvider(props: LinkProviderProps): ReactElement;

package/dist/menu/menuConfig.d.ts

@@ -1,60 +0,0 @@
-import { type ReactNode } from "react";
-import { type SheetPosition, type SheetVerticalSize } from "../sheet/styles.js";
-/**
- * This allows the menu to be conditionally rendered as a `Sheet` instead of a
- * menu.
- *
- * - `false` - always render as a `Menu`
- * - `true` - always render as a `Sheet`
- * - `"phone"` - render as a sheet only when the {@link AppSize} is considered
- *   phone (`isPhone === true`).
- *
- * @defaultValue `false`
- * @remarks \@since 5.0.0
- */
-export type RenderMenuAsSheet = boolean | "phone";
-/**
- * @remarks \@since 5.0.0
- * @remarks \@since 6.0.0 No longer includes the `horizontal` flag and is no
- * longer a context provider.
- */
-export interface MenuConfiguration {
-    /** {@inheritDoc RenderMenuAsSheet} */
-    renderAsSheet?: RenderMenuAsSheet;
-    /**
-     * @see {@link SheetPosition}
-     * @defaultValue `"bottom"`
-     */
-    sheetPosition?: SheetPosition;
-    /**
-     * @see {@link SheetVerticalSize}
-     * @defaultValue `"touch"`
-     */
-    sheetVerticalSize?: SheetVerticalSize;
-    /**
-     * Any children to render above the sheet's menu implementation. This would
-     * normally be something like a `<DialogHeader>` or `AppBar`.
-     *
-     * @defaultValue `null`
-     */
-    sheetHeader?: ReactNode;
-    /**
-     * Any children to render below the sheet's menu implementation. This would
-     * normally be something like a `<DialogFooter>`.
-     *
-     * @defaultValue `null`
-     */
-    sheetFooter?: ReactNode;
-}
-/**
- * @remarks \@since 6.0.0
- */
-export type MenuConfig = Required<MenuConfiguration>;
-/**
- * @remarks \@since 6.0.0
- */
-export declare const MENU_CONFIG: MenuConfig;
-/**
- * @remarks \@since 6.0.0
- */
-export declare function getMenuConfig<N extends keyof MenuConfig>(name: N, override?: MenuConfig[N]): MenuConfig[N];

package/dist/tooltip/useOverflowTooltip.d.ts

@@ -1,61 +0,0 @@
-import { type Ref, type RefCallback } from "react";
-import { type TooltipImplementation, type TooltipOptions } from "./useTooltip.js";
-/**
- * @remarks \@since 6.0.0
- */
-export interface OverflowTooltipOptions extends TooltipOptions {
-    elementRef?: Ref<HTMLElement>;
-}
-/**
- * @remarks \@since 6.0.0
- */
-export interface OverflowTooltipImplementation extends TooltipImplementation {
-    nodeRef: RefCallback<HTMLElement>;
-}
-/**
- * This hook will ensure that a tooltip will only appear when text has
- * overflown by checking the size with the {@link useResizeObserver}.
- *
- * @example
- * ```tsx
- * import {
- *   cssUtils,
- *   Link,
- *   Tooltip,
- *   useOverflowTooltip,
- *   type LinkProps,
- * } from "@react-md/core";
- * import { type ReactElement } from "react";
- *
- * function NavigationLink(props: LinkProps): ReactElement {
- *   const { children, ...remaining } = props;
- *   const { nodeRef, elementProps, tooltipProps } = useOverflowTooltip(remaining);
- *
- *   return (
- *     <Link {...remaining} {...elementProps} style={{ width: "100%" }}>
- *       <span ref={nodeRef} className={cssUtils({ textOverflow: "ellipsis" })}>
- *         {children}
- *       </span>
- *       <Tooltip {...tooltipProps}>
- *         {children}
- *       </Tooltip>
- *     </Link>
- *   );
- * }
- *
- * function Example(): ReactElement {
- *   return (
- *     <div style={{ width: "10rem", overflow: "auto" }}>
- *       <NavigationLink href="/">Home</NavigationLink>
- *       <NavigationLink href="/some-path">
- *         Super long text that will be truncated with ellipsis and
- *         have a tooltip appear
- *       </NavigationLink>
- *     </div>
- *   );
- * }
- * ```
- *
- * @remarks \@since 6.0.0
- */
-export declare function useOverflowTooltip(options?: OverflowTooltipOptions): OverflowTooltipImplementation;

package/dist/utils/filters.d.ts

@@ -1,196 +0,0 @@
-import type { TextExtractor } from "../types.js";
-/**
- * @remarks \@since 6.0.0
- */
-export interface BaseFilterOptions<T> {
-    list: readonly T[];
-    /**
-     * 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?: "ignore" | "trim" | "keep";
-}
-/**
- * @internal
- * @remarks \@since 6.0.0
- */
-export interface FilterOptions<T> extends BaseFilterOptions<T> {
-    filter(query: string, value: string): boolean;
-    extractor: TextExtractor<T>;
-}
-/**
- * @remarks \@since 6.0.0
- */
-export interface CaseInsensitiveOptions<T> extends BaseFilterOptions<T> {
-    /**
-     * Set this to `true` if the item in the list must start with the query
-     * instead of only including it.
-     *
-     * @example
-     * ```ts
-     * const fruits = ["Apple", "Banana", "Grape", "Orange"];
-     *
-     * caseInsensitiveFilter({
-     *   list: fruits,
-     *   query: "ap",
-     * });
-     * // ["Apple", "Grape"]
-     *
-     * caseInsensitiveFilter({
-     *   list: fruits,
-     *   query: "ap",
-     *   startsWith: true,
-     * });
-     * // ["Apple"]
-     * ```
-     *
-     * @defaultValue `false`
-     */
-    startsWith?: boolean;
-}
-/**
- * @example
- * String list
- * ```ts
- * const fruits = ["Apple", "Banana", "Grape", "Orange"];
- *
- * caseInsensitiveFilter({
- *   list: fruits,
- *   query: "ap",
- * });
- * // ["Apple", "Grape"]
- *
- * caseInsensitiveFilter({
- *   list: fruits,
- *   query: "ap",
- *   startsWith: true,
- * });
- * // ["Apple"]
- *
- * caseInsensitiveFilter({
- *   list: fruits,
- *   query: "  a p",
- * });
- * // []
- *
- * caseInsensitiveFilter({
- *   list: fruits,
- *   query: "  a p",
- *   whitespace: "ignore",
- * });
- * // ["Apple", "Grape"]
- *
- * caseInsensitiveFilter({
- *   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 },
- * ];
- *
- * caseInsensitiveFilter({
- *   list: fruits,
- *   query: "ap",
- *   extractor: (item) => item.name,
- * });
- * // [{ name: "Apple", value: 0 }, { name: "Grape", value: 2 }]
- * ```
- *
- * @remarks \@since 6.0.0
- */
-export declare function caseInsensitiveFilter<T extends string>(options: Omit<CaseInsensitiveOptions<T>, "extractor">): readonly T[];
-export declare function caseInsensitiveFilter<T>(options: CaseInsensitiveOptions<T> & {
-    extractor: TextExtractor<T>;
-}): readonly T[];
-/**
- * @remarks \@since 6.0.0
- */
-export type FuzzyFilterOptions<T> = BaseFilterOptions<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",
- * ];
- *
- * fuzzyFilter({ list: list, query: "la" });
- * // [
- * //   "lastIndexOf",
- * //    ^^
- * //   "localeCompare",
- * //    ^  ^
- * //   "replace",
- * //       ^^
- * //   "replaceAll",
- * //       ^^
- * //   "toLocaleLowerCase",
- * //      ^  ^
- * //   "toLocaleUpperCase",
- * //      ^  ^
- * //   "toLowerCase",
- * //      ^     ^
- * // ]
- * ```
- *
- * @remarks \@since 6.0.0
- */
-export declare function fuzzyFilter<T extends string>(options: Omit<FuzzyFilterOptions<T>, "extractor">): readonly T[];
-export declare function fuzzyFilter<T>(option: FuzzyFilterOptions<T> & {
-    extractor: TextExtractor<T>;
-}): readonly T[];

package/dist/utils/filters.js

@@ -1,67 +0,0 @@
-/** @internal */ const identity = (name)=>(item)=>{
-        if (typeof item === "string") {
-            return item;
-        }
-        throw new Error(`A \`TextExtractor\` must be provided to \`${name}\` for lists that do not contain strings`);
-    };
-/**
- * @internal
- * @remarks \@since 6.0.0
- */ const toSearchString = (s, whitespace)=>{
-    let q = s.toLowerCase();
-    if (whitespace === "ignore") {
-        q = q.replace(/\s/g, "");
-    } else if (whitespace === "trim") {
-        q = q.trim();
-    }
-    return q;
-};
-/**
- * @internal
- * @remarks \@since 6.0.0
- */ function filter(options) {
-    const { list, query, filter, extractor, whitespace = "keep" } = options;
-    if (!list.length) {
-        return list;
-    }
-    const q = toSearchString(query, whitespace);
-    if (!q) {
-        return list;
-    }
-    return list.filter((item)=>filter(q, toSearchString(extractor(item), whitespace)));
-}
-export function caseInsensitiveFilter(options) {
-    const { list, query, extractor = identity("caseInsensitiveFilter"), startsWith, whitespace } = options;
-    return filter({
-        list,
-        query,
-        extractor,
-        whitespace,
-        filter (q, value) {
-            const matchIndex = value.indexOf(q);
-            if (startsWith) {
-                return matchIndex === 0;
-            }
-            return matchIndex !== -1;
-        }
-    });
-}
-export function fuzzyFilter(options) {
-    const { list, query, extractor = identity("fuzzyFilter"), whitespace } = options;
-    let regexp;
-    return filter({
-        list,
-        query,
-        extractor,
-        whitespace,
-        filter (query, value) {
-            if (!regexp) {
-                regexp = 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");
-            }
-            return value.length > 0 && regexp.test(value);
-        }
-    });
-}
-
-//# sourceMappingURL=filters.js.map

package/dist/utils/filters.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utils/filters.ts"],"sourcesContent":["import type { TextExtractor } from \"../types.js\";\n\n/** @internal */\nconst identity =\n  <T>(name: string) =>\n  (item: T): string => {\n    if (typeof item === \"string\") {\n      return item;\n    }\n\n    throw new Error(\n      `A \\`TextExtractor\\` must be provided to \\`${name}\\` for lists that do not contain strings`\n    );\n  };\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface BaseFilterOptions<T> {\n  list: readonly T[];\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?: \"ignore\" | \"trim\" | \"keep\";\n}\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport interface FilterOptions<T> extends BaseFilterOptions<T> {\n  filter(query: string, value: string): boolean;\n  extractor: TextExtractor<T>;\n}\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nconst toSearchString = (\n  s: string,\n  whitespace: \"trim\" | \"ignore\" | \"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\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nfunction filter<T>(options: FilterOptions<T>): readonly T[] {\n  const { list, query, filter, extractor, whitespace = \"keep\" } = options;\n  if (!list.length) {\n    return list;\n  }\n\n  const q = toSearchString(query, whitespace);\n  if (!q) {\n    return list;\n  }\n\n  return list.filter((item) =>\n    filter(q, toSearchString(extractor(item), whitespace))\n  );\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface CaseInsensitiveOptions<T> extends BaseFilterOptions<T> {\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   * ```ts\n   * const fruits = [\"Apple\", \"Banana\", \"Grape\", \"Orange\"];\n   *\n   * caseInsensitiveFilter({\n   *   list: fruits,\n   *   query: \"ap\",\n   * });\n   * // [\"Apple\", \"Grape\"]\n   *\n   * caseInsensitiveFilter({\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 * @example\n * String list\n * ```ts\n * const fruits = [\"Apple\", \"Banana\", \"Grape\", \"Orange\"];\n *\n * caseInsensitiveFilter({\n *   list: fruits,\n *   query: \"ap\",\n * });\n * // [\"Apple\", \"Grape\"]\n *\n * caseInsensitiveFilter({\n *   list: fruits,\n *   query: \"ap\",\n *   startsWith: true,\n * });\n * // [\"Apple\"]\n *\n * caseInsensitiveFilter({\n *   list: fruits,\n *   query: \"  a p\",\n * });\n * // []\n *\n * caseInsensitiveFilter({\n *   list: fruits,\n *   query: \"  a p\",\n *   whitespace: \"ignore\",\n * });\n * // [\"Apple\", \"Grape\"]\n *\n * caseInsensitiveFilter({\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 * caseInsensitiveFilter({\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 caseInsensitiveFilter<T extends string>(\n  options: Omit<CaseInsensitiveOptions<T>, \"extractor\">\n): readonly T[];\nexport function caseInsensitiveFilter<T>(\n  options: CaseInsensitiveOptions<T> & { extractor: TextExtractor<T> }\n): readonly T[];\nexport function caseInsensitiveFilter<T>(\n  options: CaseInsensitiveOptions<T>\n): readonly T[] {\n  const {\n    list,\n    query,\n    extractor = identity(\"caseInsensitiveFilter\"),\n    startsWith,\n    whitespace,\n  } = options;\n\n  return filter({\n    list,\n    query,\n    extractor,\n    whitespace,\n    filter(q, value) {\n      const matchIndex = value.indexOf(q);\n      if (startsWith) {\n        return matchIndex === 0;\n      }\n\n      return matchIndex !== -1;\n    },\n  });\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport type FuzzyFilterOptions<T> = BaseFilterOptions<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 * fuzzyFilter({ list: list, query: \"la\" });\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 *\n * @remarks \\@since 6.0.0\n */\nexport function fuzzyFilter<T extends string>(\n  options: Omit<FuzzyFilterOptions<T>, \"extractor\">\n): readonly T[];\nexport function fuzzyFilter<T>(\n  option: FuzzyFilterOptions<T> & { extractor: TextExtractor<T> }\n): readonly T[];\nexport function fuzzyFilter<T>(options: FuzzyFilterOptions<T>): readonly T[] {\n  const {\n    list,\n    query,\n    extractor = identity(\"fuzzyFilter\"),\n    whitespace,\n  } = options;\n\n  let regexp: RegExp;\n  return filter({\n    list,\n    query,\n    extractor,\n    whitespace,\n    filter(query, value) {\n      if (!regexp) {\n        regexp = new RegExp(\n          `${query}`\n            .split(\"\")\n            .join(\"\\\\w*\")\n            .replace(\n              /(\\(|\\||\\)|\\\\(?!w\\*)|\\[|\\|-|\\.|\\^|\\+|\\$|\\?|^(?!w)\\*)/g,\n              \"\\\\$1\"\n            )\n            // Couldn't get the matching of two '*' working, so replace them here..\n            .replace(/\\*\\*/g, \"*\\\\*\"),\n          \"i\"\n        );\n      }\n\n      return value.length > 0 && regexp.test(value);\n    },\n  });\n}\n"],"names":["identity","name","item","Error","toSearchString","s","whitespace","q","toLowerCase","replace","trim","filter","options","list","query","extractor","length","caseInsensitiveFilter","startsWith","value","matchIndex","indexOf","fuzzyFilter","regexp","RegExp","split","join","test"],"mappings":"AAEA,cAAc,GACd,MAAMA,WACJ,CAAIC,OACJ,CAACC;QACC,IAAI,OAAOA,SAAS,UAAU;YAC5B,OAAOA;QACT;QAEA,MAAM,IAAIC,MACR,CAAC,0CAA0C,EAAEF,KAAK,wCAAwC,CAAC;IAE/F;AAkCF;;;CAGC,GACD,MAAMG,iBAAiB,CACrBC,GACAC;IAEA,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;AAEA;;;CAGC,GACD,SAASI,OAAUC,OAAyB;IAC1C,MAAM,EAAEC,IAAI,EAAEC,KAAK,EAAEH,MAAM,EAAEI,SAAS,EAAET,aAAa,MAAM,EAAE,GAAGM;IAChE,IAAI,CAACC,KAAKG,MAAM,EAAE;QAChB,OAAOH;IACT;IAEA,MAAMN,IAAIH,eAAeU,OAAOR;IAChC,IAAI,CAACC,GAAG;QACN,OAAOM;IACT;IAEA,OAAOA,KAAKF,MAAM,CAAC,CAACT,OAClBS,OAAOJ,GAAGH,eAAeW,UAAUb,OAAOI;AAE9C;AAmGA,OAAO,SAASW,sBACdL,OAAkC;IAElC,MAAM,EACJC,IAAI,EACJC,KAAK,EACLC,YAAYf,SAAS,wBAAwB,EAC7CkB,UAAU,EACVZ,UAAU,EACX,GAAGM;IAEJ,OAAOD,OAAO;QACZE;QACAC;QACAC;QACAT;QACAK,QAAOJ,CAAC,EAAEY,KAAK;YACb,MAAMC,aAAaD,MAAME,OAAO,CAACd;YACjC,IAAIW,YAAY;gBACd,OAAOE,eAAe;YACxB;YAEA,OAAOA,eAAe,CAAC;QACzB;IACF;AACF;AA+EA,OAAO,SAASE,YAAeV,OAA8B;IAC3D,MAAM,EACJC,IAAI,EACJC,KAAK,EACLC,YAAYf,SAAS,cAAc,EACnCM,UAAU,EACX,GAAGM;IAEJ,IAAIW;IACJ,OAAOZ,OAAO;QACZE;QACAC;QACAC;QACAT;QACAK,QAAOG,KAAK,EAAEK,KAAK;YACjB,IAAI,CAACI,QAAQ;gBACXA,SAAS,IAAIC,OACX,CAAC,EAAEV,MAAM,CAAC,CACPW,KAAK,CAAC,IACNC,IAAI,CAAC,QACLjB,OAAO,CACN,wDACA,OAEF,uEAAuE;iBACtEA,OAAO,CAAC,SAAS,SACpB;YAEJ;YAEA,OAAOU,MAAMH,MAAM,GAAG,KAAKO,OAAOI,IAAI,CAACR;QACzC;IACF;AACF"}