svelte-multiselect 3.1.0 → 3.1.1

package/MultiSelect.svelte

@@ -2,6 +2,7 @@
 import { fly } from 'svelte/transition';
 import { onClickOutside } from './actions';
 import { CrossIcon, ExpandIcon, ReadOnlyIcon } from './icons';
+import Wiggle from './Wiggle.svelte';
 export let selected = [];
 export let selectedLabels = [];
 export let selectedValues = [];
@@ -34,6 +35,7 @@ if (!Array.isArray(selected))
 onMount(() => {
     selected = _options.filter((op) => op?.preselected);
 });
+let wiggle = false;
 function isObject(item) {
     return typeof item === `object` && !Array.isArray(item) && item !== null;
 }
@@ -79,6 +81,8 @@ $: if (
     // make the first filtered option active
     activeOption = matchingEnabledOptions[0];
 function add(label) {
+    if (selected.length - (maxSelect ?? 0) < 1)
+        wiggle = true;
     if (!readonly &&
         !selectedLabels.includes(label) &&
         // for maxselect = 1 we always replace current option with new selection
@@ -209,7 +213,7 @@ display above those of another following shortly after it -->
   <ul class="selected {ulSelectedClass}">
     {#each selected as option, idx}
       <li class={liSelectedClass}>
-        <slot name="selectedRenderer" {option} {idx}>
+        <slot name="renderSelected" {option} {idx}>
           {option.label}
         </slot>
         {#if !readonly}
@@ -239,7 +243,9 @@ display above those of another following shortly after it -->
     <ReadOnlyIcon height="14pt" />
   {:else if selected.length > 0}
     {#if maxSelect !== null && maxSelect > 1}
-      <span style="padding: 0 3pt;">{maxSelectMsg(selected.length, maxSelect)}</span>
+      <Wiggle bind:wiggle angle={20}>
+        <span style="padding: 0 3pt;">{maxSelectMsg(selected.length, maxSelect)}</span>
+      </Wiggle>
     {/if}
     <button
       type="button"
@@ -273,7 +279,7 @@ display above those of another following shortly after it -->
           title={disabled ? disabledTitle : (isSelected(label) && selectedTitle) || title}
           class={liOptionClass}
         >
-          <slot name="optionRenderer" {option} {idx}>
+          <slot name="renderOptions" {option} {idx}>
             {option.label}
           </slot>
         </li>
@@ -285,21 +291,23 @@ display above those of another following shortly after it -->
 </div>
 
 <style>
-  :where(.multiselect) {
+  :where(div.multiselect) {
     position: relative;
     margin: 1em 0;
     border: var(--sms-border, 1pt solid lightgray);
     border-radius: var(--sms-border-radius, 5pt);
+    background: var(--sms-input-bg);
+    height: var(--sms-input-height, 2em);
     align-items: center;
     min-height: 18pt;
     display: flex;
     cursor: text;
     padding: 0 3pt;
   }
-  :where(.multiselect:focus-within) {
+  :where(div.multiselect:focus-within) {
     border: var(--sms-focus-border, 1pt solid var(--sms-active-color, cornflowerblue));
   }
-  :where(.multiselect.readonly) {
+  :where(div.multiselect.readonly) {
     background: var(--sms-readonly-bg, lightgray);
   }
 
@@ -329,15 +337,14 @@ display above those of another following shortly after it -->
     outline: none;
     padding: 0 2pt;
   }
-  :where(ul.selected > li button:hover, button.remove-all:hover) {
+  :where(ul.selected > li button:hover, button.remove-all:hover, button:focus) {
     color: var(--sms-remove-x-hover-focus-color, lightskyblue);
   }
   :where(button:focus) {
-    color: var(--sms-remove-x-hover-focus-color, lightskyblue);
     transform: scale(1.04);
   }
 
-  :where(.multiselect input) {
+  :where(div.multiselect input) {
     border: none;
     outline: none;
     background: none;

package/MultiSelect.svelte.d.ts

@@ -30,11 +30,11 @@ declare const __propDef: {
         [evt: string]: CustomEvent<any>;
     };
     slots: {
-        selectedRenderer: {
+        renderSelected: {
             option: Option;
             idx: any;
         };
-        optionRenderer: {
+        renderOptions: {
             option: Option;
             idx: any;
         };

package/Wiggle.svelte

@@ -0,0 +1,24 @@
+<script >import { spring } from 'svelte/motion';
+// bind to this state and set it to true from parent
+export let wiggle = false;
+// intended use case: set max value during wiggle for one of angle, scale, dx, dy through props
+export let angle = 0; // try 20
+export let scale = 1; // try 1.2
+export let dx = 0; // try 10
+export let dy = 0; // try 10
+export let duration = 200;
+export let stiffness = 0.05;
+export let damping = 0.1;
+let restState = { angle: 0, scale: 1, dx: 0, dy: 0 };
+let store = spring(restState, { stiffness, damping });
+$: store.set(wiggle ? { scale, angle, dx, dy } : restState);
+$: if (wiggle)
+    setTimeout(() => (wiggle = false), duration);
+</script>
+
+<span
+  style:transform="rotate({$store.angle}deg) scale({$store.scale}) translate({$store.dx}px,
+  {$store.dy}px)"
+>
+  <slot />
+</span>

package/Wiggle.svelte.d.ts

@@ -0,0 +1,25 @@
+import { SvelteComponentTyped } from "svelte";
+declare const __propDef: {
+    props: {
+        wiggle?: boolean | undefined;
+        angle?: number | undefined;
+        scale?: number | undefined;
+        dx?: number | undefined;
+        dy?: number | undefined;
+        duration?: number | undefined;
+        stiffness?: number | undefined;
+        damping?: number | undefined;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {
+        default: {};
+    };
+};
+export declare type WiggleProps = typeof __propDef.props;
+export declare type WiggleEvents = typeof __propDef.events;
+export declare type WiggleSlots = typeof __propDef.slots;
+export default class Wiggle extends SvelteComponentTyped<WiggleProps, WiggleEvents, WiggleSlots> {
+}
+export {};

package/actions.js

@@ -14,26 +14,3 @@ export function onClickOutside(node, cb) {
         },
     };
 }
-// import { spring } from 'svelte/motion'
-// export default function boop(node: HTMLElement, params = {}) {
-//   const { setter } = params
-//   const springyRotation = spring(
-//     { x: 0, y: 0, rotation: 0, scale: 1 },
-//     { stiffness: 0.1, damping: 0.15 }
-//   )
-//   node.style.display = `inline-block`
-//   const unsubscribe = springyRotation.subscribe(({ x, y, rotation, scale }) => {
-//     node.style.transform = `translate(${x}px, ${y}px) rotate(${rotation}deg) scale(${scale})`
-//   })
-//   return {
-//     update({ isBooped: x = 0, y = 0, rotation = 0, scale = 1, timing }) {
-//       springyRotation.set(
-//         isBooped
-//           ? { x, y, rotation, scale }
-//           : { x: 0, y: 0, rotation: 0, scale: 1 }
-//       )
-//       if (isBooped) window.setTimeout(() => setter(false), timing)
-//     },
-//     destroy: unsubscribe,
-//   }
-// }

package/package.json

@@ -5,7 +5,7 @@
   "homepage": "https://svelte-multiselect.netlify.app",
   "repository": "https://github.com/janosh/svelte-multiselect",
   "license": "MIT",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "type": "module",
   "svelte": "index.js",
   "bugs": "https://github.com/janosh/svelte-multiselect/issues",

package/readme.md

@@ -26,7 +26,7 @@
 - **Single / multiple select:** pass `maxSelect={1}` prop to only allow one selection
 - **Dropdowns:** scrollable lists for large numbers of options
 - **Searchable:** start typing to filter options
-- **Tagging:** selected options are recorded as tags within the text input
+- **Tagging:** selected options are recorded as tags in the input
 - **Server-side rendering:** no reliance on browser objects like `window` or `document`
 - **Configurable:** see [props](#props)
 - **No dependencies:** needs only Svelte as dev dependency
@@ -34,7 +34,7 @@
 
 ## Recent breaking changes
 
-- v2.0.0 added the ability to pass options as objects. As a result, `bind:selected` no longer returns simple strings but objects as well, even if you still pass in `options` as strings.
+- v2.0.0 added the ability to pass options as objects. As a result, `bind:selected` no longer returns simple strings but objects, even if you still pass in `options` as strings. To get the same stuff you would have gotten from `bind:selected` before, there's now `bind:selectedLabels` (and `bind:selectedValues`).
 - v3.0.0 changed the `event.detail` payload for `'add'`, `'remove'` and `'change'` events from `token` to `option`, e.g.
 
   ```js
@@ -108,19 +108,22 @@ Full list of props/bindable variables for this component:
 
 `MultiSelect.svelte` accepts two named slots
 
-- `slot="optionRenderer"`
-- `slot="selectedRenderer"`
+- `slot="renderOptions"`
+- `slot="renderSelected"`
 
 to customize rendering individual options in the dropdown and the list of selected tags, respectively. Each renderer receives the full `option` object along with the zero-indexed position (`idx`) in its list, both available via the `let:` directive:
 
 ```svelte
-<MultiSelect options={[`Banana`, `Watermelon`, `Apple`, `Dates`, `Mango`]}>
-  <span let:idx let:option slot="optionRenderer">
-    {idx + 1}. {option.label} {option.label === `Mango` ? `🎉` : ``}</span
-  >
-  <span let:idx let:option slot="selectedRenderer">
-    #️⃣ {idx + 1} {option.label}</span
-  >
+<MultiSelect options={[`Banana`, `Apple`, `Mango`]}>
+  <span let:idx let:option slot="renderOptions">
+    {idx + 1}. {option.label}
+    {option.label === `Mango` ? `🎉` : ``}
+  </span>
+
+  <span let:idx let:option slot="renderSelected">
+    #{idx + 1}
+    {option.label}
+  </span>
 </MultiSelect>
 ```
 
@@ -152,7 +155,7 @@ to customize rendering individual options in the dropdown and the list of select
 
 ## TypeScript
 
-TypeScript users can import the types used for internal type safety for external use as well:
+TypeScript users can import the types used for internal type safety:
 
 ```svelte
 <script lang="ts">
@@ -171,26 +174,48 @@ TypeScript users can import the types used for internal type safety for external
 
 ## Styling
 
-There are 3 ways to style this component.
+There are 3 ways to style this component. To understand which options do what, it helps to keep in mind this simplified DOM structure of the component:
+
+```svelte
+<div class="multiselect">
+  <ul class="selected">
+    <li>Selected 1</li>
+    <li>Selected 2</li>
+  </ul>
+  <ul class="options">
+    <li>Option 1</li>
+    <li>Option 2</li>
+  </ul>
+</div>
+```
 
 ### With CSS variables
 
-The first, if you only want to make small adjustments, allows you to pass the following CSS variables directly to the component as props.
-
-- `border: var(--sms-border, 1pt solid lightgray)`: Border around top-level `div.multiselect`. 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, 5pt)`: `div.multiselect` border radius.
-- `color: var(--sms-text-color, inherit)`: Input text color.
-- `border: var(--sms-focus-border, 1pt solid var(--sms-active-color, cornflowerblue))`: `div.multiselect` border when focused. Falls back to `--sms-active-color` if not set which in turn falls back on `cornflowerblue`.
-- `background: var(--sms-readonly-bg, lightgray)`: Background when in readonly state.
-- `background: var(--sms-selected-bg, var(--sms-active-color, cornflowerblue))`: Background of selected options.
-- `color: var(--sms-remove-x-hover+focus-color, lightgray)`: Hover color of cross icon to remove selected options.
-- `color: var(--sms-remove-x-hover-focus-color, lightskyblue)`: Color of the cross-icon buttons for removing all or individual selected options when in `:focus` or `:hover` state.
-- `background: var(--sms-options-bg, white)`: Background of options list.
-- `background: var(--sms-li-selected-bg, inherit)`: Background of selected list items in options pane.
-- `color: var(--sms-li-selected-color, inherit)`: Text color of selected list items in options pane.
-- `background: var(--sms-li-active-bg, var(--sms-active-color, cornflowerblue))`: Background of active (currently with arrow keys highlighted) list item.
-- `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.
+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.
+
+- `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, 5pt)`: Input border radius.
+  - `background: var(--sms-input-bg)`: Input background.
+  - `height: var(--sms-input-height, 2em)`: Input height.
+  - `border: var(--sms-focus-border, 1pt solid var(--sms-active-color, cornflowerblue))`: Border when focused. Falls back to `--sms-active-color` if not set which in turn falls back on `cornflowerblue`.
+  - `background: var(--sms-readonly-bg, lightgray)`: Background when in readonly state.
+- `div.multiselect input`
+  - `color: var(--sms-text-color, inherit)`: Input text color.
+- `ul.selected > li`:
+  - `background: var(--sms-selected-bg, var(--sms-active-color, cornflowerblue))`: Background of selected options.
+- `ul.selected > li button:hover, button.remove-all:hover`
+  - `color: var(--sms-remove-x-hover-focus-color, lightskyblue)`: Color of the cross-icon buttons for removing all or individual selected options when in `:focus` or `:hover` state.
+- `ul.options`
+  - `background: var(--sms-options-bg, white)`: Background of options list.
+- `ul.options > li.selected`
+  - `background: var(--sms-li-selected-bg, inherit)`: Background of selected list items in options pane.
+  - `color: var(--sms-li-selected-color, inherit)`: Text color of selected list items in options pane.
+- `ul.options > li.active`
+  - `background: var(--sms-li-active-bg, var(--sms-active-color, cornflowerblue))`: Background of active (currently with arrow keys highlighted) list item.
+- `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:
 
@@ -211,14 +236,14 @@ The second method allows you to pass in custom classes to the important DOM elem
 This simplified version of the DOM structure of this component shows where these classes are inserted:
 
 ```svelte
-<div class={outerDivClass}>
-  <ul class={ulSelectedClass}>
-    <li class={liSelectedClass}>First selected tag</li>
-    <li class={liSelectedClass}>Second selected tag</li>
+<div class="multiselect {outerDivClass}">
+  <ul class="selected {ulSelectedClass}">
+    <li class={liSelectedClass}>Selected 1</li>
+    <li class={liSelectedClass}>Selected 2</li>
   </ul>
-  <ul class={ulOptionsClass}>
-    <li class={liOptionClass}>First available option</li>
-    <li class={liOptionClass}>Second available option</li>
+  <ul class="options {ulOptionsClass}">
+    <li class={liOptionClass}>Option 1</li>
+    <li class={liOptionClass}>Option 2</li>
   </ul>
 </div>
 ```