@xplortech/apollo-core 1.0.0-beta.17 → 1.0.0-beta.2

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

@@ -1,57 +1,91 @@
-import { Host, h, Fragment, } from '@stencil/core';
+/// <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("xpl-icon", { icon: 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));
-      }
-    }))))));
+  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": "import",
-              "path": "./listitem"
-            }
+  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;         // Apollo 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": "[]"
-      }
-    };
-  }
+        }
+      },
+      "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": "[]"
+    }
+  }; }
 }
-//# sourceMappingURL=xpl-list.js.map

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

@@ -1,6 +1,9 @@
-import { Host, h } from '@stencil/core';
+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() {
@@ -13,54 +16,57 @@ export class XplMainNav {
     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" })))));
+    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": [{
-              "name": "property",
-              "text": "{string}  width  - The width of the Main Nav."
-            }],
-          "text": ""
-        },
-        "attribute": "width",
-        "reflect": false,
-        "defaultValue": "'default'"
+  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": {}
       }
-    };
-  }
-  static get events() {
-    return [{
-        "method": "navWidth",
-        "name": "navWidth",
-        "bubbles": true,
-        "cancelable": true,
-        "composed": true,
-        "docs": {
-          "tags": [{
-              "name": "event",
-              "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."
-            }],
-          "text": ""
-        },
-        "complexType": {
-          "original": "string",
-          "resolved": "string",
-          "references": {}
-        }
-      }];
-  }
+    }]; }
 }
-//# sourceMappingURL=xpl-main-nav.js.map

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

@@ -1,6 +1,9 @@
-import { Host, h } from '@stencil/core';
+import { Component, Event, Host, h, Prop } from '@stencil/core';
 export class XplNavItem {
   constructor() {
+    /**
+     * @property {boolean} - Whether or not the item should control the main nav state on click
+     */
     this.navControl = false;
   }
   onNavToggle() {
@@ -13,54 +16,52 @@ export class XplNavItem {
         if (this.navControl) {
           this.onNavToggle();
         }
-      } }, h("slot", { name: "link" }, h("slot", { name: "icon" }), h("slot", null))));
+      } },
+      h("slot", { name: "link" },
+        h("slot", { name: "icon" }),
+        h("slot", null))));
   }
   static get is() { return "xpl-nav-item"; }
-  static get properties() {
-    return {
-      "navControl": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [{
-              "name": "property",
-              "text": "{boolean} - Whether or not the item should control the main nav state on click"
-            }],
-          "text": ""
-        },
-        "attribute": "nav-control",
-        "reflect": false,
-        "defaultValue": "false"
+  static get properties() { return {
+    "navControl": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [{
+            "text": "{boolean} - Whether or not the item should control the main nav state on click",
+            "name": "property"
+          }],
+        "text": ""
+      },
+      "attribute": "nav-control",
+      "reflect": false,
+      "defaultValue": "false"
+    }
+  }; }
+  static get events() { return [{
+      "method": "navOpen",
+      "name": "navOpen",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "text": "{boolean} - Emits the desired state of the navigation bar (open: true/false)",
+            "name": "event"
+          }],
+        "text": ""
+      },
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
       }
-    };
-  }
-  static get events() {
-    return [{
-        "method": "navOpen",
-        "name": "navOpen",
-        "bubbles": true,
-        "cancelable": true,
-        "composed": true,
-        "docs": {
-          "tags": [{
-              "name": "event",
-              "text": "{boolean} - Emits the desired state of the navigation bar (open: true/false)"
-            }],
-          "text": ""
-        },
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        }
-      }];
-  }
+    }]; }
 }
-//# sourceMappingURL=xpl-nav-item.js.map

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

@@ -1,6 +1,7 @@
-import { Host, h, } from '@stencil/core';
+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
@@ -22,10 +23,6 @@ export class XplPagination {
       if (this.current < numPages)
         this._goto(this.current + 1);
     };
-    this.total = undefined;
-    this.perPage = undefined;
-    this.waitForCallback = undefined;
-    this.current = 1;
   }
   /**
    * Calling `goto` with a page number (which should probably be
@@ -57,123 +54,137 @@ export class XplPagination {
     }
     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" }))))))));
+    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
+  static get properties() { return {
+    "total": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
       },
-      "perPage": {
-        "type": "number",
-        "mutable": false,
-        "complexType": {
-          "original": "number",
-          "resolved": "number",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": ""
-        },
-        "attribute": "per-page",
-        "reflect": false
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": ""
       },
-      "waitForCallback": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": ""
-        },
-        "attribute": "wait-for-callback",
-        "reflect": false
+      "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 states() {
-    return {
-      "current": {}
-    };
-  }
-  static get events() {
-    return [{
-        "method": "page",
-        "name": "page",
-        "bubbles": true,
-        "cancelable": true,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": ""
+    }]; }
+  static get methods() { return {
+    "goto": {
+      "complexType": {
+        "signature": "(n: number) => Promise<void>",
+        "parameters": [{
+            "tags": [{
+                "text": "n",
+                "name": "param"
+              }],
+            "text": ""
+          }],
+        "references": {
+          "Promise": {
+            "location": "global"
+          }
         },
-        "complexType": {
-          "original": "any",
-          "resolved": "any",
-          "references": {}
-        }
-      }];
-  }
-  static get methods() {
-    return {
-      "goto": {
-        "complexType": {
-          "signature": "(n: number) => Promise<void>",
-          "parameters": [{
-              "tags": [{
-                  "name": "param",
-                  "text": "n"
-                }],
-              "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"
-            }]
-        }
+        "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"
+          }]
       }
-    };
-  }
+    }
+  }; }
 }
-//# sourceMappingURL=xpl-pagination.js.map