@kws3/ui 1.6.5 → 1.6.6

package/helpers/Popover.svelte

@@ -7,11 +7,14 @@
   @param {''|'small'|'medium'|'large'} [icon_size="small"] - Size of the trigger icon displayed when default slot has no content, Default: `"small"`
   @param {string} [trigger="click"] - Determines the events that cause the Popover to show. Multiple event names are separated by spaces.
 
-**Examples:** `click`, `mouseenter`, `mouseenter focus`, Default: `"click"`
+**Examples:** `click`, `mouseenter`, `mouseenter focus`
+
+If you would like to trigger the popover programatically only, you can use `manual`., Default: `"click"`
   @param {string} [placement="auto"] - Preferred placement of the Popover
 
 Available options: <a target="_blank" href="https://atomiks.github.io/tippyjs/v6/all-props/#placement">https://atomiks.github.io/tippyjs/v6/all-props/#placement</a>, Default: `"auto"`
   @param {boolean} [interactive=false] - Allows you to interact with the Popover content, when turned on, Default: `false`
+  @param {boolean} [hide_on_click=true] - Whether the popover should hide on clicking outside of it, Default: `true`
   @param {object} [external_target=null] - Specify a target node reference to use as the Popover content
 
 When set to `null`, it will use the content of the `popover` slot, Default: `null`
@@ -20,6 +23,16 @@ When set to `null`, it will use the content of the `popover` slot, Default: `nul
 It can be any CSS value associated with `max-width` property, including `"none"`, Default: `"none"`
   @param {string} [style=""] - Inline CSS for Popover trigger, Default: `""`
   @param {string} [class=""] - CSS classes for Popover trigger, Default: `""`
+  @param {function} [open()] - Open function
+  @param {function} [close()] - Close function
+  @param {function} [enable()] - Enable function
+  @param {function} [disable()] - Disable function
+  @param {function} [setProps(props)] - SetProps function
+
+  ### Events
+  - `open` - Triggered when popoper is shown
+  - `close` - Triggered when popoper is hidden
+  - `trigger` - Triggered when popover is triggered either programatically or by user interaction
 
   ### Slots
   - `<slot name="default"  />` - Content of the Popover Trigger, by default it displays an Icon
@@ -28,11 +41,16 @@ It can be any CSS value associated with `max-width` property, including `"none"`
 -->
 <span
   use:popover={{ content: targetNode }}
+  bind:this={popoverParent}
+  on:shown={popoverShown}
+  on:hidden={popoverHidden}
+  on:triggered={popoverTriggered}
   data-tippy-trigger={trigger}
   data-tippy-placement={placement}
   data-tippy-offset="[0, 10]"
   data-tippy-interactive={interactive ? "true" : "false"}
   data-tippy-maxWidth={max_width}
+  data-tippy-hideOnClick={hide_on_click ? "true" : "false"}
   style={_style}
   class={klass}>
   <!--Content of the Popover Trigger, by default it displays an Icon--><slot
@@ -51,8 +69,12 @@ It can be any CSS value associated with `max-width` property, including `"none"`
 </style>
 
 <script>
+  import { createEventDispatcher } from "svelte";
   import { popover } from "./Tooltip";
   import { Icon } from "@kws3/ui";
+
+  const fire = createEventDispatcher();
+
   /**
    * Icon used when default slot has no content
    */
@@ -71,6 +93,8 @@ It can be any CSS value associated with `max-width` property, including `"none"`
    * Determines the events that cause the Popover to show. Multiple event names are separated by spaces.
    *
    * **Examples:** `click`, `mouseenter`, `mouseenter focus`
+   *
+   * If you would like to trigger the popover programatically only, you can use `manual`.
    */
   export let trigger = "click";
   /**
@@ -83,6 +107,10 @@ It can be any CSS value associated with `max-width` property, including `"none"`
    * Allows you to interact with the Popover content, when turned on
    */
   export let interactive = false;
+  /**
+   * Whether the popover should hide on clicking outside of it
+   */
+  export let hide_on_click = true;
   /**
    * Specify a target node reference to use as the Popover content
    *
@@ -106,7 +134,52 @@ It can be any CSS value associated with `max-width` property, including `"none"`
   let klass = "";
   export { klass as class };
 
-  let popoverNode;
+  let popoverNode, popoverParent;
+
+  const getInstance = () => {
+    return popoverParent._tippy;
+  };
+
+  export function open() {
+    getInstance().show();
+  }
+
+  export function close() {
+    getInstance().hide();
+  }
+
+  export function enable() {
+    getInstance().enable();
+  }
+
+  export function disable() {
+    getInstance().disable();
+  }
+
+  export function setProps(props) {
+    getInstance().setProps(props);
+  }
+
+  const popoverShown = ({ detail }) => {
+    /**
+     * Triggered when popoper is shown
+     */
+    fire("open", detail);
+  };
+
+  const popoverHidden = ({ detail }) => {
+    /**
+     * Triggered when popoper is hidden
+     */
+    fire("close", detail);
+  };
+
+  const popoverTriggered = ({ detail }) => {
+    /**
+     * Triggered when popover is triggered either programatically or by user interaction
+     */
+    fire("trigger", detail);
+  };
 
   $: _style = `cursor:pointer;${style}`;
   $: targetNode = external_target ? external_target : popoverNode;

package/helpers/Tooltip.js

@@ -29,7 +29,17 @@ function createTippyAction(defaultOpts) {
     let instance;
 
     function makeOptions() {
-      return Object.assign({}, defaultOpts, opts);
+      return Object.assign({}, defaultOpts, opts, {
+        onShow(instance) {
+          dispatch("shown", { instance });
+        },
+        onHide(instance) {
+          dispatch("hidden", { instance });
+        },
+        onTrigger(instance) {
+          dispatch("triggered", { instance });
+        },
+      });
     }
 
     function remakeInstance() {
@@ -51,6 +61,11 @@ function createTippyAction(defaultOpts) {
 
     makeInstance();
 
+    function dispatch(type, detail) {
+      const e = new CustomEvent(type, { bubbles: false, detail });
+      node.dispatchEvent(e);
+    }
+
     return {
       update(_opts) {
         opts = _opts;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kws3/ui",
-  "version": "1.6.5",
+  "version": "1.6.6",
   "description": "UI components for use with Svelte v3 applications.",
   "main": "index.js",
   "scripts": {
@@ -29,5 +29,5 @@
     "text-mask-core": "^5.1.2",
     "tippy.js": "^6.3.1"
   },
-  "gitHead": "7bd56973e65c032a94e8285e321de06d0a89d051"
+  "gitHead": "0f6862d3aefc099de5ccc7df5eaca60c47bbcdab"
 }