@fusion.dev/helix-core 0.165.0 → 0.166.0

package/custom-elements.json

@@ -15564,6 +15564,14 @@
             "module": "./utils/filter-marks/filter-marks.js"
           }
         },
+        {
+          "kind": "js",
+          "name": "filterKeeps",
+          "declaration": {
+            "name": "filterKeeps",
+            "module": "./utils/filter-marks/filter-marks.js"
+          }
+        },
         {
           "kind": "js",
           "name": "markMatches",
@@ -27610,6 +27618,37 @@
             }
           ],
           "description": "Marks where `needle` matches in each of `elements`, for `owner`, without\ntouching the elements. An empty needle takes the owner's marks away, which\nis also what an owner leaving the page calls.\n\n**The Custom Highlight API paints a range, and nothing is inserted.** The\nwords are usually the consumer's own light DOM, slotted through as many as\ntwo shadow roots, and wrapping the matched part in a `<mark>` would mean\nrewriting their content: markup they wrote would come back changed. So an\noption holding a link or an icon is marked as readily as one holding a bare\nword. Listbox marks what its filter matched this way, and so every family\nthat filters through one: Select, Combobox, Command and Time Picker.\n\n**The rule that paints it lives in `base.css`**, as\n`::highlight(helix-filter-match)`, rather than in a component's styles. A\nhighlight is styled from the tree its text lives in, and that text lives in\nthe consumer's document.\n\nNothing at all where the API is missing, as on a server, in a test\nenvironment or in an older browser: the text nodes are not walked for an\nanswer nothing can paint."
+        },
+        {
+          "kind": "function",
+          "name": "filterKeeps",
+          "return": {
+            "type": {
+              "text": "boolean"
+            }
+          },
+          "parameters": [
+            {
+              "name": "text",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "filter",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "match",
+              "optional": true,
+              "type": {
+                "text": "((text: string, filter: string) => boolean) | undefined"
+              }
+            }
+          ],
+          "description": "Whether a filter keeps an item: its words hold the filter, in any case, or\n`match` says so where the page gave one. An empty filter keeps everything.\n\nOne answer for every family that filters, so Listbox, Command and a\nfilterable Menu keep the same items for the same words, and a `filterMatch`\nthe page writes once means the same thing in each."
         }
       ],
       "exports": [
@@ -27636,6 +27675,14 @@
             "name": "markMatches",
             "module": "src/utils/filter-marks/filter-marks.ts"
           }
+        },
+        {
+          "kind": "js",
+          "name": "filterKeeps",
+          "declaration": {
+            "name": "filterKeeps",
+            "module": "src/utils/filter-marks/filter-marks.ts"
+          }
         }
       ]
     },
@@ -33264,7 +33311,7 @@
           "type": {
             "text": "string"
           },
-          "default": "'0.165.0'",
+          "default": "'0.166.0'",
           "description": "The version of the package this file ships in.\n\n**Written by `fusion/scripts/version.mjs`** wherever it writes the package's\n`package.json`, and stamped back into the repository beside it after a\nrelease, so the two never disagree; a spec beside this holds them to it.\nNothing else in the running code knows which release it is."
         }
       ],
@@ -33824,6 +33871,6 @@
   ],
   "helix": {
     "package": "@fusion.dev/helix-core",
-    "version": "0.165.0"
+    "version": "0.166.0"
   }
 }

package/dist/index.d.ts

@@ -83,7 +83,7 @@ export { elapsedTime } from './utils/elapsed-time/elapsed-time.js';
 export { type ElementByIdOptions, elementById, searchableById, } from './utils/element-by-id/element-by-id.js';
 export { exportParts } from './utils/export-parts/export-parts.js';
 export { fillTemplate, labelWith } from './utils/fill-template/fill-template.js';
-export { FILTER_MARK, markMatches, rangeOf } from './utils/filter-marks/filter-marks.js';
+export { FILTER_MARK, filterKeeps, markMatches, rangeOf, } from './utils/filter-marks/filter-marks.js';
 export { focusTarget } from './utils/focus-target/focus-target.js';
 export { deepActiveElement, deepContains, focusableElements, PRESSABLE, pressedOwnControl, } from './utils/focusable-elements/focusable-elements.js';
 export { afterLinkFollowed, followLink, type LinkModifiers, type LinkTarget, } from './utils/follow-link/follow-link.js';

package/dist/index.js

@@ -83,7 +83,7 @@ export { elapsedTime } from './utils/elapsed-time/elapsed-time.js';
 export { elementById, searchableById, } from './utils/element-by-id/element-by-id.js';
 export { exportParts } from './utils/export-parts/export-parts.js';
 export { fillTemplate, labelWith } from './utils/fill-template/fill-template.js';
-export { FILTER_MARK, markMatches, rangeOf } from './utils/filter-marks/filter-marks.js';
+export { FILTER_MARK, filterKeeps, markMatches, rangeOf, } from './utils/filter-marks/filter-marks.js';
 export { focusTarget } from './utils/focus-target/focus-target.js';
 export { deepActiveElement, deepContains, focusableElements, PRESSABLE, pressedOwnControl, } from './utils/focusable-elements/focusable-elements.js';
 export { afterLinkFollowed, followLink, } from './utils/follow-link/follow-link.js';

package/dist/utils/filter-marks/filter-marks.d.ts

@@ -34,3 +34,12 @@ export declare const rangeOf: (root: Element, needle: string) => Range[];
  * answer nothing can paint.
  */
 export declare const markMatches: (owner: Element, elements: Iterable<Element>, needle: string) => void;
+/**
+ * Whether a filter keeps an item: its words hold the filter, in any case, or
+ * `match` says so where the page gave one. An empty filter keeps everything.
+ *
+ * One answer for every family that filters, so Listbox, Command and a
+ * filterable Menu keep the same items for the same words, and a `filterMatch`
+ * the page writes once means the same thing in each.
+ */
+export declare const filterKeeps: (text: string, filter: string, match?: ((text: string, filter: string) => boolean) | undefined) => boolean;

package/dist/utils/filter-marks/filter-marks.js

@@ -39,3 +39,4 @@ export const markMatches = (owner, elements, needle) => {
         registry.set(FILTER_MARK, new Highlight(...all));
     }
 };
+export const filterKeeps = (text, filter, match) => filter === '' || (match ? match(text, filter) : text.toLowerCase().includes(filter.toLowerCase()));

package/dist/version.d.ts

@@ -6,4 +6,4 @@
  * release, so the two never disagree; a spec beside this holds them to it.
  * Nothing else in the running code knows which release it is.
  */
-export declare const VERSION = "0.165.0";
+export declare const VERSION = "0.166.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = '0.165.0';
+export const VERSION = '0.166.0';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fusion.dev/helix-core",
   "description": "Helix element primitives: base classes, mixins, decorators, utilities.",
-  "version": "0.165.0",
+  "version": "0.166.0",
   "license": "MIT",
   "author": "Ross Sheppard <ross.sheppard@fusion.dev>",
   "repository": {
@@ -56,11 +56,11 @@
   "bugs": "https://github.com/project-fusion/fusion/issues",
   "dependencies": {
     "@floating-ui/dom": "^1.8.0",
-    "@fusion.dev/helix-icons": "0.165.0"
+    "@fusion.dev/helix-icons": "0.166.0"
   },
   "devDependencies": {
-    "@fusion.dev/helix-cem": "0.165.0",
-    "@fusion.dev/helix-testing": "0.165.0",
+    "@fusion.dev/helix-cem": "0.166.0",
+    "@fusion.dev/helix-testing": "0.166.0",
     "@lit-labs/ssr": "^4.1.0",
     "lit": "^3.2.1"
   },