svelte-multiselect 8.6.1 → 8.6.2

package/dist/MultiSelect.svelte

@@ -1,6 +1,7 @@
 <script>import { createEventDispatcher, tick } from 'svelte';
 import { flip } from 'svelte/animate';
-import { CircleSpinner, Wiggle } from '.';
+import CircleSpinner from './CircleSpinner.svelte';
+import Wiggle from './Wiggle.svelte';
 import { CrossIcon, DisabledIcon, ExpandIcon } from './icons';
 export let activeIndex = null;
 export let activeOption = null;
@@ -63,7 +64,7 @@ export let ulOptionsClass = ``;
 export let ulSelectedClass = ``;
 export let value = null;
 // get the label key from an option object or the option itself if it's a string or number
-const get_label = (op) => {
+export const get_label = (op) => {
     if (op instanceof Object) {
         if (op.label === undefined) {
             console.error(`MultiSelect option ${JSON.stringify(op)} is an object but has no label key`);
@@ -103,8 +104,8 @@ 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.`);
 }
-if (allowUserOptions && !createOptionMsg) {
-    console.error(`MultiSelect's allowUserOptions=${allowUserOptions} but createOptionMsg=${createOptionMsg} is falsy. ` +
+if (allowUserOptions && !createOptionMsg && createOptionMsg !== null) {
+    console.error(`MultiSelect has 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();
@@ -190,20 +191,22 @@ function add(option, event) {
     }
 }
 // remove an option from selected list
-function remove(label) {
+function remove(to_remove) {
     if (selected.length === 0)
         return;
-    let option = selected.find((op) => get_label(op) === label);
+    const idx = selected.findIndex((op) => JSON.stringify(op) === JSON.stringify(to_remove));
+    let [option] = selected.splice(idx, 1); // remove option from selected list
     if (option === undefined && allowUserOptions) {
         // if option with label could not be found but allowUserOptions is truthy,
         // assume it was created by user and create corresponding option object
         // on the fly for use as event payload
-        option = (typeof options[0] == `object` ? { label } : label);
+        const other_ops_type = typeof options[0];
+        option = (other_ops_type ? { label: to_remove } : to_remove);
     }
     if (option === undefined) {
-        return console.error(`Multiselect can't remove selected option ${label}, not found in selected list`);
+        return console.error(`Multiselect can't remove selected option ${JSON.stringify(to_remove)}, not found in selected list`);
     }
-    selected = selected.filter((op) => get_label(op) !== label); // remove option from selected list
+    selected = [...selected]; // trigger Svelte rerender
     invalid = false; // reset error status whenever items are removed
     form_input?.setCustomValidity(``);
     dispatch(`remove`, { option });

package/dist/MultiSelect.svelte.d.ts

@@ -1,10 +1,10 @@
 import { SvelteComponentTyped } from "svelte";
-import type { Option as GenericOption, MultiSelectEvents } from './';
-declare class __sveltets_Render<Option extends GenericOption> {
+import type { MultiSelectEvents, Option as T } from './types';
+declare class __sveltets_Render<Option extends T> {
     props(): {
         activeIndex?: number | null | undefined;
         activeOption?: Option | null | undefined;
-        createOptionMsg?: string | undefined;
+        createOptionMsg?: string | null | undefined;
         allowUserOptions?: boolean | "append" | undefined;
         allowEmpty?: boolean | undefined;
         autocomplete?: string | undefined;
@@ -13,7 +13,7 @@ declare class __sveltets_Render<Option extends GenericOption> {
         defaultDisabledTitle?: string | undefined;
         disabled?: boolean | undefined;
         disabledInputTitle?: string | undefined;
-        duplicateFunc?: ((op1: GenericOption, op2: GenericOption) => boolean) | undefined;
+        duplicateFunc?: ((op1: T, op2: T) => boolean) | undefined;
         duplicateOptionMsg?: string | undefined;
         duplicates?: boolean | undefined;
         filterFunc?: ((op: Option, searchText: string) => boolean) | undefined;
@@ -54,6 +54,7 @@ declare class __sveltets_Render<Option extends GenericOption> {
         ulOptionsClass?: string | undefined;
         ulSelectedClass?: string | undefined;
         value?: Option | Option[] | null | undefined;
+        get_label?: ((op: T) => string | number) | undefined;
     };
     events(): MultiSelectEvents;
     slots(): {
@@ -73,9 +74,10 @@ declare class __sveltets_Render<Option extends GenericOption> {
         };
     };
 }
-export type MultiSelectProps<Option extends GenericOption> = ReturnType<__sveltets_Render<Option>['props']>;
-export type MultiSelectEvents<Option extends GenericOption> = ReturnType<__sveltets_Render<Option>['events']>;
-export type MultiSelectSlots<Option extends GenericOption> = ReturnType<__sveltets_Render<Option>['slots']>;
-export default class MultiSelect<Option extends GenericOption> extends SvelteComponentTyped<MultiSelectProps<Option>, MultiSelectEvents<Option>, MultiSelectSlots<Option>> {
+export type MultiSelectProps<Option extends T> = ReturnType<__sveltets_Render<Option>['props']>;
+export type MultiSelectEvents<Option extends T> = ReturnType<__sveltets_Render<Option>['events']>;
+export type MultiSelectSlots<Option extends T> = ReturnType<__sveltets_Render<Option>['slots']>;
+export default class MultiSelect<Option extends T> extends SvelteComponentTyped<MultiSelectProps<Option>, MultiSelectEvents<Option>, MultiSelectSlots<Option>> {
+    get get_label(): (op: T) => string | number;
 }
 export {};

package/dist/index.d.ts

@@ -2,55 +2,5 @@ export { default as CircleSpinner } from './CircleSpinner.svelte';
 export { default as CmdPalette } from './CmdPalette.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 = {
-    label: string | number;
-    value?: unknown;
-    title?: string;
-    disabled?: boolean;
-    preselected?: boolean;
-    disabledTitle?: string;
-    selectedTitle?: string;
-    [key: string]: unknown;
-};
-export type DispatchEvents<T = Option> = {
-    add: {
-        option: T;
-    };
-    create: {
-        option: T;
-    };
-    remove: {
-        option: T;
-    };
-    removeAll: {
-        options: T[];
-    };
-    change: {
-        option?: T;
-        options?: T[];
-        type: 'add' | 'remove' | 'removeAll';
-    };
-    open: {
-        event: Event;
-    };
-    close: {
-        event: Event;
-    };
-};
-export type MultiSelectEvents = {
-    [key in keyof DispatchEvents]: CustomEvent<DispatchEvents[key]>;
-} & {
-    blur: FocusEvent;
-    click: MouseEvent;
-    focus: FocusEvent;
-    keydown: KeyboardEvent;
-    keyup: KeyboardEvent;
-    mouseenter: MouseEvent;
-    mouseleave: MouseEvent;
-    touchcancel: TouchEvent;
-    touchend: TouchEvent;
-    touchmove: TouchEvent;
-    touchstart: TouchEvent;
-};
+export * from './types';
 export declare function scroll_into_view_if_needed_polyfill(centerIfNeeded?: boolean): IntersectionObserver;

package/dist/index.js

@@ -2,6 +2,7 @@ export { default as CircleSpinner } from './CircleSpinner.svelte';
 export { default as CmdPalette } from './CmdPalette.svelte';
 export { default as MultiSelect, default } from './MultiSelect.svelte';
 export { default as Wiggle } from './Wiggle.svelte';
+export * from './types';
 // Firefox lacks support for scrollIntoViewIfNeeded (https://caniuse.com/scrollintoviewifneeded).
 // See https://github.com/janosh/svelte-multiselect/issues/87
 // Polyfill copied from

package/dist/types.d.ts

@@ -0,0 +1,51 @@
+export type Option = string | number | ObjectOption;
+export type ObjectOption = {
+    label: string | number;
+    value?: unknown;
+    title?: string;
+    disabled?: boolean;
+    preselected?: boolean;
+    disabledTitle?: string;
+    selectedTitle?: string;
+    [key: string]: unknown;
+};
+export type DispatchEvents<T = Option> = {
+    add: {
+        option: T;
+    };
+    create: {
+        option: T;
+    };
+    remove: {
+        option: T;
+    };
+    removeAll: {
+        options: T[];
+    };
+    change: {
+        option?: T;
+        options?: T[];
+        type: 'add' | 'remove' | 'removeAll';
+    };
+    open: {
+        event: Event;
+    };
+    close: {
+        event: Event;
+    };
+};
+export type MultiSelectEvents = {
+    [key in keyof DispatchEvents]: CustomEvent<DispatchEvents[key]>;
+} & {
+    blur: FocusEvent;
+    click: MouseEvent;
+    focus: FocusEvent;
+    keydown: KeyboardEvent;
+    keyup: KeyboardEvent;
+    mouseenter: MouseEvent;
+    mouseleave: MouseEvent;
+    touchcancel: TouchEvent;
+    touchend: TouchEvent;
+    touchmove: TouchEvent;
+    touchstart: TouchEvent;
+};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

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.6.1",
+  "version": "8.6.2",
   "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.58.0"
+    "svelte": "^3.59.1"
   },
   "devDependencies": {
     "@iconify/svelte": "^3.1.3",
     "@playwright/test": "^1.33.0",
     "@sveltejs/adapter-static": "^2.0.2",
-    "@sveltejs/kit": "^1.15.9",
+    "@sveltejs/kit": "^1.16.3",
     "@sveltejs/package": "2.0.2",
-    "@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",
+    "@sveltejs/vite-plugin-svelte": "^2.2.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
+    "@vitest/coverage-c8": "^0.31.0",
+    "eslint": "^8.40.0",
     "eslint-plugin-svelte3": "^4.0.0",
     "hastscript": "^7.2.0",
     "highlight.js": "^11.8.0",
-    "jsdom": "^21.1.1",
+    "jsdom": "^22.0.0",
     "mdsvex": "^0.10.6",
     "mdsvexamples": "^0.3.3",
     "prettier": "^2.8.8",
     "prettier-plugin-svelte": "^2.10.0",
     "rehype-autolink-headings": "^6.1.1",
     "rehype-slug": "^5.1.0",
-    "svelte-check": "^3.2.0",
+    "svelte-check": "^3.3.2",
     "svelte-preprocess": "^5.0.3",
     "svelte-toc": "^0.5.5",
     "svelte-zoo": "^0.4.5",
-    "svelte2tsx": "^0.6.11",
+    "svelte2tsx": "^0.6.14",
     "typescript": "5.0.4",
-    "vite": "^4.3.3",
-    "vitest": "^0.30.1"
+    "vite": "^4.3.6",
+    "vitest": "^0.31.0"
   },
   "keywords": [
     "svelte",

package/readme.md

@@ -51,7 +51,7 @@
 
 ```sh
 npm install --dev svelte-multiselect
-pnpm add --dev svelte-multiselect
+pnpm add -D svelte-multiselect
 yarn add --dev svelte-multiselect
 ```
 
@@ -90,10 +90,10 @@ Full list of props/bindable variables for this component. The `Option` type you
    Currently active option, i.e. the one the user currently hovers or navigated to with arrow keys.
 
 1. ```ts
-   createOptionMsg: string = `Create this option...`
+   createOptionMsg: string | null = `Create this option...`
    ```
 
-   Message shown to users after entering text when no options match their query and `allowUserOptions` is truthy.
+   The message shown to users when `allowUserOptions` is truthy and they entered text that doesn't match any existing options to suggest creating a new option from the entered text. Emits `console.error` if `allowUserOptions` is `true` or `'append'` and `createOptionMsg=''` to since users might be unaware they can create new option. The error can be silenced by setting `createOptionMsg=null` indicating developer intent is to e.g. use MultiSelect as a tagging component where a user message might be unwanted.
 
 1. ```ts
    allowEmpty: boolean = false
@@ -146,7 +146,7 @@ Full list of props/bindable variables for this component. The `Option` type you
 
 <!-- prettier-ignore -->
 1. ```ts
-   duplicateFunc: (op1: GenericOption, op2: GenericOption) => boolean = (op1, op2) =>
+   duplicateFunc: (op1: T, op2: T) => boolean = (op1, op2) =>
     `${get_label(op1)}`.toLowerCase() === `${get_label(op2)}`.toLowerCase()
    ```