@xplortech/apollo-core 0.5.0 → 0.5.1

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

@@ -0,0 +1,93 @@
+/// <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": {}
+      }
+    }]; }
+}

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

@@ -0,0 +1,10 @@
+import { Component, Host, h } from '@stencil/core';
+export class XplNavItem {
+  render() {
+    return (h(Host, { class: "xpl-nav-item", role: "listitem" },
+      h("slot", { name: "link" },
+        h("slot", { name: "icon" }),
+        h("slot", null))));
+  }
+  static get is() { return "xpl-nav-item"; }
+}

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

@@ -0,0 +1,189 @@
+import { Component, Host, h, Event, Prop, State, Method, } from "@stencil/core";
+export class XplPagination {
+  constructor() {
+    this.current = 1;
+    /**
+     * Private `_goto` method respects the `waitForCallback` prop --
+     * it will always emit the `page` event, but won't actually update
+     * the state of what the current page is, leaving that to the caller
+     * to update once (presumably) some other data has loaded.
+     */
+    this._goto = (n) => {
+      this.page.emit(n);
+      if (!this.waitForCallback) {
+        this.current = n;
+      }
+    };
+    this.goPrev = () => {
+      if (this.current > 1)
+        this._goto(this.current - 1);
+    };
+    this.goNext = () => {
+      const numPages = Math.ceil(this.total / this.perPage);
+      if (this.current < numPages)
+        this._goto(this.current + 1);
+    };
+  }
+  /**
+   * Calling `goto` with a page number (which should probably be
+   * taken from the `page` event) updates the pagination's state
+   * and re-renders it, showing the appropriate buttons given the current page.
+   * @param n
+   */
+  async goto(n) {
+    this.current = n;
+  }
+  render() {
+    const numPages = Math.ceil(this.total / this.perPage);
+    let showing = [1];
+    if (numPages < 7)
+      showing = [1, 2, 3, 4, 5, 6];
+    if (this.current <= 3 || this.current >= numPages - 2) {
+      showing = [1, 2, 3, "...", numPages - 2, numPages - 1, numPages];
+    }
+    else {
+      showing = [
+        1,
+        "...",
+        this.current - 1,
+        this.current,
+        this.current + 1,
+        "...",
+        numPages,
+      ];
+    }
+    const showingFirst = (this.current - 1) * this.perPage + 1;
+    const showingLast = Math.min(showingFirst + this.perPage - 1, this.total);
+    return (h(Host, null,
+      h("div", { class: "xpl-pagination" },
+        h("div", null,
+          h("p", null,
+            "Showing ",
+            h("span", null, showingFirst),
+            " to ",
+            h("span", null, showingLast),
+            " ",
+            "of ",
+            h("span", null, this.total),
+            " results")),
+        h("div", null,
+          h("nav", { "aria-label": "Pagination" },
+            h("button", { onClick: this.goPrev, class: "xpl-pagination-prev" },
+              h("span", null, "Previous"),
+              h("svg", { viewBox: "0 0 20 20", "aria-hidden": "true" },
+                h("path", { "fill-rule": "evenodd", d: "M12.707 5.293a1 1 0 010 1.414L9.414 10l3.293 3.293a1 1 0 01-1.414 1.414l-4-4a1 1 0 010-1.414l4-4a1 1 0 011.414 0z", "clip-rule": "evenodd" }))),
+            showing.map((n) => {
+              if (n === "...") {
+                return h("span", { class: "xpl-pagination-ellipsis" }, "...");
+              }
+              if (n === this.current) {
+                return (h("button", { "aria-current": "page", class: "xpl-pagination-current" }, n));
+              }
+              return h("button", { onClick: () => this._goto(n) }, n);
+            }),
+            h("button", { onClick: this.goNext, class: "xpl-pagination-next" },
+              h("span", null, "Next"),
+              h("svg", { viewBox: "0 0 20 20", "aria-hidden": "true" },
+                h("path", { "fill-rule": "evenodd", d: "M7.293 14.707a1 1 0 010-1.414L10.586 10 7.293 6.707a1 1 0 011.414-1.414l4 4a1 1 0 010 1.414l-4 4a1 1 0 01-1.414 0z", "clip-rule": "evenodd" }))))))));
+  }
+  static get is() { return "xpl-pagination"; }
+  static get properties() { return {
+    "total": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "total",
+      "reflect": false
+    },
+    "perPage": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "per-page",
+      "reflect": false
+    },
+    "waitForCallback": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "wait-for-callback",
+      "reflect": false
+    }
+  }; }
+  static get states() { return {
+    "current": {}
+  }; }
+  static get events() { return [{
+      "method": "page",
+      "name": "page",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      }
+    }]; }
+  static get methods() { return {
+    "goto": {
+      "complexType": {
+        "signature": "(n: number) => Promise<void>",
+        "parameters": [{
+            "tags": [{
+                "text": "n",
+                "name": "param"
+              }],
+            "text": ""
+          }],
+        "references": {
+          "Promise": {
+            "location": "global"
+          }
+        },
+        "return": "Promise<void>"
+      },
+      "docs": {
+        "text": "Calling `goto` with a page number (which should probably be\ntaken from the `page` event) updates the pagination's state\nand re-renders it, showing the appropriate buttons given the current page.",
+        "tags": [{
+            "name": "param",
+            "text": "n"
+          }]
+      }
+    }
+  }; }
+}

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

@@ -0,0 +1,168 @@
+import { Component, Host, h, Prop, State, Event } from "@stencil/core";
+import { v4 as uuid } from "uuid";
+export class XplRadio {
+  constructor() {
+    this.id = uuid();
+  }
+  render() {
+    return (h(Host, { class: {
+        "xpl-checkbox-radio-container": true,
+        "styled": this.styled,
+        "disabled": this.disabled,
+      } },
+      h("input", { class: "xpl-radio", type: "radio", checked: this.checked, disabled: this.disabled, id: this.id, name: this.name, required: this.required, value: this.value, onChange: () => this.radioChange.emit(true) }),
+      h("label", { class: {
+          "xpl-label": true,
+          "xpl-label--disabled": this.disabled
+        }, htmlFor: this.id },
+        h("slot", null),
+        this.description && h("small", { class: {
+            "xpl-description": true,
+            "xpl-description--disabled": this.disabled
+          } }, this.description))));
+  }
+  static get is() { return "xpl-radio"; }
+  static get properties() { return {
+    "checked": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "checked",
+      "reflect": false
+    },
+    "description": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "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
+    },
+    "name": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "name",
+      "reflect": false
+    },
+    "required": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "required",
+      "reflect": false
+    },
+    "styled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "styled",
+      "reflect": false
+    },
+    "value": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "value",
+      "reflect": false
+    }
+  }; }
+  static get states() { return {
+    "id": {}
+  }; }
+  static get events() { return [{
+      "method": "radioChange",
+      "name": "radioChange",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "text": undefined,
+            "name": "private"
+          }],
+        "text": ""
+      },
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      }
+    }]; }
+}

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

@@ -0,0 +1,9 @@
+import { Component, Host, h } from '@stencil/core';
+export class XplSecondaryNav {
+  render() {
+    return (h(Host, { class: "xpl-secondary-nav" },
+      h("nav", { "aria-label": "Secondary Nav" },
+        h("slot", null))));
+  }
+  static get is() { return "xpl-secondary-nav"; }
+}