@saasquatch/mint-components 1.5.5 → 1.5.6-2

package/dist/collection/components/sqm-task-card/sqm-task-card.js

@@ -16,76 +16,94 @@ export class TaskCard {
     this.ignored = true;
     /**
      * @uiName Reward Amount
+     * @uiGroup Reward
      */
     this.rewardAmount = "0";
     /**
      * @uiName Reward Unit
+     * @uiGroup Reward
      */
     this.rewardUnit = "Points";
     /**
      * @uiName Title Text
+     * @uiGroup Task
      */
     this.cardTitle = "Title Text";
     /**
      * @uiName Description Text
+     * @uiGroup Task
      */
     this.description = "";
     /**
      * @uiName Goal Repeatable
+     * @uiGroup Goal
      */
     this.repeatable = false;
     /**
      * The number of times a reward can be earned.  Use zero for no limit (the default).
      *
      * @uiName Repeat Amount
+     * @uiGroup Reward
      */
     this.finite = 0;
     /**
      * @uiName Show Progress Bar
+     * @uiGroup Goal
      */
     this.showProgressBar = false;
     /**
      * Sets the goal for users progress to know when a task has been completed. If repeatable is checked, repeatable goals is an increment of this.
      *
      * @uiName Goal Completion Number
+     * @uiGroup Goal
      */
     this.goal = 1;
     /**
      * @uiName Progress Bar Steps
+     * @uiGroup Goal
      */
     this.steps = false;
     /**
      * @uiName Progress Bar Unit
+     * @uiGroup Goal
      */
     this.progressBarUnit = "";
     /**
      * @uiName Expiry Date Message
+     * @uiGroup Task
      */
     this.expiryMessage = "Ends {endDate}";
     /**
      * Shown to users before the start of the task duration.
      *
      * @uiName Start Date Message
+     * @uiGroup Task
      */
     this.startsOnMessage = "Starts {startDate}";
     /**
      * Shown to users after the end of the task duration.
      *
      * @uiName Ended Date Message
+     * @uiGroup Task
      */
     this.endedMessage = "Ended {endDate}";
     /**
      * Displays the amount of times that a user has completed a repeatable task.
      *
      * @uiName Completed Count Text
+     * @uiGroup Task
      */
     this.completedText = "Completed {finite, select, 0 {{count, plural, =1 {{count} time} other {{count} times}}} other {{count}/{finite} times}}";
     /**
      * @uiName CTA Button Text
+     * @uiGroup CTA Button
      */
     this.buttonText = "Complete Action";
     /**
-     * @uiName CTA Button Link Open in New Tab
+     * CTA Button Link Opens in New Tab
+     * @uiName Open In New Tab
+     * @uiGroup CTA Button
+     * @default undefined
      */
     this.openNewTab = false;
     withHooks(this);
@@ -123,6 +141,9 @@ export class TaskCard {
         "tags": [{
             "text": "Reward Amount",
             "name": "uiName"
+          }, {
+            "text": "Reward",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -144,6 +165,9 @@ export class TaskCard {
         "tags": [{
             "text": "Reward Unit",
             "name": "uiName"
+          }, {
+            "text": "Reward",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -165,6 +189,9 @@ export class TaskCard {
         "tags": [{
             "text": "Title Text",
             "name": "uiName"
+          }, {
+            "text": "Task",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -186,6 +213,9 @@ export class TaskCard {
         "tags": [{
             "text": "Description Text",
             "name": "uiName"
+          }, {
+            "text": "Task",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -207,6 +237,9 @@ export class TaskCard {
         "tags": [{
             "text": "Goal Repeatable",
             "name": "uiName"
+          }, {
+            "text": "Goal",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -228,6 +261,9 @@ export class TaskCard {
         "tags": [{
             "text": "Repeat Amount",
             "name": "uiName"
+          }, {
+            "text": "Reward",
+            "name": "uiGroup"
           }],
         "text": "The number of times a reward can be earned.  Use zero for no limit (the default)."
       },
@@ -249,6 +285,9 @@ export class TaskCard {
         "tags": [{
             "text": "Show Progress Bar",
             "name": "uiName"
+          }, {
+            "text": "Goal",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -270,6 +309,9 @@ export class TaskCard {
         "tags": [{
             "text": "Goal Completion Number",
             "name": "uiName"
+          }, {
+            "text": "Goal",
+            "name": "uiGroup"
           }],
         "text": "Sets the goal for users progress to know when a task has been completed. If repeatable is checked, repeatable goals is an increment of this."
       },
@@ -291,6 +333,9 @@ export class TaskCard {
         "tags": [{
             "text": "Progress Bar Steps",
             "name": "uiName"
+          }, {
+            "text": "Goal",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -312,6 +357,9 @@ export class TaskCard {
         "tags": [{
             "text": "Progress Bar Unit",
             "name": "uiName"
+          }, {
+            "text": "Goal",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -333,6 +381,9 @@ export class TaskCard {
         "tags": [{
             "text": "Expiry Date Message",
             "name": "uiName"
+          }, {
+            "text": "Task",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -359,7 +410,10 @@ export class TaskCard {
             "name": "uiWidget"
           }, {
             "text": "{\"allowPastDates\":true, \"months\": 1}",
-            "name": "uiOptions"
+            "name": "uiWidgetOptions"
+          }, {
+            "text": "Reward",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -380,6 +434,9 @@ export class TaskCard {
         "tags": [{
             "text": "Start Date Message",
             "name": "uiName"
+          }, {
+            "text": "Task",
+            "name": "uiGroup"
           }],
         "text": "Shown to users before the start of the task duration."
       },
@@ -406,7 +463,10 @@ export class TaskCard {
             "name": "uiWidget"
           }, {
             "text": "{\"allowPastDates\":true, \"months\": 1}",
-            "name": "uiOptions"
+            "name": "uiWidgetOptions"
+          }, {
+            "text": "Task",
+            "name": "uiGroup"
           }],
         "text": "Timeframe that the task card will be shown"
       },
@@ -427,6 +487,9 @@ export class TaskCard {
         "tags": [{
             "text": "Ended Date Message",
             "name": "uiName"
+          }, {
+            "text": "Task",
+            "name": "uiGroup"
           }],
         "text": "Shown to users after the end of the task duration."
       },
@@ -448,6 +511,9 @@ export class TaskCard {
         "tags": [{
             "text": "Completed Count Text",
             "name": "uiName"
+          }, {
+            "text": "Task",
+            "name": "uiGroup"
           }],
         "text": "Displays the amount of times that a user has completed a repeatable task."
       },
@@ -469,6 +535,9 @@ export class TaskCard {
         "tags": [{
             "text": "CTA Button Text",
             "name": "uiName"
+          }, {
+            "text": "CTA Button",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -490,6 +559,9 @@ export class TaskCard {
         "tags": [{
             "text": "CTA Button Link",
             "name": "uiName"
+          }, {
+            "text": "CTA Button",
+            "name": "uiGroup"
           }],
         "text": ""
       },
@@ -508,10 +580,16 @@ export class TaskCard {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "CTA Button Link Open in New Tab",
+            "text": "Open In New Tab",
             "name": "uiName"
+          }, {
+            "text": "CTA Button",
+            "name": "uiGroup"
+          }, {
+            "text": "undefined",
+            "name": "default"
           }],
-        "text": ""
+        "text": "CTA Button Link Opens in New Tab"
       },
       "attribute": "open-new-tab",
       "reflect": false,
@@ -536,7 +614,10 @@ export class TaskCard {
             "name": "uiName"
           }, {
             "text": "{\"version\": 1.1}",
-            "name": "uiOptions"
+            "name": "uiWidgetOptions"
+          }, {
+            "text": "Goal",
+            "name": "uiGroup"
           }],
         "text": "Select what type of stat to display for the goal. Manual paths are also supported."
       },
@@ -555,8 +636,11 @@ export class TaskCard {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Event key of task card button",
+            "text": "Task Card Button Event Key",
             "name": "uiName"
+          }, {
+            "text": "CTA Button",
+            "name": "uiGroup"
           }],
         "text": "Optionally send an event to SaaSquatch when a user clicks the CTA. This field configured what key of the event sent is."
       },
@@ -575,8 +659,11 @@ export class TaskCard {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Program ID override",
+            "text": "Program ID Override",
             "name": "uiName"
+          }, {
+            "text": "Goal",
+            "name": "uiGroup"
           }],
         "text": "The ID of the program that is used to scope the task card. Defaults to the program context when no ID is specified."
       },

package/dist/collection/components/sqm-text-span/sqm-text-span.js

@@ -48,7 +48,7 @@ export class Text {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Text",
+            "text": "Type",
             "name": "uiName"
           }, {
             "text": "string",

package/dist/collection/components/sqm-timeline/sqm-timeline-entry.js

@@ -5,6 +5,8 @@ import { getProps } from "../../utils/utils";
 import { TimelineEntryView } from "./sqm-timeline-entry-view";
 /**
  * @uiName Timeline Entry
+ * @validParents ["sqm-timeline"]
+ * @example Timeline Entry - <sqm-timeline-entry reward="$50" unit="visa giftcard" desc="You refer a friend" icon="circle" > </sqm-timeline-entry>
  */
 export class TimelineReward {
   constructor() {

package/dist/collection/components/sqm-timeline/sqm-timeline.js

@@ -2,8 +2,10 @@ import { withHooks } from "@saasquatch/stencil-hooks";
 import { Component, h, Prop, State } from "@stencil/core";
 import { useChildElements } from "../../tables/useChildElements";
 /**
- * @uiName Timeline
- */
+ * @uiName Program Timeline
+ * @slots [{"name":"","title":"Timeline","validChildren":["sqm-timeline-entry"]}]
+ * @examples Program Timeline - <sqm-timeline icon="circle"> <sqm-timeline-entry reward="$50" unit="visa giftcard" desc="You refer a friend" icon="circle" > </sqm-timeline-entry> <sqm-timeline-entry reward="$200" unit="visa giftcard" desc="Our sales team qualifies your friend as a good fit for our Enterprise plan" icon="circle" > </sqm-timeline-entry> <sqm-timeline-entry reward="$1000" unit="visa giftcard" desc="Your friend purchases an Enterprise plan" icon="circle" > </sqm-timeline-entry></sqm-timeline>
+*/
 export class Timeline {
   constructor() {
     this.ignored = true;

package/dist/collection/components/sqm-titled-section/sqm-titled-section.js

@@ -15,14 +15,14 @@ export class TitledSection {
      */
     this.textAlign = "left";
     /**
-     * @uiName Label margin style
+     * @uiName Label Margin Style
      * @uiType string
      * @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
      * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
      */
     this.labelMargin = "small";
     /**
-     * @uiName Section padding
+     * @uiName Section Padding
      * @uiType string
      * @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]
      * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
@@ -106,7 +106,7 @@ export class TitledSection {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Label margin style",
+            "text": "Label Margin Style",
             "name": "uiName"
           }, {
             "text": "string",
@@ -141,7 +141,7 @@ export class TitledSection {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Section padding",
+            "text": "Section Padding",
             "name": "uiName"
           }, {
             "text": "string",

package/dist/collection/components/sqm-user-name/sqm-user-name.js

@@ -11,11 +11,12 @@ export class UserName {
   constructor() {
     this._ignored = true;
     /**
-     * @uiName Fallback name for nameless users
+     * Fallback name for unknown users
+     * @uiName Fallback Name
      */
     this.fallback = "Anonymous User";
     /**
-     * @uiName Loading text
+     * @uiName Loading Text
      */
     this.loadingText = "...";
     withHooks(this);
@@ -40,10 +41,10 @@ export class UserName {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Fallback name for nameless users",
+            "text": "Fallback Name",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Fallback name for unknown users"
       },
       "attribute": "fallback",
       "reflect": false,
@@ -61,7 +62,7 @@ export class UserName {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Loading text",
+            "text": "Loading Text",
             "name": "uiName"
           }],
         "text": ""