svelte-multiselect 8.5.0 → 8.6.1

package/dist/CmdPalette.svelte

@@ -10,8 +10,8 @@ export let style = ``; // for dialog
 // for span in option slot, has no effect when passing slot="option"
 export let span_style = ``;
 export let open = false;
-export let dialog;
-export let input;
+export let dialog = null;
+export let input = null;
 export let placeholder = `Filter actions...`;
 async function toggle(event) {
     if (event.key === trigger && event.metaKey && !open) {

package/dist/CmdPalette.svelte.d.ts

@@ -11,8 +11,8 @@ declare const __propDef: {
         style?: string | undefined;
         span_style?: string | undefined;
         open?: boolean | undefined;
-        dialog: HTMLDialogElement;
-        input: HTMLInputElement;
+        dialog?: HTMLDialogElement | null | undefined;
+        input?: HTMLInputElement | null | undefined;
         placeholder?: string | undefined;
     };
     events: {

package/dist/MultiSelect.svelte

@@ -25,6 +25,7 @@ export let filterFunc = (op, searchText) => {
 };
 export let focusInputOnSelect = `desktop`;
 export let form_input = null;
+export let highlightMatches = true;
 export let id = null;
 export let input = null;
 export let inputClass = ``;
@@ -99,13 +100,18 @@ if (parseLabelsAsHtml && allowUserOptions) {
     console.warn(`Don't combine parseLabelsAsHtml and allowUserOptions. It's susceptible to XSS attacks!`);
 }
 if (sortSelected && selectedOptionsDraggable) {
-    console.warn(`MultiSelect's sortSelected and selectedOptionsDraggable should not be combined as any user re-orderings of selected options will be undone by sortSelected on component re-renders.`);
+    console.warn(`MultiSelect's sortSelected and selectedOptionsDraggable should not be combined as any ` +
+        `user re-orderings of selected options will be undone by sortSelected on component re-renders.`);
+}
+if (allowUserOptions && !createOptionMsg) {
+    console.error(`MultiSelect's allowUserOptions=${allowUserOptions} but createOptionMsg=${createOptionMsg} is falsy. ` +
+        `This prevents the "Add option" <span> from showing up, resulting in a confusing user experience.`);
 }
 const dispatch = createEventDispatcher();
-let add_option_msg_is_active = false; // controls active state of <li>{createOptionMsg}</li>
+let option_msg_is_active = false; // controls active state of <li>{createOptionMsg}</li>
 let window_width;
 // options matching the current search text
-$: matchingOptions = options.filter((op) => filterFunc(op, searchText) && !selected.map(get_label).includes(get_label(op)) // remove already selected options from dropdown list
+$: matchingOptions = options.filter((op) => filterFunc(op, searchText) && !selected.includes(op) // remove already selected options from dropdown list
 );
 // raise if matchingOptions[activeIndex] does not yield a value
 if (activeIndex !== null && !matchingOptions[activeIndex]) {
@@ -114,21 +120,21 @@ if (activeIndex !== null && !matchingOptions[activeIndex]) {
 // update activeOption when activeIndex changes
 $: activeOption = matchingOptions[activeIndex ?? -1] ?? null;
 // add an option to selected list
-function add(label, event) {
+function add(option, event) {
     if (maxSelect && maxSelect > 1 && selected.length >= maxSelect)
         wiggle = true;
-    if (!isNaN(Number(label)) && typeof selected.map(get_label)[0] === `number`)
-        label = Number(label); // convert to number if possible
-    const is_duplicate = selected.some((option) => duplicateFunc(option, label));
+    if (!isNaN(Number(option)) && typeof selected.map(get_label)[0] === `number`) {
+        option = Number(option); // convert to number if possible
+    }
+    const is_duplicate = selected.some((op) => duplicateFunc(op, option));
     if ((maxSelect === null || maxSelect === 1 || selected.length < maxSelect) &&
         (duplicates || !is_duplicate)) {
-        // first check if we find option in the options list
-        let option = options.find((op) => get_label(op) === label);
-        if (!option && // this has the side-effect of not allowing to user to add the same
+        if (!options.includes(option) && // first check if we find option in the options list
+            // this has the side-effect of not allowing to user to add the same
             // custom option twice in append mode
             [true, `append`].includes(allowUserOptions) &&
             searchText.length > 0) {
-            // user entered text but no options match, so if allowUserOptions=true | 'append', we create
+            // user entered text but no options match, so if allowUserOptions = true | 'append', we create
             // a new option from the user-entered text
             if (typeof options[0] === `object`) {
                 // if 1st option is an object, we create new option as object to keep type homogeneity
@@ -140,19 +146,18 @@ function add(label, event) {
                     // create new option as number if it parses to a number and 1st option is also number or missing
                     option = Number(searchText);
                 }
-                else
+                else {
                     option = searchText; // else create custom option as string
+                }
+                dispatch(`create`, { option });
             }
             if (allowUserOptions === `append`)
                 options = [...options, option];
         }
-        if (option === undefined) {
-            throw `Run time error, option with label ${label} not found in options list`;
-        }
         if (resetFilterOnAdd)
             searchText = ``; // reset search string on selection
         if ([``, undefined, null].includes(option)) {
-            console.error(`MultiSelect: encountered missing option with label ${label} (or option is poorly labeled)`);
+            console.error(`MultiSelect: encountered falsy option ${option}`);
             return;
         }
         if (maxSelect === 1) {
@@ -199,10 +204,10 @@ function remove(label) {
         return console.error(`Multiselect can't remove selected option ${label}, not found in selected list`);
     }
     selected = selected.filter((op) => get_label(op) !== label); // remove option from selected list
-    dispatch(`remove`, { option });
-    dispatch(`change`, { option, type: `remove` });
     invalid = false; // reset error status whenever items are removed
     form_input?.setCustomValidity(``);
+    dispatch(`remove`, { option });
+    dispatch(`change`, { option, type: `remove` });
 }
 function open_dropdown(event) {
     if (disabled)
@@ -231,8 +236,7 @@ async function handle_keydown(event) {
     else if (event.key === `Enter`) {
         event.preventDefault(); // prevent enter key from triggering form submission
         if (activeOption) {
-            const label = get_label(activeOption);
-            selected.map(get_label).includes(label) ? remove(label) : add(label, event);
+            selected.includes(activeOption) ? remove(activeOption) : add(activeOption, event);
             searchText = ``;
         }
         else if (allowUserOptions && searchText.length > 0) {
@@ -254,7 +258,7 @@ async function handle_keydown(event) {
         else if (allowUserOptions && !matchingOptions.length && searchText.length > 0) {
             // if allowUserOptions is truthy and user entered text but no options match, we make
             // <li>{addUserMsg}</li> active on keydown (or toggle it if already active)
-            add_option_msg_is_active = !add_option_msg_is_active;
+            option_msg_is_active = !option_msg_is_active;
             return;
         }
         else if (activeIndex === null) {
@@ -279,7 +283,7 @@ async function handle_keydown(event) {
     }
     // on backspace key: remove last selected option
     else if (event.key === `Backspace` && selected.length > 0 && !searchText) {
-        remove(selected.map(get_label).at(-1));
+        remove(selected.at(-1));
     }
     // make first matching option active on any keypress (if none of the above special cases match)
     else if (matchingOptions.length > 0) {
@@ -331,6 +335,54 @@ const dragstart = (idx) => (event) => {
     event.dataTransfer.dropEffect = `move`;
     event.dataTransfer.setData(`text/plain`, `${idx}`);
 };
+let ul_options;
+function highlight_matching_options(event) {
+    if (!highlightMatches || typeof CSS == `undefined` || !CSS.highlights)
+        return; // don't try if CSS highlight API not supported
+    // clear previous ranges from HighlightRegistry
+    CSS.highlights.clear();
+    // get input's search query
+    const query = event?.target?.value.trim().toLowerCase();
+    if (!query)
+        return;
+    const tree_walker = document.createTreeWalker(ul_options, NodeFilter.SHOW_TEXT, {
+        acceptNode: (node) => {
+            // don't highlight text in the "no matching options" message
+            if (node?.textContent === noMatchingOptionsMsg)
+                return NodeFilter.FILTER_REJECT;
+            return NodeFilter.FILTER_ACCEPT;
+        },
+    });
+    const text_nodes = [];
+    let current_node = tree_walker.nextNode();
+    while (current_node) {
+        text_nodes.push(current_node);
+        current_node = tree_walker.nextNode();
+    }
+    // iterate over all text nodes and find matches
+    const ranges = text_nodes.map((el) => {
+        const text = el.textContent?.toLowerCase();
+        const indices = [];
+        let start_pos = 0;
+        while (text && start_pos < text.length) {
+            const index = text.indexOf(query, start_pos);
+            if (index === -1)
+                break;
+            indices.push(index);
+            start_pos = index + query.length;
+        }
+        // create range object for each str found in the text node
+        return indices.map((index) => {
+            const range = new Range();
+            range.setStart(el, index);
+            range.setEnd(el, index + query.length);
+            return range;
+        });
+    });
+    // create Highlight object from ranges and add to registry
+    // eslint-disable-next-line no-undef
+    CSS.highlights.set(`sms-search-matches`, new Highlight(...ranges.flat()));
+}
 </script>
 
 <svelte:window
@@ -354,7 +406,7 @@ const dragstart = (idx) => (event) => {
   <input
     {name}
     required={Boolean(required)}
-    value={selected.length >= required ? JSON.stringify(selected) : null}
+    value={selected.length >= Number(required) ? JSON.stringify(selected) : null}
     tabindex="-1"
     aria-hidden="true"
     aria-label="ignore this, used only to prevent form submission if select is required but empty"
@@ -363,9 +415,9 @@ const dragstart = (idx) => (event) => {
     on:invalid={() => {
       invalid = true
       let msg
-      if (maxSelect && maxSelect > 1 && required > 1) {
+      if (maxSelect && maxSelect > 1 && Number(required) > 1) {
         msg = `Please select between ${required} and ${maxSelect} options`
-      } else if (required > 1) {
+      } else if (Number(required) > 1) {
         msg = `Please select at least ${required} options`
       } else {
         msg = `Please select an option`
@@ -376,17 +428,10 @@ const dragstart = (idx) => (event) => {
   <slot name="expand-icon" {open}>
     <ExpandIcon width="15px" style="min-width: 1em; padding: 0 1pt; cursor: pointer;" />
   </slot>
-  <ul
-    class="selected {ulSelectedClass}"
-    role="listbox"
-    aria-multiselectable={maxSelect === null || maxSelect > 1}
-    aria-label="selected options"
-  >
-    {#each selected as option, idx (get_label(option))}
+  <ul class="selected {ulSelectedClass}" aria-label="selected options">
+    {#each selected as option, idx (option)}
       <li
         class={liSelectedClass}
-        role="option"
-        aria-selected="true"
         animate:flip={{ duration: 100 }}
         draggable={selectedOptionsDraggable && !disabled && selected.length > 1}
         on:dragstart={dragstart(idx)}
@@ -404,8 +449,8 @@ const dragstart = (idx) => (event) => {
         </slot>
         {#if !disabled && (minSelect === null || selected.length > minSelect)}
           <button
-            on:mouseup|stopPropagation={() => remove(get_label(option))}
-            on:keydown={if_enter_or_space(() => remove(get_label(option)))}
+            on:mouseup|stopPropagation={() => remove(option)}
+            on:keydown={if_enter_or_space(() => remove(option))}
             type="button"
             title="{removeBtnTitle} {get_label(option)}"
             class="remove"
@@ -425,6 +470,7 @@ const dragstart = (idx) => (event) => {
       on:keydown|stopPropagation={handle_keydown}
       on:focus
       on:focus={open_dropdown}
+      on:input={highlight_matching_options}
       {id}
       {disabled}
       {autocomplete}
@@ -482,14 +528,7 @@ const dragstart = (idx) => (event) => {
 
   <!-- only render options dropdown if options or searchText is not empty needed to avoid briefly flashing empty dropdown -->
   {#if (searchText && noMatchingOptionsMsg) || options?.length > 0}
-    <ul
-      class:hidden={!open}
-      class="options {ulOptionsClass}"
-      role="listbox"
-      aria-multiselectable={maxSelect === null || maxSelect > 1}
-      aria-expanded={open}
-      aria-disabled={disabled ? `true` : null}
-    >
+    <ul class:hidden={!open} class="options {ulOptionsClass}" bind:this={ul_options}>
       {#each matchingOptions as option, idx}
         {@const {
           label,
@@ -502,7 +541,7 @@ const dragstart = (idx) => (event) => {
         <li
           on:mousedown|stopPropagation
           on:mouseup|stopPropagation={(event) => {
-            if (!disabled) add(label, event)
+            if (!disabled) add(option, event)
           }}
           title={disabled
             ? disabledTitle
@@ -519,8 +558,6 @@ const dragstart = (idx) => (event) => {
           }}
           on:mouseout={() => (activeIndex = null)}
           on:blur={() => (activeIndex = null)}
-          role="option"
-          aria-selected="false"
         >
           <slot name="option" {option} {idx}>
             {#if parseLabelsAsHtml}
@@ -531,25 +568,30 @@ const dragstart = (idx) => (event) => {
           </slot>
         </li>
       {:else}
-        {#if allowUserOptions && searchText}
+        {@const search_is_duplicate = selected.some((option) =>
+          duplicateFunc(option, searchText)
+        )}
+        {@const msg =
+          !duplicates && search_is_duplicate ? duplicateOptionMsg : createOptionMsg}
+        {#if allowUserOptions && searchText && msg}
           <li
             on:mousedown|stopPropagation
             on:mouseup|stopPropagation={(event) => add(searchText, event)}
             title={createOptionMsg}
-            class:active={add_option_msg_is_active}
-            on:mouseover={() => (add_option_msg_is_active = true)}
-            on:focus={() => (add_option_msg_is_active = true)}
-            on:mouseout={() => (add_option_msg_is_active = false)}
-            on:blur={() => (add_option_msg_is_active = false)}
-            aria-selected="false"
+            class:active={option_msg_is_active}
+            on:mouseover={() => (option_msg_is_active = true)}
+            on:focus={() => (option_msg_is_active = true)}
+            on:mouseout={() => (option_msg_is_active = false)}
+            on:blur={() => (option_msg_is_active = false)}
+            class="user-msg"
           >
-            {!duplicates && selected.some((option) => duplicateFunc(option, searchText))
-              ? duplicateOptionMsg
-              : createOptionMsg}
+            {msg}
           </li>
-        {:else}
-          <span>{noMatchingOptionsMsg}</span>
+        {:else if noMatchingOptionsMsg}
+          <!-- use span to not have cursor: pointer -->
+          <span class="user-msg">{noMatchingOptionsMsg}</span>
         {/if}
+        <!-- Show nothing if all messages are empty -->
       {/each}
     </ul>
   {/if}
@@ -693,8 +735,9 @@ const dragstart = (idx) => (event) => {
     cursor: pointer;
     scroll-margin: var(--sms-options-scroll-margin, 100px);
   }
-  /* for noOptionsMsg */
-  :where(div.multiselect > ul.options span) {
+  :where(div.multiselect > ul.options .user-msg) {
+    /* block needed so vertical padding applies to span */
+    display: block;
     padding: 3pt 2ex;
   }
   :where(div.multiselect > ul.options > li.selected) {
@@ -713,4 +756,7 @@ const dragstart = (idx) => (event) => {
   :where(span.max-select-msg) {
     padding: 0 3pt;
   }
+  ::highlight(sms-search-matches) {
+    color: mediumaquamarine;
+  }
 </style>

package/dist/MultiSelect.svelte.d.ts

@@ -1,5 +1,5 @@
 import { SvelteComponentTyped } from "svelte";
-import type { MultiSelectEvents, Option as GenericOption } from './';
+import type { Option as GenericOption, MultiSelectEvents } from './';
 declare class __sveltets_Render<Option extends GenericOption> {
     props(): {
         activeIndex?: number | null | undefined;
@@ -19,6 +19,7 @@ declare class __sveltets_Render<Option extends GenericOption> {
         filterFunc?: ((op: Option, searchText: string) => boolean) | undefined;
         focusInputOnSelect?: boolean | "desktop" | undefined;
         form_input?: HTMLInputElement | null | undefined;
+        highlightMatches?: boolean | undefined;
         id?: string | null | undefined;
         input?: HTMLInputElement | null | undefined;
         inputClass?: string | undefined;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { default as CircleSpinner } from './CircleSpinner.svelte';
 export { default as CmdPalette } from './CmdPalette.svelte';
-export { default, default as MultiSelect } from './MultiSelect.svelte';
+export { default as MultiSelect, default } from './MultiSelect.svelte';
 export { default as Wiggle } from './Wiggle.svelte';
 export type Option = string | number | ObjectOption;
 export type ObjectOption = {
@@ -17,6 +17,9 @@ export type DispatchEvents<T = Option> = {
     add: {
         option: T;
     };
+    create: {
+        option: T;
+    };
     remove: {
         option: T;
     };

package/dist/index.js

@@ -1,26 +1,26 @@
 export { default as CircleSpinner } from './CircleSpinner.svelte';
 export { default as CmdPalette } from './CmdPalette.svelte';
-export { default, default as MultiSelect } from './MultiSelect.svelte';
+export { default as MultiSelect, default } from './MultiSelect.svelte';
 export { default as Wiggle } from './Wiggle.svelte';
-// Firefox lacks support for scrollIntoViewIfNeeded, see
-// https://github.com/janosh/svelte-multiselect/issues/87
-// this polyfill was copied from
+// Firefox lacks support for scrollIntoViewIfNeeded (https://caniuse.com/scrollintoviewifneeded).
+// See https://github.com/janosh/svelte-multiselect/issues/87
+// Polyfill copied from
 // https://github.com/nuxodin/lazyfill/blob/a8e63/polyfills/Element/prototype/scrollIntoViewIfNeeded.js
 // exported for testing
 export function scroll_into_view_if_needed_polyfill(centerIfNeeded = true) {
-    const el = this;
+    const elem = this;
     const observer = new IntersectionObserver(function ([entry]) {
         const ratio = entry.intersectionRatio;
         if (ratio < 1) {
             const place = ratio <= 0 && centerIfNeeded ? `center` : `nearest`;
-            el.scrollIntoView({
+            elem.scrollIntoView({
                 block: place,
                 inline: place,
             });
         }
         this.disconnect();
     });
-    observer.observe(this);
+    observer.observe(elem);
     return observer; // return for testing
 }
 if (typeof Element !== `undefined` &&

package/package.json

@@ -5,7 +5,7 @@
   "homepage": "https://janosh.github.io/svelte-multiselect",
   "repository": "https://github.com/janosh/svelte-multiselect",
   "license": "MIT",
-  "version": "8.5.0",
+  "version": "8.6.1",
   "type": "module",
   "svelte": "./dist/index.js",
   "bugs": "https://github.com/janosh/svelte-multiselect/issues",
@@ -23,37 +23,37 @@
     "update-coverage": "vitest tests/unit --run --coverage && npx istanbul-badges-readme"
   },
   "dependencies": {
-    "svelte": "^3.56.0"
+    "svelte": "^3.58.0"
   },
   "devDependencies": {
-    "@iconify/svelte": "^3.1.0",
-    "@playwright/test": "^1.31.2",
-    "@sveltejs/adapter-static": "^2.0.1",
-    "@sveltejs/kit": "^1.11.0",
+    "@iconify/svelte": "^3.1.3",
+    "@playwright/test": "^1.33.0",
+    "@sveltejs/adapter-static": "^2.0.2",
+    "@sveltejs/kit": "^1.15.9",
     "@sveltejs/package": "2.0.2",
-    "@sveltejs/vite-plugin-svelte": "^2.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.54.1",
-    "@typescript-eslint/parser": "^5.54.1",
-    "@vitest/coverage-c8": "^0.29.2",
-    "eslint": "^8.35.0",
+    "@sveltejs/vite-plugin-svelte": "^2.1.1",
+    "@typescript-eslint/eslint-plugin": "^5.59.1",
+    "@typescript-eslint/parser": "^5.59.1",
+    "@vitest/coverage-c8": "^0.30.1",
+    "eslint": "^8.39.0",
     "eslint-plugin-svelte3": "^4.0.0",
     "hastscript": "^7.2.0",
-    "highlight.js": "^11.7.0",
-    "jsdom": "^21.1.0",
+    "highlight.js": "^11.8.0",
+    "jsdom": "^21.1.1",
     "mdsvex": "^0.10.6",
     "mdsvexamples": "^0.3.3",
-    "prettier": "^2.8.4",
-    "prettier-plugin-svelte": "^2.9.0",
+    "prettier": "^2.8.8",
+    "prettier-plugin-svelte": "^2.10.0",
     "rehype-autolink-headings": "^6.1.1",
     "rehype-slug": "^5.1.0",
-    "svelte-check": "^3.1.0",
-    "svelte-preprocess": "^5.0.1",
-    "svelte-toc": "^0.5.2",
-    "svelte-zoo": "^0.3.4",
-    "svelte2tsx": "^0.6.3",
-    "typescript": "^4.9.5",
-    "vite": "^4.1.4",
-    "vitest": "^0.29.2"
+    "svelte-check": "^3.2.0",
+    "svelte-preprocess": "^5.0.3",
+    "svelte-toc": "^0.5.5",
+    "svelte-zoo": "^0.4.5",
+    "svelte2tsx": "^0.6.11",
+    "typescript": "5.0.4",
+    "vite": "^4.3.3",
+    "vitest": "^0.30.1"
   },
   "keywords": [
     "svelte",

package/readme.md

@@ -185,6 +185,12 @@ Full list of props/bindable variables for this component. The `Option` type you
 
    Handle to the `<input>` DOM node that's responsible for form validity checks and passing selected options to form submission handlers. Only available after component mounts (`null` before then).
 
+1. ```ts
+   highlightMatches: boolean = true
+   ```
+
+   Whether to highlight text in the dropdown options that matches the current user-entered search query. Uses the [CSS Custom Highlight API](https://developer.mozilla.org/docs/Web/API/CSS_Custom_Highlight_API) with limited browser support and [styling options](https://developer.mozilla.org/docs/Web/CSS/::highlight). See `::highlight(sms-search-matches)` below for available CSS variables.
+
 1. ```ts
    id: string | null = null
    ```
@@ -500,6 +506,12 @@ There are 3 ways to style this component. To understand which options do what, i
 
 If you only want to make small adjustments, you can pass the following CSS variables directly to the component as props or define them in a `:global()` CSS context. See [`app.css`](https://github.com/janosh/svelte-multiselect/blob/main/src/app.css) for how these variables are set on the demo site of this component.
 
+Minimal example that changes the background color of the options dropdown:
+
+```svelte
+<MultiSelect --sms-options-bg="white" />
+```
+
 - `div.multiselect`
   - `border: var(--sms-border, 1pt solid lightgray)`: Change this to e.g. to `1px solid red` to indicate this form field is in an invalid state.
   - `border-radius: var(--sms-border-radius, 3pt)`
@@ -514,7 +526,7 @@ If you only want to make small adjustments, you can pass the following CSS varia
 - `div.multiselect.open`
   - `z-index: var(--sms-open-z-index, 4)`: Increase this if needed to ensure the dropdown list is displayed atop all other page elements.
 - `div.multiselect:focus-within`
-  - `border: var(--sms-focus-border, 1pt solid var(--sms-active-color, cornflowerblue))`: Border when component has focus. Defaults to `--sms-active-color` if not set which defaults to `cornflowerblue`.
+  - `border: var(--sms-focus-border, 1pt solid var(--sms-active-color, cornflowerblue))`: Border when component has focus. Defaults to `--sms-active-color` which in turn defaults to `cornflowerblue`.
 - `div.multiselect.disabled`
   - `background: var(--sms-disabled-bg, lightgray)`: Background when in disabled state.
 - `div.multiselect input::placeholder`
@@ -547,12 +559,15 @@ If you only want to make small adjustments, you can pass the following CSS varia
 - `div.multiselect > ul.options > li.disabled`
   - `background: var(--sms-li-disabled-bg, #f5f5f6)`: Background of disabled options in the dropdown list.
   - `color: var(--sms-li-disabled-text, #b8b8b8)`: Text color of disabled option in the dropdown list.
-
-For example, to change the background color of the options dropdown:
-
-```svelte
-<MultiSelect --sms-options-bg="white" />
-```
+- `::highlight(sms-search-matches)`: applies to search results in dropdown list that match the current search query if `highlightMatches=true`. These styles [cannot be set via CSS variables](https://stackoverflow.com/a/56799215). Instead, use a new rule set. For example:
+
+  ```css
+  ::highlight(sms-search-matches) {
+    color: orange;
+    background: rgba(0, 0, 0, 0.15);
+    text-decoration: underline;
+  }
+  ```
 
 ### With CSS frameworks