@kws3/ui 1.7.4 → 1.8.0

package/CHANGELOG.mdx

@@ -1,3 +1,9 @@
+## 1.8.0
+ - `Modal`, `CardModal` and `ActionSheet` components now play an outro transition instead of abruptly disappearing.
+ - Usability fixes for `SearchableSelect` and `MultiSelect`.
+ - `SearchableSelect` and `MultiSelect` now support loading options via an async function.
+ - `SearchableSelect` and `MultiSelect` now match results using a fuzzy `search_strategy`. This can be changed to old behaviour by specifying `search_strategy="strict"`.
+
 ## 1.7.4
  - Update ApexCharts to version 3.33.2
  - Added support for subscribing to chart events

package/buttons/ConfirmButton.svelte

@@ -28,7 +28,6 @@
   <p class="control">
     {#if _confirm}
       <button
-        role="button"
         class="button is-success is-light is-shadowless is-{size} {button_class}"
         type="button"
         on:click|preventDefault|stopPropagation={cancel}>
@@ -38,7 +37,6 @@
   </p>
   <p class="control is-expanded">
     <button
-      role="button"
       class="button is-{size} {_doing
         ? main_color + ' is-loading'
         : _error

package/controls/NumberInput.svelte

@@ -28,7 +28,6 @@ This will be overridden if `min` is higher, or `max` is lower, Default: `0`
 <div class="field has-addons">
   <div class="control">
     <button
-      role="button"
       type="button"
       class="button is-{size} is-{minus_button_color}"
       style="box-shadow:none;"
@@ -58,7 +57,6 @@ This will be overridden if `min` is higher, or `max` is lower, Default: `0`
   </div>
   <div class="control">
     <button
-      role="button"
       type="button"
       class="button is-{size} is-{plus_button_color}"
       style="box-shadow:none;"

package/forms/select/MultiSelect.svelte

@@ -16,6 +16,12 @@ Used to populate the list of options in the dropdown, Default: `[]`
 this property of each object will be searched, Default: `"name"`
   @param {string} [value_key="id"] - If `options` is an array of objects,
 this property of each object will be returned as the value, Default: `"id"`
+  @param {function|null} [search=null] - Async function to fetch options
+
+Only send this prop if you want to fetch `options` asynchronously.
+`options` prop will be ignored if this prop is set., Default: `null`
+  @param {'fuzzy'|'strict'} [search_strategy="fuzzy"] - Filtered options to be displayed strictly based on search text or perform a fuzzy match.
+Fuzzy match will not work if `search` function is set, as the backend service is meant to do the matching., Default: `"fuzzy"`
   @param {''|'small'|'medium'|'large'} [size=""] - Size of the input, Default: `""`
   @param {''|'primary'|'success'|'warning'|'info'|'danger'|'dark'|'light'} [color=""] - Color of the input, Default: `""`
   @param {string} [style=""] - Inline CSS for input container, Default: `""`
@@ -24,6 +30,7 @@ this property of each object will be returned as the value, Default: `"id"`
   @param {string} [selected_icon="check"] - Icon used to mark selected items in dropdown list, Default: `"check"`
   @param {boolean} [summary_mode=false] - Shows only the number of items selected, instead of listing all the selected items in the input., Default: `false`
   @param {string} [no_options_msg="No matching options"] - Message to display when no matching options are found, Default: `"No matching options"`
+  @param {string} [async_search_prompt="Start typing to search..."] - Message to display in dropdown when async search can be performed, Default: `"Start typing to search..."`
   @param {string} [remove_btn_tip="Remove"] - Tooltip text for Remove Item button. This `string` will precede the selected Item Name in the tooltip., Default: `"Remove"`
   @param {string} [remove_all_tip="Remove all"] - Tooltip text for the Clear All button, Default: `"Remove all"`
   @param {HTMLElement|string} [dropdown_portal=undefined] - Where to render the dropdown list.
@@ -75,7 +82,6 @@ Default value: `<span>{option[search_key] || option}</span>`
             {#if !readonly && !disabled}
               <button
                 on:click|self|stopPropagation={() => remove(tag)}
-                role="button"
                 type="button"
                 class="delete is-small"
                 data-tooltip="{remove_btn_tip} {tag[used_search_key]}" />
@@ -84,6 +90,7 @@ Default value: `<span>{option[search_key] || option}</span>`
         {/each}
       {/if}
     {/if}
+    {#if single}<span>{singleVisibleValue}</span>{/if}
     <input
       class="input is-{size}"
       bind:this={input}
@@ -98,9 +105,13 @@ Default value: `<span>{option[search_key] || option}</span>`
       on:blur={() => setOptionsVisible(false)}
       placeholder={_placeholder} />
   </ul>
-  {#if !readonly && !disabled}
+  {#if search && options_loading}
+    <button
+      type="button"
+      style="border: none;"
+      class="button is-paddingless delete is-medium is-loading" />
+  {:else if !readonly && !disabled}
     <button
-      role="button"
       type="button"
       class="remove-all delete is-small"
       data-tooltip={remove_all_tip}
@@ -133,7 +144,11 @@ Default value: `<span>{option[search_key] || option}</span>`
               {option}>{option[used_search_key] || option}</slot>
           </li>
         {:else}
-          <li class="no-options">{no_options_msg}</li>
+          {#if !options_loading}
+            <li class="no-options">
+              {searchText ? no_options_msg : async_search_prompt}
+            </li>
+          {/if}
         {/each}
       </ul>
     </div>
@@ -142,8 +157,10 @@ Default value: `<span>{option[search_key] || option}</span>`
 
 <script>
   import { Icon, portal } from "@kws3/ui";
-  import { createEventDispatcher, onMount } from "svelte";
+  import { debounce } from "@kws3/ui/utils";
+  import { createEventDispatcher, onMount, tick } from "svelte";
   import { createPopper } from "@popperjs/core";
+  import fuzzysearch from "fuzzysearch";
 
   const sameWidthPopperModifier = {
     name: "sameWidth",
@@ -196,6 +213,22 @@ Default value: `<span>{option[search_key] || option}</span>`
    * this property of each object will be returned as the value
    */
   export let value_key = "id";
+  /**
+   * Async function to fetch options
+   *
+   * Only send this prop if you want to fetch `options` asynchronously.
+   * `options` prop will be ignored if this prop is set.
+   *
+   * @type {function|null}
+   */
+  export let search = null;
+
+  /**
+   * Filtered options to be displayed strictly based on search text or perform a fuzzy match.
+   * Fuzzy match will not work if `search` function is set, as the backend service is meant to do the matching.
+   * @type {'fuzzy'|'strict'}
+   */
+  export let search_strategy = "fuzzy";
   /**
    * Size of the input
    *  @type {''|'small'|'medium'|'large'}
@@ -230,6 +263,10 @@ Default value: `<span>{option[search_key] || option}</span>`
    * Message to display when no matching options are found
    */
   export let no_options_msg = "No matching options";
+  /**
+   * Message to display in dropdown when async search can be performed
+   */
+  export let async_search_prompt = "Start typing to search...";
   /**
    * Tooltip text for Remove Item button. This `string` will precede the selected Item Name in the tooltip.
    * */
@@ -254,7 +291,8 @@ Default value: `<span>{option[search_key] || option}</span>`
   let klass = "";
   export { klass as class };
 
-  if (!options || !options.length) console.error(`Missing options`);
+  if (!search && (!options || !options.length))
+    console.error(`Missing options`);
 
   if (max !== null && max < 0) {
     throw new TypeError(`max must be null or positive integer, got ${max}`);
@@ -281,9 +319,11 @@ Default value: `<span>{option[search_key] || option}</span>`
     showOptions = false,
     filteredOptions = [], //list of options filtered by search query
     normalisedOptions = [], //list of options normalised
-    selectedOptions = []; //list of options that are selected
+    selectedOptions = [], //list of options that are selected
+    options_loading = false; //indictaes whether async search function is running
 
   $: single = max === 1;
+  $: asyncMode = search && typeof search === "function";
   $: hasValue = single
     ? value !== null && typeof value != "undefined"
       ? true
@@ -324,6 +364,13 @@ Default value: `<span>{option[search_key] || option}</span>`
     else return value.some((v) => matchesValue(v, option));
   };
 
+  $: singleVisibleValue =
+    !searching && single && hasValue && selectedOptions && selectedOptions[0]
+      ? selectedOptions[0][used_search_key]
+      : "";
+
+  $: allow_fuzzy_match = !search && search_strategy === "fuzzy";
+
   //convert arrays of strings into normalised arrays of objects
   function normaliseOptions() {
     let _items = options || [];
@@ -332,15 +379,7 @@ Default value: `<span>{option[search_key] || option}</span>`
       return;
     }
 
-    normalisedOptions = _items.slice().map((item) => {
-      if (typeof item === "object") {
-        return item;
-      }
-      let __obj = {};
-      __obj[used_search_key] = item;
-      __obj[used_value_key] = item;
-      return __obj;
-    });
+    normalisedOptions = normaliseArraysToObjects(_items);
   }
 
   function updateFilteredOptions() {
@@ -353,29 +392,27 @@ Default value: `<span>{option[search_key] || option}</span>`
     } else {
       filter = searchText.toLowerCase();
     }
-
-    filteredOptions = normalisedOptions.slice().filter((item) => {
-      // filter out items that don't match `filter`
-      if (typeof item === "object") {
-        if (used_search_key) {
-          if (
-            typeof item[used_search_key] === "string" &&
-            item[used_search_key].toLowerCase().indexOf(filter) > -1
-          )
-            return true;
-        } else {
-          for (var key in item) {
-            if (
-              typeof item[key] === "string" &&
-              item[key].toLowerCase().indexOf(filter) > -1
-            )
-              return true;
+    if (asyncMode && searching) {
+      debouncedTriggerSearch(filter);
+    } else {
+      filteredOptions = normalisedOptions.slice().filter((item) => {
+        // filter out items that don't match `filter`
+        if (typeof item === "object") {
+          if (used_search_key) {
+            return (
+              typeof item[used_search_key] === "string" &&
+              match(filter, item[used_search_key])
+            );
+          } else {
+            for (var key in item) {
+              return typeof item[key] === "string" && match(filter, item[key]);
+            }
           }
+        } else {
+          return match(filter, item);
         }
-      } else {
-        return item.toLowerCase().indexOf(filter) > -1;
-      }
-    });
+      });
+    }
   }
 
   function fillSelectedOptions() {
@@ -383,9 +420,17 @@ Default value: `<span>{option[search_key] || option}</span>`
       selectedOptions = normalisedOptions.filter(
         (v) => `${v[used_value_key]}` === `${value}`
       );
-      setSingleVisibleValue();
     } else {
-      selectedOptions = normalisedOptions
+      let _normalisedOptions = asyncMode
+        ? [...selectedOptions, ...normalisedOptions].filter(
+            //de-dupe by `used_value_key` when in asyncMode
+            (value, idx, self) =>
+              idx ===
+              self.findIndex((v) => v[used_value_key] === value[used_value_key])
+          )
+        : normalisedOptions;
+
+      selectedOptions = _normalisedOptions
         .filter(
           (v) => value && value.some((vl) => `${v[used_value_key]}` === `${vl}`)
         )
@@ -398,6 +443,23 @@ Default value: `<span>{option[search_key] || option}</span>`
     POPPER && POPPER.update();
   }
 
+  function triggerSearch(filter) {
+    if (filter === "") {
+      //do not trigger async search if filter is empty
+      options = [];
+      searching = false;
+      return;
+    }
+    options_loading = true;
+    search(filter).then((_options) => {
+      options = _options;
+      searching = false;
+      options_loading = false;
+    });
+  }
+
+  const debouncedTriggerSearch = debounce(triggerSearch, 150, false);
+
   onMount(() => {
     POPPER = createPopper(el, dropdown, {
       strategy: "fixed",
@@ -406,10 +468,25 @@ Default value: `<span>{option[search_key] || option}</span>`
     });
 
     //normalize value for single versus multiselect
-    if (value === null || typeof value == "undefined")
+    if (value === null || typeof value == "undefined") {
       value = single ? null : [];
+    }
 
-    setSingleVisibleValue();
+    if (asyncMode) {
+      // initally on async mode options are empty
+      // so we need to fill selectedOptions with value if value is avaliable
+      options = value ? [...(single ? [value] : [...value])] : [];
+      searching = false;
+      tick().then(() => {
+        normaliseOptions();
+        value = normaliseArraysToObjects(options).map((v) => v[used_value_key]);
+        if (single && Array.isArray(value)) {
+          value = value[0];
+        }
+        fillSelectedOptions();
+        clearDropDownResults();
+      });
+    }
 
     return () => {
       POPPER.destroy();
@@ -424,24 +501,39 @@ Default value: `<span>{option[search_key] || option}</span>`
     let isAlreadySelected = isSelected(token);
 
     if (single) {
-      if (isAlreadySelected) {
-        setSingleVisibleValue();
-      } else {
+      if (!isAlreadySelected) {
         value = token[used_value_key];
-        input && input.blur();
-        setOptionsVisible(false);
         fire("change", { token, type: `add` });
+        //clear dropdown results in asyncMode
+        if (asyncMode) {
+          clearDropDownResults();
+        }
       }
+      setOptionsVisible(false);
     }
 
     if (!isAlreadySelected && !single && (max === null || value.length < max)) {
-      //attach to value array while filtering out invalid values
-      value = [...value, token[used_value_key]].filter((v) => {
-        return normalisedOptions.filter((nv) => nv[used_value_key] === v)
-          .length;
-      });
+      if (asyncMode) {
+        //Do not filter invalid options, as they are async and might not be invalid
+        //but ensure they are unique
+        value = [...value, token[used_value_key]].filter(
+          (v, i, a) => a.indexOf(v) === i
+        );
+      } else {
+        //attach to value array while filtering out invalid values
+        value = [...value, token[used_value_key]].filter((v) => {
+          return normalisedOptions.filter((nv) => nv[used_value_key] === v)
+            .length;
+        });
+      }
+
       searchText = ""; // reset search string on selection
 
+      //clear dropdown results in asyncMode
+      if (asyncMode) {
+        clearDropDownResults();
+      }
+
       if (value && value.length && value.length === max) {
         input && input.blur();
         setOptionsVisible(false);
@@ -460,6 +552,11 @@ Default value: `<span>{option[search_key] || option}</span>`
     value = value.filter
       ? value.filter((item) => !matchesValue(item, token))
       : value;
+
+    //clear dropdown results in asyncMode
+    if (asyncMode) {
+      clearDropDownResults();
+    }
     /**
      * Triggered when an item is removed from selected Items
      */
@@ -483,25 +580,16 @@ Default value: `<span>{option[search_key] || option}</span>`
     showOptions = show;
     if (show) {
       input && input.focus();
-    }
-    POPPER && POPPER.update();
-  }
-
-  function setSingleVisibleValue() {
-    if (single && hasValue) {
-      searchText =
-        selectedOptions && selectedOptions[0]
-          ? selectedOptions[0][used_search_key]
-          : "";
+    } else {
+      searchText = "";
       searching = false;
     }
+    POPPER && POPPER.update();
   }
 
   function handleKeydown(event) {
     if (event.key === `Escape`) {
-      if (!single) {
-        searchText = "";
-      }
+      searchText = "";
     } else {
       setOptionsVisible(true);
     }
@@ -510,9 +598,6 @@ Default value: `<span>{option[search_key] || option}</span>`
       event.preventDefault();
       if (activeOption) {
         handleOptionMouseDown(activeOption);
-        if (!single) {
-          searchText = "";
-        }
       } else {
         // no active option means the options are closed in which case enter means open
         setOptionsVisible(true);
@@ -529,24 +614,31 @@ Default value: `<span>{option[search_key] || option}</span>`
         else activeOption = filteredOptions[newActiveIdx];
       }
     } else if (event.key === `Backspace`) {
-      // only remove selected tags on backspace if there are any and no searchText characters remain
-      if (searchText.length === 0) {
-        if (single) {
-          if (value) {
-            value = null;
-          }
-        } else {
-          if (value && value.length > 0) {
-            value = value.slice(0, value.length - 1);
-          }
+      if (single && hasValue) {
+        //for a single select
+        //if a value is already selected, backspace will clear the value
+        value = null;
+        searchText = "";
+      } else if (!single && searchText.length === 0) {
+        //for a multi select
+        // only remove selected tags on backspace if there are any and no searchText characters remain
+        if (value && value.length > 0) {
+          value = value.slice(0, value.length - 1);
         }
       } else {
-        if (single) {
-          searching = true;
-        }
+        searching = true;
       }
     } else {
+      //for a single select
+      //if a value is already selected,
+      //ignore keys other than navigation, enter and backspace
       if (single) {
+        if (hasValue) {
+          event.preventDefault();
+        } else {
+          searching = true;
+        }
+      } else {
         searching = true;
       }
     }
@@ -565,6 +657,9 @@ Default value: `<span>{option[search_key] || option}</span>`
     fire("change", { token: value, type: `remove` });
     value = single ? null : [];
     searchText = "";
+    if (asyncMode) {
+      clearDropDownResults();
+    }
   };
 
   const matchesValue = (_value, _option) => {
@@ -575,4 +670,30 @@ Default value: `<span>{option[search_key] || option}</span>`
       `${_value[used_value_key] || _value}` === `${_option[used_value_key]}`
     );
   };
+
+  const match = (needle, haystack) => {
+    let _hayStack = haystack.toLowerCase();
+    return allow_fuzzy_match
+      ? fuzzysearch(needle, _hayStack)
+      : _hayStack.indexOf(needle) > -1;
+  };
+
+  const normaliseArraysToObjects = (arr) => {
+    return arr.slice().map((item) => {
+      if (typeof item === "object") {
+        return item;
+      }
+      let __obj = {};
+      __obj[used_search_key] = item;
+      __obj[used_value_key] = item;
+      return __obj;
+    });
+  };
+
+  const clearDropDownResults = () => {
+    tick().then(() => {
+      options = [];
+      searching = false;
+    });
+  };
 </script>

package/forms/select/SearchableSelect.svelte

@@ -16,9 +16,16 @@ this property of each object will be returned as the value, Default: `"id"`
   @param {''|'primary'|'success'|'warning'|'info'|'danger'|'dark'|'light'} [color=""] - Color of the input, Default: `""`
   @param {string} [style=""] - Inline CSS for input container, Default: `""`
   @param {boolean} [readonly=false] - Marks component as read-only, Default: `false`
+  @param {function|null} [search=null] - Async function to fetch options
+
+Only send this prop if you want to fetch `options` asynchronously.
+`options` prop will be ignored if this prop is set., Default: `null`
+  @param {'fuzzy'|'strict'} [search_strategy="fuzzy"] - Filtered options to be displayed strictly based on search text or perform a fuzzy match.
+Fuzzy match will not work if `search` function is set, as the backend service is meant to do the matching., Default: `"fuzzy"`
   @param {boolean} [disabled=false] - Disables the component, Default: `false`
   @param {string} [selected_icon="check"] - Icon used to mark selected items in dropdown list, Default: `"check"`
   @param {string} [no_options_msg="No matching options"] - Message to display when no matching options are found, Default: `"No matching options"`
+  @param {string} [async_search_prompt="Start typing to search..."] - Message to display in dropdown when async search can be performed, Default: `"Start typing to search..."`
   @param {string} [remove_all_tip="Clear Selection"] - Tooltip text for the Clear selection button, Default: `"Clear Selection"`
   @param {HTMLElement|string} [dropdown_portal=undefined] - Where to render the dropdown list.
 Can be a DOM element or a `string` with the CSS selector of the element.
@@ -44,13 +51,16 @@ Default value: `<span>{option[search_key] || option}</span>`
   {options}
   {search_key}
   {value_key}
+  {search_strategy}
   {size}
   {color}
   {style}
   {readonly}
   {disabled}
+  {search}
   {selected_icon}
   {remove_all_tip}
+  async_search_prompt={value ? "Backspace to clear" : async_search_prompt}
   {no_options_msg}
   {dropdown_portal}
   on:change={change}
@@ -118,6 +128,21 @@ Default value: `<span>{option[search_key] || option}</span>`
    * Marks component as read-only
    */
   export let readonly = false;
+  /**
+   * Async function to fetch options
+   *
+   * Only send this prop if you want to fetch `options` asynchronously.
+   * `options` prop will be ignored if this prop is set.
+   *
+   * @type {function|null}
+   */
+  export let search = null;
+  /**
+   * Filtered options to be displayed strictly based on search text or perform a fuzzy match.
+   * Fuzzy match will not work if `search` function is set, as the backend service is meant to do the matching.
+   * @type {'fuzzy'|'strict'}
+   */
+  export let search_strategy = "fuzzy";
   /**
    * Disables the component
    */
@@ -130,6 +155,10 @@ Default value: `<span>{option[search_key] || option}</span>`
    * Message to display when no matching options are found
    */
   export let no_options_msg = "No matching options";
+  /**
+   * Message to display in dropdown when async search can be performed
+   */
+  export let async_search_prompt = "Start typing to search...";
   /**
    * Tooltip text for the Clear selection button
    */

package/helpers/ActionSheet.svelte

@@ -19,7 +19,9 @@ If `false` , the component won't have a close button, and will not close on clic
 
 -->
 
-<div class="modal {klass} {is_active ? 'is-active' : ''}" {style}>
+<div
+  class="modal kws-action-sheet-outer {klass} {is_active ? 'is-active' : ''}"
+  {style}>
   {#if is_active}<div
       transition:fade={{ duration: transitionDuration }}
       class="modal-background"

package/helpers/CardModal.svelte

@@ -34,7 +34,6 @@ Only visible when the
       transition:fade={{ duration: transitionDuration }}
       class="modal-background"
       on:click={clickOutside} />
-
     <div
       transition:scale={{
         duration: transitionDuration,
@@ -83,6 +82,17 @@ Only visible when the
 </div>
 
 <style lang="scss">
+  .modal {
+    display: flex;
+    visibility: hidden;
+    &.is-active {
+      visibility: visible;
+    }
+    .modal-card,
+    .modal-background {
+      transition: all 0.3s;
+    }
+  }
   @media screen and (min-width: 769px), print {
     .modal-card {
       min-width: 640px;

package/helpers/Dialog/index.js

@@ -12,6 +12,8 @@ function createDialog(msg, props) {
 
     dialog.$on("_done", ({ detail }) => {
       fulfil(detail);
+      //Does not outro out because of
+      //https://github.com/sveltejs/svelte/issues/4056
       dialog.$destroy();
     });
   });

package/helpers/Modal.svelte

@@ -26,7 +26,6 @@ Only programmatic closing is possible, Default: `true`
       transition:fade={{ duration: transitionDuration }}
       class="modal-background"
       on:click={clickOutside} />
-
     <div
       transition:scale={{
         duration: transitionDuration,
@@ -47,9 +46,19 @@ Only programmatic closing is possible, Default: `true`
 </div>
 
 <style lang="scss">
-  @media screen and (min-width: 769px), print {
+  .modal {
+    display: flex;
+    visibility: hidden;
+    &.is-active {
+      visibility: visible;
+    }
     .modal-content,
-    .modal-card {
+    .modal-background {
+      transition: all 0.3s;
+    }
+  }
+  @media screen and (min-width: 769px), print {
+    .modal-content {
       min-width: 640px;
       &.is-medium {
         width: 70%;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kws3/ui",
-  "version": "1.7.4",
+  "version": "1.8.0",
   "description": "UI components for use with Svelte v3 applications.",
   "main": "index.js",
   "scripts": {
@@ -25,9 +25,10 @@
   "dependencies": {
     "apexcharts": "3.33.2",
     "flatpickr": "^4.5.2",
+    "fuzzysearch": "^1.0.3",
     "svelte-portal": "^2.1.2",
     "text-mask-core": "^5.1.2",
     "tippy.js": "^6.3.1"
   },
-  "gitHead": "fefd40197784db6665d8f74c358931cc5e8becaf"
+  "gitHead": "8da0698c240f93ae1b371a9279d2473409646b10"
 }

package/styles/ActionSheet.scss

@@ -2,6 +2,16 @@ $kws-actionsheet-background: $background !default;
 $kws-actionsheet-box-shadow: $card-shadow !default;
 $kws-actionsheet-box-radius: $radius !default;
 
+.kws-action-sheet-outer {
+  display: flex;
+  visibility: hidden;
+  &.is-active {
+    visibility: visible;
+  }
+  .modal-background {
+    transition: all 0.3s;
+  }
+}
 .kws-action-sheet {
   border-radius: $kws-actionsheet-box-radius $kws-actionsheet-box-radius 0 0;
   box-shadow: $kws-actionsheet-box-shadow;