@watermarkinsights/ripple 0.0.0-1 → 0.0.1

package/dist/collection/components/wm-search/wm-search.js

@@ -1,439 +0,0 @@
-import { h, Component, Element, Prop, Watch, Host, Method, Listen, State, Event } from "@stencil/core";
-import { intl } from "../../global/functions";
-export class Search {
-  constructor() {
-    this.searchType = "basic";
-    this.disabled = false;
-    /**
-     * Props required for both variants.
-     */
-    this.placeholder = "";
-    this.label = "";
-    this.numResults = 0;
-    /**
-     * This exposes the input's value on the host component so that the app can access it.
-     */
-    this.value = "";
-    /**
-     * If the user is tabbing, the search and find variant will display a link to jump to a search result.
-     */
-    this.isTabbing = false;
-    /**
-     * Prop specifically for the search and find variant. The id points to the id of the option currently highlighted,
-     * so that tabbing and screen reader users can jump to this option rather than tab through the list to find it.
-     */
-    this.highlightedId = "";
-    this.highlightedName = null;
-    /**
-     * Indicates which of the search results is currently highlighted. It will be displayed as "[highlightedNum] of [numResults]" next to the input in the search and find variant.
-     * This number updates as the user browses using the buttons.
-     */
-    this.highlightedNum = 0;
-    /**
-     * Element refs
-     */
-    this.resultsLiveRegion = null;
-    this.wrapperEl = null;
-    this.linkEl = null;
-  }
-  toggleTabbingOn() {
-    this.isTabbing = true;
-    this.linkEl && this.linkEl.classList.remove("sr-only");
-    this.linkEl && this.linkEl.classList.add("show-for-tabbers");
-  }
-  toggleTabbingOff() {
-    this.isTabbing = false;
-    this.linkEl && this.linkEl.classList.add("sr-only");
-    this.linkEl && this.linkEl.classList.remove("show-for-tabbers");
-  }
-  componentWillLoad() {
-    // replacing the prototype's focus event by our own
-    // to delegate focus to the appropriate el in the shadow root
-    // we could replace by ShadowRoot.delegatesFocus()
-    // when there's enough support for it
-    // @ts-ignore
-    this.el.focus = function () {
-      if (!this.disabled) {
-        this.shadowRoot.querySelector("#wm-search-input").focus();
-        // onFocus event doesn't run when focus is programmatic,
-        // so we reproduce this.addFocusStyle here
-        this.shadowRoot.querySelector("#wm-search-wrapper").classList.add("focus");
-      }
-    };
-    if (this.placeholder === "") {
-      console.error("You must set the placeholder property for the wm-search component.");
-    }
-    if (this.label === "") {
-      console.error("You must set the label property for the wm-search component.");
-    }
-    this.hookToModal();
-  }
-  hookToModal() {
-    // if the search is in a modal we want to clear the input when the modal closes
-    let el = this.el;
-    while (!!el) {
-      if (el.tagName === "WM-MODAL") {
-        this.parentModal = el;
-      }
-      el = el.parentElement;
-    }
-    if (this.parentModal) {
-      const events = ["wmCloseTriggered", "wmPrimaryTriggered", "wmSecondaryTriggered"];
-      events.map((event) => {
-        this.parentModal.addEventListener(event, () => {
-          this.updateValue("");
-        });
-      });
-    }
-  }
-  async updateValue(value) {
-    this.value = value;
-    //For search-and-find, the results should always restart at "[1 or 0] of ..." after any new input.
-    //Reset the highlight count here just in case the new value doesn't end up changing the number of results.
-    this.resetHighlightCountToStart();
-  }
-  resetHighlightCountToStart() {
-    if (this.searchType === "find") {
-      if (this.numResults) {
-        this.highlightedNum = 1;
-      }
-      else {
-        this.highlightedNum = 0;
-      }
-    }
-  }
-  /**
-   * Unfortunately, simply rendering the prop values for the number of results or highlighted option in the live regions, ideally so that the screen reader reads them when they change, does not work
-   * ---NVDA in Firefox only reads the specific letters that change in the prop value. The innerHTML of the live region must be explicitly changed in order for the screen reader to read the words in full, i.e., coherently.
-   *
-   * An update of the props triggers a re-render, so setting the live region in componentDidRender ensures the screen reader announces any changes to the number of results/highlighted option.
-   * Note: Updating the innerHTML of the live region does not cause the component to re-render so there's no performance hit here.
-   */
-  componentDidRender() {
-    this.announceChanges();
-  }
-  /**
-   * Set live region to blank and then update it with the message ensure the screen reader registers the changes.
-   */
-  announceChanges() {
-    let message = this.getResultsMessage();
-    if (this.searchType === "find" && this.highlightedName) {
-      message += `, ${this.highlightedName}`;
-    }
-    this.resultsLiveRegion && (this.resultsLiveRegion.innerHTML = "");
-    window.requestAnimationFrame(() => this.resultsLiveRegion && (this.resultsLiveRegion.innerHTML = message));
-  }
-  /**
-   * Creates the message that should be announced by the screen reader.
-   */
-  getResultsMessage() {
-    //If there's no text in the input, don't give any message
-    if (this.value) {
-      if (this.searchType === "basic") {
-        return intl.formatMessage({
-          id: "search.resultsFound",
-          defaultMessage: "{numResults, plural, =0 {No results} one {1 result} other {# results}} found",
-        }, { numResults: this.numResults });
-      }
-      else {
-        return intl.formatMessage({
-          id: "search.xOfYResults",
-          defaultMessage: "{numResults, plural, =0 {No results found} other {{current} of {numResults} results}}",
-        }, { numResults: this.numResults, current: this.highlightedNum });
-      }
-    }
-    else {
-      return "";
-    }
-  }
-  changeHighlightedNum(newNum) {
-    if (this.numResults) {
-      if (newNum < 1) {
-        // we were on the first item, going down: go to last item
-        this.highlightedNum = this.numResults;
-      }
-      else if (newNum > this.numResults) {
-        // we were on the last item, going up: go to first item
-        this.highlightedNum = 1;
-      }
-      else {
-        this.highlightedNum = newNum;
-      }
-      this.wmBrowseSearchResults.emit({ position: this.highlightedNum });
-    }
-  }
-  addFocusStyle() {
-    if (this.wrapperEl) {
-      this.wrapperEl.classList.add("focus");
-    }
-  }
-  removeFocusStyle() {
-    if (this.wrapperEl) {
-      this.wrapperEl.classList.remove("focus");
-    }
-  }
-  /**
-   * Functions that return elements specifically for search-and-find.
-   */
-  renderResultsAndBrowseButtons() {
-    return (h("div", { class: "wm-find-elements" },
-      h("div", { id: "results-display", class: "results" }, this.getResultsMessage()),
-      h("div", { class: "wm-button-collection" },
-        h("wm-button", { "button-style": "icononly", icon: "f05d", tooltip: intl.formatMessage({
-            id: "global.previous",
-            description: "button text",
-            defaultMessage: "previous",
-          }), "tooltip-position": "bottom", onClick: () => this.changeHighlightedNum(this.highlightedNum - 1), disabled: this.disabled || this.numResults < 2, "label-for-identical-buttons": intl.formatMessage({
-            id: "search.previousResult",
-            defaultMessage: "Press to hear previous matching result",
-          }) }),
-        h("wm-button", { "button-style": "icononly", icon: "f045", tooltip: intl.formatMessage({
-            id: "global.next",
-            description: "button text",
-            defaultMessage: "next",
-          }), "tooltip-position": "bottom", onClick: () => this.changeHighlightedNum(this.highlightedNum + 1), disabled: this.disabled || this.numResults < 2, "label-for-identical-buttons": intl.formatMessage({
-            id: "search.nextResult",
-            defaultMessage: "Press to hear next matching result",
-          }) }))));
-  }
-  renderJumpToLink() {
-    if (this.numResults && this.highlightedId) {
-      return (h("a", { ref: (el) => (this.linkEl = el), href: `#${this.highlightedId}`, class: "sr-only" }, intl.formatMessage({
-        id: "search.jumpToResult",
-        defaultMessage: "Jump to search result in list",
-      })));
-    }
-    else {
-      return null;
-    }
-  }
-  /**
-   * End search and find render helpers
-   */
-  render() {
-    return (h(Host, null,
-      h("div", { id: "wm-search-wrapper", class: `wm-search-wrapper ${this.searchType}`, ref: (el) => (this.wrapperEl = el) },
-        h("input", { disabled: this.disabled, id: "wm-search-input", placeholder: this.placeholder, "aria-label": `${this.label ? this.label + ". " : ""}${intl.formatMessage({
-            id: "search.typeToFilterResults",
-            defaultMessage: "Type to filter the results",
-          })}`, onInput: (ev) => this.updateValue(ev.target.value), onFocus: () => this.addFocusStyle(), onBlur: () => this.removeFocusStyle(), "aria-autocomplete": "none", autocomplete: "off", value: this.value }),
-        h("span", { class: "mdi search-icon" }, String.fromCodePoint(parseInt(`0xf349`))),
-        this.searchType === "find" && this.renderResultsAndBrowseButtons(),
-        h("div", { id: "wm-search-live", class: "sr-only", "aria-live": "polite", "aria-atomic": "true", ref: (el) => (this.resultsLiveRegion = el) })),
-      this.searchType === "find" && this.renderJumpToLink()));
-  }
-  static get is() { return "wm-search"; }
-  static get encapsulation() { return "shadow"; }
-  static get originalStyleUrls() { return {
-    "$": ["wm-search.scss"]
-  }; }
-  static get styleUrls() { return {
-    "$": ["wm-search.css"]
-  }; }
-  static get properties() { return {
-    "searchType": {
-      "type": "string",
-      "mutable": true,
-      "complexType": {
-        "original": "\"basic\" | \"find\"",
-        "resolved": "\"basic\" | \"find\"",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": ""
-      },
-      "attribute": "search-type",
-      "reflect": false,
-      "defaultValue": "\"basic\""
-    },
-    "disabled": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": ""
-      },
-      "attribute": "disabled",
-      "reflect": true,
-      "defaultValue": "false"
-    },
-    "placeholder": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "Props required for both variants."
-      },
-      "attribute": "placeholder",
-      "reflect": false,
-      "defaultValue": "\"\""
-    },
-    "label": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": ""
-      },
-      "attribute": "label",
-      "reflect": false,
-      "defaultValue": "\"\""
-    },
-    "numResults": {
-      "type": "number",
-      "mutable": true,
-      "complexType": {
-        "original": "number",
-        "resolved": "number",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": ""
-      },
-      "attribute": "num-results",
-      "reflect": false,
-      "defaultValue": "0"
-    },
-    "value": {
-      "type": "string",
-      "mutable": true,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "This exposes the input's value on the host component so that the app can access it."
-      },
-      "attribute": "value",
-      "reflect": true,
-      "defaultValue": "\"\""
-    },
-    "highlightedId": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "Prop specifically for the search and find variant. The id points to the id of the option currently highlighted,\nso that tabbing and screen reader users can jump to this option rather than tab through the list to find it."
-      },
-      "attribute": "highlighted-id",
-      "reflect": false,
-      "defaultValue": "\"\""
-    },
-    "highlightedName": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string | null",
-        "resolved": "null | string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": ""
-      },
-      "attribute": "highlighted-name",
-      "reflect": false,
-      "defaultValue": "null"
-    }
-  }; }
-  static get states() { return {
-    "isTabbing": {},
-    "highlightedNum": {},
-    "parentModal": {}
-  }; }
-  static get events() { return [{
-      "method": "wmBrowseSearchResults",
-      "name": "wmBrowseSearchResults",
-      "bubbles": true,
-      "cancelable": true,
-      "composed": true,
-      "docs": {
-        "tags": [],
-        "text": "Emitted when the buttons in the search-and-find variant are pressed."
-      },
-      "complexType": {
-        "original": "{ position: number }",
-        "resolved": "{ position: number; }",
-        "references": {}
-      }
-    }]; }
-  static get methods() { return {
-    "updateValue": {
-      "complexType": {
-        "signature": "(value: string) => Promise<void>",
-        "parameters": [{
-            "tags": [],
-            "text": ""
-          }],
-        "references": {
-          "Promise": {
-            "location": "global"
-          }
-        },
-        "return": "Promise<void>"
-      },
-      "docs": {
-        "text": "",
-        "tags": []
-      }
-    }
-  }; }
-  static get elementRef() { return "el"; }
-  static get watchers() { return [{
-      "propName": "numResults",
-      "methodName": "resetHighlightCountToStart"
-    }]; }
-  static get listeners() { return [{
-      "name": "wmUserIsTabbing",
-      "method": "toggleTabbingOn",
-      "target": "window",
-      "capture": false,
-      "passive": false
-    }, {
-      "name": "wmUserIsNotTabbing",
-      "method": "toggleTabbingOff",
-      "target": "window",
-      "capture": false,
-      "passive": false
-    }]; }
-}