@saasquatch/mint-components 1.5.5 → 1.5.6-2

package/dist/types/components/sqm-share-button/sqm-share-button.d.ts

@@ -3,6 +3,16 @@ import { DemoData } from "../../global/demo";
 /**
  * @uiName Share Button
  * @uiOrder ["medium", "program-id", "*", "pill", "disabled", "hideicon"]
+ * @example Facebook Share Button - <sqm-share-button medium="facebook">Share on Facebook</sqm-share-button>
+ * @example Twitter Share Button - <sqm-share-button medium="twitter">Share via Tweet</sqm-share-button>
+ * @example Email Share Button - <sqm-share-button medium="email">Share via Email</sqm-share-button>
+ * @example Web Share Sheet Share Button - <sqm-share-button medium="direct">Share</sqm-share-button>
+ * @example LinkedIn Share Button - <sqm-share-button medium="linkedin">Share on LinkedIn</sqm-share-button>
+ * @example SMS Share Button - <sqm-share-button medium="sms">Text a friend</sqm-share-button>
+ * @example Facebook Messenger Share Button - <sqm-share-button medium="fbmessenger">Share via Messenger</sqm-share-button>
+ * @example WhatsApp Share Button - <sqm-share-button medium="whatsapp">Share via WhatsApp</sqm-share-button>
+ * @example Line Messenger Share Button - <sqm-share-button medium="linemessenger">Share via Line Messenger</sqm-share-button>
+ * @example Pinterest Share Button - <sqm-share-button medium="pinterest">Share on Pinterest</sqm-share-button>
  */
 export declare class ShareButton {
   /**
@@ -22,21 +32,22 @@ export declare class ShareButton {
    */
   programId?: string;
   /**
-   * @uiName Configure border radius with pixel amount
+   * Configure border radius with pixel amount
+   * @uiName Border Radius
    */
   borderradius?: number;
   /**
-   * @uiName Button background color
+   * @uiName Button Background Color
    * @uiWidget color
    */
   backgroundcolor?: string;
   /**
-   * @uiName Button text color
+   * @uiName Button Text Color
    * @uiWidget color
    */
   textcolor?: string;
   /**
-   * @uiName Display as pill
+   * @uiName Display Pill
    */
   pill?: boolean;
   /**
@@ -67,23 +78,27 @@ export declare class ShareButton {
   /**
    * Options available at https://shoelace.style/components/icon
    *
-   * @uiName Icon used in button. Will try to select an icon based on the share medium if left empty.
+   * Icon used in button. Will try to select an icon based on the share medium if left empty.
+   *
+   * @uiName Icon
    */
   icon?: string;
   /**
-   * @uiName Hide the icon
+   * @uiName Hide Icon
    */
   hideicon?: boolean;
   /**
-   * @uiName Hide the text
+   * @uiName Hide Text
    */
   hidetext?: boolean;
   /**
-   * @uiName Title used for native sharing (mobile only)
+   * Title used for native sharing (mobile only)
+   * @uiName Share Title
    */
   sharetitle?: string;
   /**
-   * @uiName Text used for native sharing (mobile only)
+   * Text used for native sharing (mobile only)
+   * @uiName Share Text
    */
   sharetext?: string;
   /**

package/dist/types/components/sqm-share-code/sqm-share-code.d.ts

@@ -2,6 +2,7 @@ import { ShareLinkViewProps } from "../sqm-share-link/sqm-share-link-view";
 import { DemoData } from "../../global/demo";
 /**
  * @uiName Share Code
+ * @example Share Code - <sqm-share-code tooltip-text="Copied to Clipboard" tooltip-lifespan="1000"></sqm-share-code>
  */
 export declare class ShareCode {
   /**
@@ -11,9 +12,9 @@ export declare class ShareCode {
    */
   programId?: string;
   /**
-   * This is shown after someone has successfully copied the cpde to the clipboard.
+   * This is shown after someone has successfully copied the code to the clipboard.
    *
-   * @uiName Tooltip text
+   * @uiName Tooltip Text
    */
   tooltiptext: string;
   /**

package/dist/types/components/sqm-share-link/sqm-share-link.d.ts

@@ -2,6 +2,7 @@ import { ShareLinkViewProps } from "./sqm-share-link-view";
 import { DemoData } from "../../global/demo";
 /**
  * @uiName Share Link
+ * @example Share Link - <sqm-share-link tooltip-text="Copied to Clipboard" tooltip-lifespan="1000"></sqm-share-link>
  */
 export declare class ShareLink {
   /**
@@ -13,13 +14,13 @@ export declare class ShareLink {
   /**
    * This is shown after someone has successfully copied the link to the clipboard.
    *
-   * @uiName Tooltip text
+   * @uiName Tooltip Text
    */
   tooltiptext: string;
   /**
    * The number of milliseconds that the tooltip will appear for
    *
-   * @uiName Tooltip lifespan
+   * @uiName Tooltip Lifespan
    */
   tooltiplifespan: number;
   /**

package/dist/types/components/sqm-stat-container/sqm-stat-container.d.ts

@@ -1,11 +1,12 @@
 import { Spacing } from "../../global/mixins";
 /**
  * @uiName Stat Container
+ * @slots [{"name":"","title":"Stats"}]
  */
 export declare class StatContainer {
   ignored: boolean;
   /**
-   * @uiName Space between stats
+   * @uiName Space Between Stats
    * @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"]

package/dist/types/components/sqm-tab/sqm-tab.d.ts

@@ -1,5 +1,6 @@
 /**
  * @uiName Tab
+ * @validParents ["sqm-tabs"]
  */
 export declare class Tab {
   /** @uiName Tab Title  */

package/dist/types/components/sqm-task-card/sqm-task-card.d.ts

@@ -9,62 +9,75 @@ export declare class TaskCard {
   ignored: boolean;
   /**
    * @uiName Reward Amount
+   * @uiGroup Reward
    */
   rewardAmount: string;
   /**
    * @uiName Reward Unit
+   * @uiGroup Reward
    */
   rewardUnit: string;
   /**
    * @uiName Title Text
+   * @uiGroup Task
    */
   cardTitle: string;
   /**
    * @uiName Description Text
+   * @uiGroup Task
    */
   description: string;
   /**
    * @uiName Goal Repeatable
+   * @uiGroup Goal
    */
   repeatable: boolean;
   /**
    * The number of times a reward can be earned.  Use zero for no limit (the default).
    *
    * @uiName Repeat Amount
+   * @uiGroup Reward
    */
   finite: number;
   /**
    * @uiName Show Progress Bar
+   * @uiGroup Goal
    */
   showProgressBar: boolean;
   /**
    * 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
    */
   goal: number;
   /**
    * @uiName Progress Bar Steps
+   * @uiGroup Goal
    */
   steps: boolean;
   /**
    * @uiName Progress Bar Unit
+   * @uiGroup Goal
    */
   progressBarUnit: string;
   /**
    * @uiName Expiry Date Message
+   * @uiGroup Task
    */
   expiryMessage: string;
   /**
    * @uiName Reward Duration
    * @uiWidget DateRange
-   * @uiOptions {"allowPastDates":true, "months": 1}
+   * @uiWidgetOptions {"allowPastDates":true, "months": 1}
+   * @uiGroup Reward
    */
   rewardDuration: string;
   /**
    * Shown to users before the start of the task duration.
    *
    * @uiName Start Date Message
+   * @uiGroup Task
    */
   startsOnMessage: string;
   /**
@@ -72,31 +85,39 @@ export declare class TaskCard {
    *
    * @uiName Display Duration
    * @uiWidget DateRange
-   * @uiOptions {"allowPastDates":true, "months": 1}
+   * @uiWidgetOptions {"allowPastDates":true, "months": 1}
+   * @uiGroup Task
    */
   displayDuration: string;
   /**
    * Shown to users after the end of the task duration.
    *
    * @uiName Ended Date Message
+   * @uiGroup Task
    */
   endedMessage: string;
   /**
    * Displays the amount of times that a user has completed a repeatable task.
    *
    * @uiName Completed Count Text
+   * @uiGroup Task
    */
   completedText: string;
   /**
    * @uiName CTA Button Text
+   * @uiGroup CTA Button
    */
   buttonText: string;
   /**
    * @uiName CTA Button Link
+   * @uiGroup CTA Button
    */
   buttonLink: string;
   /**
-   * @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
    */
   openNewTab: boolean;
   /**
@@ -104,17 +125,22 @@ export declare class TaskCard {
    *
    * @uiWidget StatTypeSelectWidget
    * @uiName Goal Progress Source
-   * @uiOptions {"version": 1.1}
+   * @uiWidgetOptions {"version": 1.1}
+   * @uiGroup Goal
    */
   statType: string;
   /**
-  * Optionally send an event to SaaSquatch when a user clicks the CTA. This field configured what key of the event sent is.
-   * @uiName Event key of task card button
+   * Optionally send an event to SaaSquatch when a user clicks the CTA. This field configured what key of the event sent is.
+   *
+   * @uiName Task Card Button Event Key
+   * @uiGroup CTA Button
    */
   eventKey?: string;
   /**
-  * The ID of the program that is used to scope the task card. Defaults to the program context when no ID is specified.
-   * @uiName Program ID override
+   * The ID of the program that is used to scope the task card. Defaults to the program context when no ID is specified.
+   *
+   * @uiName Program ID Override
+   * @uiGroup Goal
    */
   programId?: string;
   /**

package/dist/types/components/sqm-text-span/sqm-text-span.d.ts

@@ -8,7 +8,7 @@ export declare class Text {
    */
   text: string;
   /**
-   * @uiName Text
+   * @uiName Type
    * @uiType string
    * @uiEnum ["p", "subtext", "h1", "h2", "h3", "h4"]
    * @uiEnumNames ["Paragraph", "Subtext", "Header 1", "Header 2", "Header 3", "Header 4"]

package/dist/types/components/sqm-timeline/sqm-timeline-entry.d.ts

@@ -1,5 +1,7 @@
 /**
  * @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 declare class TimelineReward {
   ignored: boolean;

package/dist/types/components/sqm-timeline/sqm-timeline.d.ts

@@ -1,6 +1,8 @@
 /**
- * @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 declare class Timeline {
   ignored: boolean;
   /**

package/dist/types/components/sqm-titled-section/sqm-titled-section.d.ts

@@ -17,14 +17,14 @@ export declare class TitledSection {
    */
   textAlign: "left" | "center" | "right";
   /**
-   * @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"]
    */
   labelMargin: Spacing;
   /**
-   * @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"]

package/dist/types/components/sqm-user-name/sqm-user-name.d.ts

@@ -6,11 +6,12 @@ import { UserNameViewProps } from "./sqm-user-name-view";
 export declare class UserName {
   _ignored: boolean;
   /**
-   * @uiName Fallback name for nameless users
+   * Fallback name for unknown users
+   * @uiName Fallback Name
    */
   fallback: string;
   /**
-   * @uiName Loading text
+   * @uiName Loading Text
    */
   loadingText: string;
   /**