@xplortech/apollo-core 0.5.3 → 1.0.0-beta.1

package/dist/collection/components/xpl-input/xpl-input.js

@@ -0,0 +1,478 @@
+import { Component, Host, h, Prop, State } from '@stencil/core';
+import { v4 as uuid } from 'uuid';
+import flatpickr from 'flatpickr';
+import '../../../font-awesome/fontawesome';
+import '../../../font-awesome/regular';
+const arrowSvg = (rotate = false) => `<svg width="8" height="12" viewBox="0 0 8 12" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="${rotate
+  ? 'M0.557948 5.6813L6.06209 0.132167C6.23831 -0.0440556 6.52327 -0.0440556 6.69949 0.132167L7.44187 0.874551C7.61809 1.05077 7.61809 1.33573 7.44187 1.51195L2.99882 6L7.44187 10.488C7.61809 10.6643 7.61809 10.9492 7.44187 11.1254L6.69949 11.8678C6.52327 12.0441 6.23831 12.0441 6.06209 11.8678L0.557948 6.3187C0.381726 6.14248 0.381726 5.85752 0.557948 5.6813Z'
+  : 'M7.44187 6.3187L1.93773 11.8678C1.76151 12.0441 1.47655 12.0441 1.30033 11.8678L0.557948 11.1254C0.381726 10.9492 0.381726 10.6643 0.557948 10.488L5.001 6L0.557948 1.51195C0.381726 1.33573 0.381726 1.05077 0.557948 0.874551L1.30033 0.132167C1.47655 -0.0440556 1.76151 -0.0440556 1.93773 0.132167L7.44187 5.6813C7.6181 5.85752 7.6181 6.14248 7.44187 6.3187Z'}" /></svg>`;
+export class XplInput {
+  constructor() {
+    /**
+     * See https://flatpickr.js.org/formatting/
+     */
+    this.dateFormat = 'Y-m-d';
+    /**
+     * For datepicker inputs, whether to allow only a single
+     * date or a range of dates. (Multiple non-consecutive
+     * dates planned to be supported in the future.)
+     */
+    this.mode = 'single';
+    /**
+     * Whether to render as a singleline text input or
+     * as a multiline textarea. (If `true`, `pre` and `post`
+     * values will be ignored, if present.)
+     */
+    this.multiline = false;
+    this.type = 'text';
+    this.characterCount = 0;
+    this.passwordVisible = false;
+  }
+  updateCharacterCount() {
+    this.characterCount = this.input.value.length;
+  }
+  componentWillLoad() {
+    if (this._id === undefined || this._id === null || this._id === '')
+      this._id = uuid();
+    if (this.multiline && this.maxCharacterCount !== undefined) {
+      this.characterCount =
+        this.value !== undefined ? this.value.length : 0;
+    }
+  }
+  componentDidLoad() {
+    if (this.type === 'date') {
+      flatpickr(this.input, {
+        allowInput: true,
+        dateFormat: this.dateFormat,
+        defaultDate: this.value,
+        maxDate: this.max,
+        minDate: this.min,
+        mode: this.mode,
+        nextArrow: arrowSvg(),
+        prevArrow: arrowSvg(true),
+      });
+    }
+  }
+  render() {
+    let className = 'xpl-input';
+    if (this.disabled)
+      className += ' xpl-input--disabled';
+    let hasError = false;
+    if (this.error !== undefined)
+      hasError = true;
+    if (this.multiline &&
+      this.maxCharacterCount !== undefined &&
+      this.characterCount > this.maxCharacterCount)
+      hasError = true;
+    if (hasError)
+      className += ' xpl-input--error';
+    let type = this.type;
+    if (type === 'password' && this.passwordVisible) {
+      type = 'text';
+    }
+    return (h(Host, { class: className },
+      h("label", { class: "xpl-input-label", htmlFor: this._id },
+        this.label,
+        this.description && h("small", null, this.description)),
+      h("div", { class: "xpl-input-wrapper" },
+        this.pre && !this.multiline && (h("label", { class: "xpl-input-pre", htmlFor: this._id }, this.pre)),
+        !this.multiline ? (h("input", { autocomplete: this.type === 'date' ? 'off' : this.autocomplete, disabled: this.disabled, id: this._id, max: this.max, min: this.min, name: this.name, placeholder: this.placeholder, readonly: this.readonly, ref: (el) => {
+            this.input = el;
+          }, required: this.required, step: this.step, type: type, value: this.value })) : (h("textarea", { disabled: this.disabled, id: this._id, name: this.name, onInput: () => this.updateCharacterCount(), placeholder: this.placeholder, readonly: this.readonly, ref: (el) => {
+            this.input = el;
+          }, required: this.required }, this.value)),
+        this.type === 'date' && (h("span", { class: "xpl-input-calendar" },
+          h("i", { class: "far fa-calendar-alt" }))),
+        this.type === 'password' && (h("button", { class: "xpl-input-password", onClick: () => {
+            this.passwordVisible = !this.passwordVisible;
+          }, role: "presentation" },
+          h("span", { class: "sr-only" }, "Toggle password visibility"),
+          h("i", { class: "far fa-eye", style: {
+              display: this.passwordVisible
+                ? 'none'
+                : 'block',
+            } }),
+          h("i", { class: "far fa-eye-slash", style: {
+              display: this.passwordVisible
+                ? 'block'
+                : 'none',
+            } }))),
+        this.post && !this.multiline && (h("label", { class: "xpl-input-post", htmlFor: this._id }, this.post)),
+        this.multiline && this.maxCharacterCount !== undefined && (h("span", { class: "xpl-input-characters" },
+          this.characterCount,
+          "/",
+          this.maxCharacterCount))),
+      this.error !== undefined && this.error.length > 0 && (h("label", { class: "xpl-input-error", htmlFor: this._id },
+        h("svg", { width: "10", height: "11", viewBox: "0 0 10 11", fill: "none", xmlns: "http://www.w3.org/2000/svg" },
+          h("path", { d: "M9.84375 5.25C9.84375 2.59375 7.65625 0.40625 5 0.40625C2.32422 0.40625 0.15625 2.59375 0.15625 5.25C0.15625 7.92578 2.32422 10.0938 5 10.0938C7.65625 10.0938 9.84375 7.92578 9.84375 5.25ZM5 6.22656C5.48828 6.22656 5.89844 6.63672 5.89844 7.125C5.89844 7.63281 5.48828 8.02344 5 8.02344C4.49219 8.02344 4.10156 7.63281 4.10156 7.125C4.10156 6.63672 4.49219 6.22656 5 6.22656ZM4.14062 3.00391C4.12109 2.86719 4.23828 2.75 4.375 2.75H5.60547C5.74219 2.75 5.85938 2.86719 5.83984 3.00391L5.70312 5.66016C5.68359 5.79688 5.58594 5.875 5.46875 5.875H4.51172C4.39453 5.875 4.29688 5.79688 4.27734 5.66016L4.14062 3.00391Z" })),
+        this.error))));
+  }
+  static get is() { return "xpl-input"; }
+  static get properties() { return {
+    "_id": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Because `id` is a reserved HTMLElement attribute,\nwe prefix it with an underscore here so that it\ndoesn't get automatically applied to the outer container."
+      },
+      "attribute": "_id",
+      "reflect": false
+    },
+    "autocomplete": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "autocomplete",
+      "reflect": false
+    },
+    "dateFormat": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "See https://flatpickr.js.org/formatting/"
+      },
+      "attribute": "date-format",
+      "reflect": false,
+      "defaultValue": "'Y-m-d'"
+    },
+    "description": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Optional text that appears below the input label."
+      },
+      "attribute": "description",
+      "reflect": false
+    },
+    "disabled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "disabled",
+      "reflect": false
+    },
+    "error": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "If an empty string (attribute present with no value),\nwill display visually as an error. If a string is\nincluded, will display visually as an error and include\nthe value as an error message."
+      },
+      "attribute": "error",
+      "reflect": false
+    },
+    "label": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "label",
+      "reflect": false
+    },
+    "max": {
+      "type": "any",
+      "mutable": false,
+      "complexType": {
+        "original": "number | string",
+        "resolved": "number | string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Only used when `type` = 'number' or 'date'"
+      },
+      "attribute": "max",
+      "reflect": false
+    },
+    "maxCharacterCount": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "For multiline inputs, a max. character count will\ndisplay along with the current character count,\nand will automatically render as an error if the\ncharacter count exceeds the max."
+      },
+      "attribute": "max-character-count",
+      "reflect": false
+    },
+    "min": {
+      "type": "any",
+      "mutable": false,
+      "complexType": {
+        "original": "number | string",
+        "resolved": "number | string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Only used when `type` = 'number' or 'date'"
+      },
+      "attribute": "min",
+      "reflect": false
+    },
+    "mode": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "'single' | /* \"multiple\" | */ 'range'",
+        "resolved": "\"range\" | \"single\"",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "For datepicker inputs, whether to allow only a single\ndate or a range of dates. (Multiple non-consecutive\ndates planned to be supported in the future.)"
+      },
+      "attribute": "mode",
+      "reflect": false,
+      "defaultValue": "'single'"
+    },
+    "multiline": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Whether to render as a singleline text input or\nas a multiline textarea. (If `true`, `pre` and `post`\nvalues will be ignored, if present.)"
+      },
+      "attribute": "multiline",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "name": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Most inputs are used in forms, and should have a\n`name` associated with the input for handling form data."
+      },
+      "attribute": "name",
+      "reflect": false
+    },
+    "placeholder": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "placeholder",
+      "reflect": false
+    },
+    "post": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "A string (recommended max 3 characters) that gets shown\nvisually to the left of (before) the input."
+      },
+      "attribute": "post",
+      "reflect": false
+    },
+    "pre": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "A string (recommended max 8 characters) that gets shown\nvisually to the right of (after) the input."
+      },
+      "attribute": "pre",
+      "reflect": false
+    },
+    "readonly": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "readonly",
+      "reflect": false
+    },
+    "required": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "required",
+      "reflect": false
+    },
+    "step": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "step",
+      "reflect": false
+    },
+    "type": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "'date' | 'text' | 'number' | 'password'",
+        "resolved": "\"date\" | \"number\" | \"password\" | \"text\"",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "type",
+      "reflect": false,
+      "defaultValue": "'text'"
+    },
+    "value": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Including a `value` will prepopulate the input\nwith the given string."
+      },
+      "attribute": "value",
+      "reflect": false
+    }
+  }; }
+  static get states() { return {
+    "characterCount": {},
+    "passwordVisible": {}
+  }; }
+}

package/dist/collection/components/xpl-list/xpl-list.js

@@ -0,0 +1,91 @@
+/// <reference path="./listitem.d.ts"></reference>
+import { Component, Host, h, Prop, Fragment, } from '@stencil/core';
+import '../../../font-awesome/fontawesome';
+import '../../../font-awesome/regular';
+const ListItemCpt = ({ avatar, avatars, badges, href, title, subtext, metadata, }) => {
+  const hasRight = avatars || badges || subtext;
+  const inner = (h(Fragment, null,
+    avatar &&
+      (avatar.slice(0, 1) === '/' || avatar.slice(0, 4) === 'http' ? (h("xpl-avatar", { src: avatar, name: title })) : (h("xpl-avatar", { name: title }, avatar))),
+    h("div", { class: "xpl-list-item-content" },
+      h("div", { class: "xpl-list-left" },
+        h("div", null,
+          h("h4", null, title),
+          metadata && (h("ul", { class: "xpl-list-item-metadata" }, metadata.map((d) => {
+            if (typeof d === 'string') {
+              return h("li", null, d);
+            }
+            else {
+              return (h("li", null,
+                h("span", { class: `far fa-${d.icon}` }),
+                ' ',
+                d.text));
+            }
+          }))))),
+      hasRight && (h("div", { class: "xpl-list-right" },
+        subtext && (h("div", { class: "xpl-list-item-subtext" }, subtext)),
+        avatars && (h("div", { class: "xpl-avatar-group xpl-avatar-group--s" }, avatars.map((a) => (h("img", { src: a, alt: "" }))))),
+        badges &&
+          badges.map((b) => {
+            if (typeof b === 'string') {
+              return h("xpl-badge", null, b);
+            }
+            else {
+              return (h("xpl-badge", { dot: b.dot, variant: b.variant }, b.text));
+            }
+          }))))));
+  return href ? (h("a", { class: "xpl-list-item", href: href }, inner)) : (h("div", { class: "xpl-list-item" }, inner));
+};
+export class XplList {
+  constructor() {
+    /**
+     * `items` should be an array of objects with the following signature:
+     * {
+     *   avatar?: string;        // The URL of the avatar, or the placeholder initials (ex. "SPD").
+     *   avatars?: string[];     // The URLs of multiple avatars to be displayed in a group on the right.
+     *   badges?: string[] | {   // An array of strings or badge-like objects to be displayed as badges
+     *     dot?: boolean;        // in a group on the right. See <xpl-badge> for more details.
+     *     text: string;
+     *     variant?: string;
+     *   }[];
+     *   href?: string;          // A URL, if this list item is meant to link somewhere.
+     *   title: string;          // The text to be displayed for the list item.
+     *   metadata?: string[] | { // An array of strings or strings with icons (reference the allowed
+     *     icon: string;         // Font Awesome icons) to be displayed as metadata below the title.
+     *     text: string;
+     *   }[];
+     *   subtext?: string;       // Subtext to be displayed on the right.
+     * }
+     *
+     * - Note that you should *only use one of* `avatars`, `badges`, or `subtext`, to avoid cluttering
+     *   the right-hand side of the list item.
+     */
+    this.items = [];
+  }
+  render() {
+    return (h(Host, null, this.items.map((item) => (h(ListItemCpt, Object.assign({}, item))))));
+  }
+  static get is() { return "xpl-list"; }
+  static get properties() { return {
+    "items": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "ListItem[]",
+        "resolved": "ListItem[]",
+        "references": {
+          "ListItem": {
+            "location": "global"
+          }
+        }
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "`items` should be an array of objects with the following signature:\n{\n  avatar?: string;        // The URL of the avatar, or the placeholder initials (ex. \"SPD\").\n  avatars?: string[];     // The URLs of multiple avatars to be displayed in a group on the right.\n  badges?: string[] | {   // An array of strings or badge-like objects to be displayed as badges\n    dot?: boolean;        // in a group on the right. See <xpl-badge> for more details.\n    text: string;\n    variant?: string;\n  }[];\n  href?: string;          // A URL, if this list item is meant to link somewhere.\n  title: string;          // The text to be displayed for the list item.\n  metadata?: string[] | { // An array of strings or strings with icons (reference the allowed\n    icon: string;         // Font Awesome icons) to be displayed as metadata below the title.\n    text: string;\n  }[];\n  subtext?: string;       // Subtext to be displayed on the right.\n}\n\n- Note that you should *only use one of* `avatars`, `badges`, or `subtext`, to avoid cluttering\n  the right-hand side of the list item."
+      },
+      "defaultValue": "[]"
+    }
+  }; }
+}

package/dist/collection/components/xpl-main-nav/xpl-main-nav.js

@@ -0,0 +1,72 @@
+import { Component, Host, h, Prop, Event } from '@stencil/core';
+export class XplMainNav {
+  constructor() {
+    /**
+     * @property {string}  width  - The width of the Main Nav.
+     */
+    this.width = 'default';
+  }
+  navWidthHandler() {
+    this.navWidth.emit(this.width);
+  }
+  connectedCallback() {
+    this.navWidthHandler();
+  }
+  componentDidUpdate() {
+    this.navWidthHandler();
+  }
+  render() {
+    return (h(Host, { class: `xpl-main-nav xpl-main-nav--${this.width}`, "aria-label": "Sidebar" },
+      h("nav", null,
+        h("header", { "aria-label": "Sidebar Header" },
+          h("slot", { name: "logo" }),
+          h("slot", { name: "brand-name" })),
+        h("div", { class: "xpl-main-nav__main_section" },
+          h("slot", { name: "navigation" })),
+        h("footer", { class: "xpl-main-nav__footer", "aria-label": "Sidebar Footer" },
+          h("slot", { name: "footer" })))));
+  }
+  static get is() { return "xpl-main-nav"; }
+  static get properties() { return {
+    "width": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "'default' | 'md' | 'sm'",
+        "resolved": "\"default\" | \"md\" | \"sm\"",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "{string}  width  - The width of the Main Nav.",
+            "name": "property"
+          }],
+        "text": ""
+      },
+      "attribute": "width",
+      "reflect": false,
+      "defaultValue": "'default'"
+    }
+  }; }
+  static get events() { return [{
+      "method": "navWidth",
+      "name": "navWidth",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "text": "{string} navWidth - Emits the `nav-width` prop set by the user\nwhen the component is attached to the DOM and when the component is updated.",
+            "name": "event"
+          }],
+        "text": ""
+      },
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      }
+    }]; }
+}