@saasquatch/mint-components 1.6.0 → 1.6.1-10

package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-rewards-column.js

@@ -1,305 +1,328 @@
-import { withHooks } from "@saasquatch/stencil-hooks";
-import { Component, h, Host, Method, Prop } from "@stencil/core";
-import { useRequestRerender } from "../../../tables/re-render";
-/**
- * @uiName Referral Table Rewards Column
- */
-export class ReferralTableRewardsColumn {
-  constructor() {
-    /**
-     * @uiName Reward column title
-     */
-    this.columnTitle = "Rewards";
-    /**
-     * @uiName Reward Status Text
-     */
-    this.statusText = "{status, select, AVAILABLE {Available} CANCELLED {Cancelled} PENDING {Pending} EXPIRED {Expired} REDEEMED {Redeemed} other {Not available} }";
-    /**
-     * @uiName Reward Status Long Text
-     */
-    this.statusLongText = "{status, select, AVAILABLE {Reward expiring on} CANCELLED {Reward cancelled on} PENDING {Available on} EXPIRED {Reward expired on} other {Not available} }";
-    /**
-     * @uiName Fuel Tank Code Text
-     */
-    this.fuelTankText = "Your code is";
-    /**
-     * @uiName Reward Received Text
-     */
-    this.rewardReceivedText = "Reward received on";
-    /**
-     * @uiName Reward Expiring Text
-     */
-    this.expiringText = "Expiring in";
-    /**
-     * @uiName Reward Pending Text
-     */
-    this.pendingForText = "{status} for {date}";
-    /**
-     * @uiName Hide dropdown details of reward
-     */
-    this.hideDetails = false;
-    withHooks(this);
-  }
-  disconnectedCallback() { }
-  async renderCell(data, locale) {
-    // TODO: Do the right thing with many rewards, pending rewards, canceled rewards
-    return (h("sqm-referral-table-rewards-cell", { rewards: data.rewards, statusText: this.statusText, statusLongText: this.statusLongText, fuelTankText: this.fuelTankText, rewardReceivedText: this.rewardReceivedText, expiringText: this.expiringText, pendingForText: this.pendingForText, hideDetails: this.hideDetails, locale: locale }));
-  }
-  async renderLabel() {
-    return this.columnTitle;
-  }
-  async renderReferrerCell(data) {
-    // TODO: Do the right thing with many rewards, pending rewards, canceled rewards
-    return (h("sqm-referral-table-rewards-cell", { rewards: data.rewards }));
-  }
-  render() {
-    useRequestRerender([
-      this.columnTitle,
-      this.statusText,
-      this.statusLongText,
-      this.fuelTankText,
-      this.rewardReceivedText,
-      this.expiringText,
-      this.pendingForText,
-      this.hideDetails,
-    ]);
-    return h(Host, { style: { display: "none" } });
-  }
-  static get is() { return "sqm-referral-table-rewards-column"; }
-  static get encapsulation() { return "shadow"; }
-  static get properties() { return {
-    "columnTitle": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "text": "Reward column title",
-            "name": "uiName"
-          }],
-        "text": ""
-      },
-      "attribute": "column-title",
-      "reflect": false,
-      "defaultValue": "\"Rewards\""
-    },
-    "statusText": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "text": "Reward Status Text",
-            "name": "uiName"
-          }],
-        "text": ""
-      },
-      "attribute": "status-text",
-      "reflect": false,
-      "defaultValue": "\"{status, select, AVAILABLE {Available} CANCELLED {Cancelled} PENDING {Pending} EXPIRED {Expired} REDEEMED {Redeemed} other {Not available} }\""
-    },
-    "statusLongText": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "text": "Reward Status Long Text",
-            "name": "uiName"
-          }],
-        "text": ""
-      },
-      "attribute": "status-long-text",
-      "reflect": false,
-      "defaultValue": "\"{status, select, AVAILABLE {Reward expiring on} CANCELLED {Reward cancelled on} PENDING {Available on} EXPIRED {Reward expired on} other {Not available} }\""
-    },
-    "fuelTankText": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "text": "Fuel Tank Code Text",
-            "name": "uiName"
-          }],
-        "text": ""
-      },
-      "attribute": "fuel-tank-text",
-      "reflect": false,
-      "defaultValue": "\"Your code is\""
-    },
-    "rewardReceivedText": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "text": "Reward Received Text",
-            "name": "uiName"
-          }],
-        "text": ""
-      },
-      "attribute": "reward-received-text",
-      "reflect": false,
-      "defaultValue": "\"Reward received on\""
-    },
-    "expiringText": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "text": "Reward Expiring Text",
-            "name": "uiName"
-          }],
-        "text": ""
-      },
-      "attribute": "expiring-text",
-      "reflect": false,
-      "defaultValue": "\"Expiring in\""
-    },
-    "pendingForText": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "text": "Reward Pending Text",
-            "name": "uiName"
-          }],
-        "text": ""
-      },
-      "attribute": "pending-for-text",
-      "reflect": false,
-      "defaultValue": "\"{status} for {date}\""
-    },
-    "hideDetails": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "text": "Hide dropdown details of reward",
-            "name": "uiName"
-          }],
-        "text": ""
-      },
-      "attribute": "hide-details",
-      "reflect": false,
-      "defaultValue": "false"
-    }
-  }; }
-  static get methods() { return {
-    "renderCell": {
-      "complexType": {
-        "signature": "(data: Referral, locale: string) => Promise<any>",
-        "parameters": [{
-            "tags": [],
-            "text": ""
-          }, {
-            "tags": [],
-            "text": ""
-          }],
-        "references": {
-          "Promise": {
-            "location": "global"
-          },
-          "Referral": {
-            "location": "global"
-          }
-        },
-        "return": "Promise<any>"
-      },
-      "docs": {
-        "text": "",
-        "tags": []
-      }
-    },
-    "renderLabel": {
-      "complexType": {
-        "signature": "() => Promise<string>",
-        "parameters": [],
-        "references": {
-          "Promise": {
-            "location": "global"
-          }
-        },
-        "return": "Promise<string>"
-      },
-      "docs": {
-        "text": "",
-        "tags": []
-      }
-    },
-    "renderReferrerCell": {
-      "complexType": {
-        "signature": "(data: Referrer) => Promise<any>",
-        "parameters": [{
-            "tags": [],
-            "text": ""
-          }],
-        "references": {
-          "Promise": {
-            "location": "global"
-          },
-          "Referrer": {
-            "location": "global"
-          }
-        },
-        "return": "Promise<any>"
-      },
-      "docs": {
-        "text": "",
-        "tags": []
-      }
-    }
-  }; }
-}
+import { withHooks } from "@saasquatch/stencil-hooks";
+import { Component, h, Host, Method, Prop } from "@stencil/core";
+import { useRequestRerender } from "../../../tables/re-render";
+/**
+ * @uiName Referral Table Rewards Column
+ * @validParents ["sqm-referral-table"]
+ * @exampleGroup Referrals
+ * @example Referral Table Rewards Column - <sqm-referral-table-rewards-column column-title="Rewards" status-text="{status, select, AVAILABLE {Available} CANCELLED {Cancelled} PENDING {Pending} EXPIRED {Expired} REDEEMED {Redeemed} other {Not available} }" status-long-text="{status, select, AVAILABLE {Reward expiring on} CANCELLED {Reward cancelled on} PENDING {Available on} EXPIRED {Reward expired on} other {Not available} }" fuel-tank-text="Your code is" reward-received-text="Reward received on" expiring-text="Expiring in" pending-for-text="{status} for {date}"></sqm-referral-table-rewards-column>
+ */
+export class ReferralTableRewardsColumn {
+  constructor() {
+    /**
+     * @uiName Reward column title
+     */
+    this.columnTitle = "Rewards";
+    /**
+     * Text shown in the reward status badge.
+     *
+     * @uiName Reward Status Text
+     * @uiWidget textArea
+     */
+    this.statusText = "{status, select, AVAILABLE {Available} CANCELLED {Cancelled} PENDING {Pending} EXPIRED {Expired} REDEEMED {Redeemed} other {Not available} }";
+    /**
+     * Additional status text shown in the details drop down.
+     *
+     * @uiName Reward Status Long Text
+     * @uiWidget textArea
+     */
+    this.statusLongText = "{status, select, AVAILABLE {Reward expiring on} CANCELLED {Reward cancelled on} PENDING {Available on} EXPIRED {Reward expired on} other {Not available} }";
+    /**
+     * Shown in the dropdown details when a reward has an associated fuel tank code.
+     *
+     * @uiName Fuel Tank Code Text
+     */
+    this.fuelTankText = "Your code is";
+    /**
+     * Shown in the dropdown details when a reward has been received.’
+     *
+     * @uiName Reward Received Text
+     */
+    this.rewardReceivedText = "Reward received on";
+    /**
+     * Shown in the dropdown details when a reward has an expiry date.
+     *
+     * @uiName Reward Expiring Text
+     */
+    this.expiringText = "Expiring in";
+    /**
+     * Shown in the dropdown details when a reward is pending.
+     *
+     * @uiName Reward Pending Text
+     */
+    this.pendingForText = "{status} for {date}";
+    /**
+     * @uiName Hide dropdown details of reward
+     */
+    this.hideDetails = false;
+    withHooks(this);
+  }
+  disconnectedCallback() { }
+  async renderCell(data, locale) {
+    // TODO: Do the right thing with many rewards, pending rewards, canceled rewards
+    return (h("sqm-referral-table-rewards-cell", { rewards: data.rewards, statusText: this.statusText, statusLongText: this.statusLongText, fuelTankText: this.fuelTankText, rewardReceivedText: this.rewardReceivedText, expiringText: this.expiringText, pendingForText: this.pendingForText, hideDetails: this.hideDetails, locale: locale }));
+  }
+  async renderLabel() {
+    return this.columnTitle;
+  }
+  async renderReferrerCell(data) {
+    // TODO: Do the right thing with many rewards, pending rewards, canceled rewards
+    return (h("sqm-referral-table-rewards-cell", { rewards: data.rewards }));
+  }
+  render() {
+    useRequestRerender([
+      this.columnTitle,
+      this.statusText,
+      this.statusLongText,
+      this.fuelTankText,
+      this.rewardReceivedText,
+      this.expiringText,
+      this.pendingForText,
+      this.hideDetails,
+    ]);
+    return h(Host, { style: { display: "none" } });
+  }
+  static get is() { return "sqm-referral-table-rewards-column"; }
+  static get encapsulation() { return "shadow"; }
+  static get properties() { return {
+    "columnTitle": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Reward column title",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "column-title",
+      "reflect": false,
+      "defaultValue": "\"Rewards\""
+    },
+    "statusText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Reward Status Text",
+            "name": "uiName"
+          }, {
+            "text": "textArea",
+            "name": "uiWidget"
+          }],
+        "text": "Text shown in the reward status badge."
+      },
+      "attribute": "status-text",
+      "reflect": false,
+      "defaultValue": "\"{status, select, AVAILABLE {Available} CANCELLED {Cancelled} PENDING {Pending} EXPIRED {Expired} REDEEMED {Redeemed} other {Not available} }\""
+    },
+    "statusLongText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Reward Status Long Text",
+            "name": "uiName"
+          }, {
+            "text": "textArea",
+            "name": "uiWidget"
+          }],
+        "text": "Additional status text shown in the details drop down."
+      },
+      "attribute": "status-long-text",
+      "reflect": false,
+      "defaultValue": "\"{status, select, AVAILABLE {Reward expiring on} CANCELLED {Reward cancelled on} PENDING {Available on} EXPIRED {Reward expired on} other {Not available} }\""
+    },
+    "fuelTankText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Fuel Tank Code Text",
+            "name": "uiName"
+          }],
+        "text": "Shown in the dropdown details when a reward has an associated fuel tank code."
+      },
+      "attribute": "fuel-tank-text",
+      "reflect": false,
+      "defaultValue": "\"Your code is\""
+    },
+    "rewardReceivedText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Reward Received Text",
+            "name": "uiName"
+          }],
+        "text": "Shown in the dropdown details when a reward has been received.\u2019"
+      },
+      "attribute": "reward-received-text",
+      "reflect": false,
+      "defaultValue": "\"Reward received on\""
+    },
+    "expiringText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Reward Expiring Text",
+            "name": "uiName"
+          }],
+        "text": "Shown in the dropdown details when a reward has an expiry date."
+      },
+      "attribute": "expiring-text",
+      "reflect": false,
+      "defaultValue": "\"Expiring in\""
+    },
+    "pendingForText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Reward Pending Text",
+            "name": "uiName"
+          }],
+        "text": "Shown in the dropdown details when a reward is pending."
+      },
+      "attribute": "pending-for-text",
+      "reflect": false,
+      "defaultValue": "\"{status} for {date}\""
+    },
+    "hideDetails": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Hide dropdown details of reward",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "hide-details",
+      "reflect": false,
+      "defaultValue": "false"
+    }
+  }; }
+  static get methods() { return {
+    "renderCell": {
+      "complexType": {
+        "signature": "(data: Referral, locale: string) => Promise<any>",
+        "parameters": [{
+            "tags": [],
+            "text": ""
+          }, {
+            "tags": [],
+            "text": ""
+          }],
+        "references": {
+          "Promise": {
+            "location": "global"
+          },
+          "Referral": {
+            "location": "global"
+          }
+        },
+        "return": "Promise<any>"
+      },
+      "docs": {
+        "text": "",
+        "tags": []
+      }
+    },
+    "renderLabel": {
+      "complexType": {
+        "signature": "() => Promise<string>",
+        "parameters": [],
+        "references": {
+          "Promise": {
+            "location": "global"
+          }
+        },
+        "return": "Promise<string>"
+      },
+      "docs": {
+        "text": "",
+        "tags": []
+      }
+    },
+    "renderReferrerCell": {
+      "complexType": {
+        "signature": "(data: Referrer) => Promise<any>",
+        "parameters": [{
+            "tags": [],
+            "text": ""
+          }],
+        "references": {
+          "Promise": {
+            "location": "global"
+          },
+          "Referrer": {
+            "location": "global"
+          }
+        },
+        "return": "Promise<any>"
+      },
+      "docs": {
+        "text": "",
+        "tags": []
+      }
+    }
+  }; }
+}