@saasquatch/mint-components 1.6.1-9 → 1.6.2-2

package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-status-column.d.ts

@@ -16,7 +16,9 @@ export declare class RewardTableStatusColumn implements RewardTableColumn {
    */
   statusText: string;
   /**
-   * @uiName Expired Status Text
+   * Text shown before the date of an expiring reward.
+   *
+   * @uiName Expiry Date Prefix
    */
   expiryText: string;
   /**
@@ -26,7 +28,9 @@ export declare class RewardTableStatusColumn implements RewardTableColumn {
    */
   pendingUsTax: string;
   /**
-   * @uiName Expiry Date Prefix
+   * Text shown before the available date of a pending reward.
+   *
+   * @uiName Pending Date Prefix
    */
   pendingScheduled: string;
   /**

package/dist/types/components/sqm-rewards-table/sqm-rewards-table.d.ts

@@ -4,7 +4,7 @@ import { GenericTableViewProps } from "../../tables/GenericTableView";
  * @uiName Reward Table
  * @exampleGroup Rewards
  * @slots [{"name":"", "title":"Table Row"},{"name":"empty", "title":"Empty"},{"name":"loading","title":"Loading"}]
- * @example Reward Table - <sqm-rewards-table per-page="4" show-labels= prev-label="Prev" more-label="Next" hidden-columns="0" sm-breakpoint="599" md-breakpoint="799"><sqm-rewards-table-status-column column-title="Status" status-text="{status, select, AVAILABLE {Available} CANCELLED {Cancelled} PENDING {Pending} EXPIRED {Expired} REDEEMED {Redeemed} other {Not available} }" expiry-text="Expires on " pending-us-tax="W-9 required" pending-scheduled="Until" pending-unhandled="Fulfillment error"></sqm-rewards-table-status-column><sqm-rewards-table-source-column column-title="Source" anonymous-user="Anonymous User" deleted-user="Deleted User" reward-exchange-text="Reward Exchange" referral-rext="{rewardSource, select, FRIEND_SIGNUP {Referral to} REFERRED {Referred by} other {}}" reward-source-text="{rewardSource, select, MANUAL {Manual} AUTOMATED {{programName}} other {}}"></sqm-rewards-table-source-column><sqm-rewards-table-reward-column column-title="Reward" redeemed-text="{redeemedAmount} redeemed" available-text="{availableAmount} remaining" copy-text="Copied!"></sqm-rewards-table-reward-column><sqm-rewards-table-date-column column-title="Date received" date-shown="dateGiven"></sqm-rewards-table-date-column><sqm-rewards-table-customer-note-column column-title="Note"></sqm-rewards-table-customer-note-column><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_reward2.png" empty-state-header="View your rewards" empty-state-text="Complete program tasks to view the details of your rewards"></sqm-empty></sqm-rewards-table>
+ * @example Reward Table - <sqm-rewards-table per-page="4" show-labels= prev-label="Prev" more-label="Next" hidden-columns="0" sm-breakpoint="599" md-breakpoint="799"><sqm-rewards-table-status-column column-title="Status" status-text="{status, select, AVAILABLE {Available} CANCELLED {Cancelled} PENDING {Pending} EXPIRED {Expired} REDEEMED {Redeemed} other {Not available} }" expiry-text="Expires on " pending-us-tax="W-9 required" pending-scheduled="Until" pending-unhandled="Fulfillment error"></sqm-rewards-table-status-column><sqm-rewards-table-source-column column-title="Source" anonymous-user="Anonymous User" deleted-user="Deleted User" reward-exchange-text="Reward Exchange" referral-rext="{rewardSource, select, FRIEND_SIGNUP {Referral to} REFERRED {Referred by} other {}}" reward-source-text="{rewardSource, select, MANUAL {Manual} AUTOMATED {{programName}} other {}}"></sqm-rewards-table-source-column><sqm-rewards-table-reward-column column-title="Reward" redeemed-text="{redeemedAmount} redeemed" available-text="{availableAmount} remaining" copy-text="Copied!"></sqm-rewards-table-reward-column><sqm-rewards-table-date-column column-title="Date received" date-shown="dateGiven"></sqm-rewards-table-date-column><sqm-rewards-table-customer-note-column column-title="Note"></sqm-rewards-table-customer-note-column><sqm-empty slot="empty" empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_reward2.png" empty-state-header="View your rewards" empty-state-text="Complete program tasks to view the details of your rewards"></sqm-empty></sqm-rewards-table>
  */
 export declare class RewardsTable {
   /**

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

@@ -1,9 +1,7 @@
 /**
  * @uiName Scroll Button
- * @exampleGroup Common Components
  * @slots [{"name":"", "title":"Button Content"}]
  * @slotEditor richText
- * @example Scroll Button - <sqm-scroll button-type="primary" size="medium" outline mobile scroll-animation="smooth">Button Text</sqm-scroll>
  */
 export declare class Scroll {
   ignored: boolean;
@@ -20,10 +18,14 @@ export declare class Scroll {
    */
   buttonText: string;
   /**
+   * The name of the HTML tag you would like to scroll to. E.g referral-table
+   *
    * @uiName Scroll Tag Name
    */
   scrollTagName?: string;
   /**
+   * ID applied to the HTML tag you would like to scroll to. E.g tab-1
+   *
    * @uiName Scroll Id
    */
   scrollId?: string;
@@ -67,6 +69,7 @@ export declare class Scroll {
    */
   iconSlot: string;
   /**
+   * Full list of valid icon names available in the {@link https://shoelace.style/components/icon Shoelace Icon Library}. This value is case sensitive.
    * @uiName Icon
    */
   iconName: string;

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

@@ -92,10 +92,12 @@ export declare class ShareButton {
   icon?: string;
   /**
    * @uiName Hide Icon
+   * @default
    */
   hideicon?: boolean;
   /**
    * @uiName Hide Text
+   * @default
    */
   hidetext?: boolean;
   /**

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

@@ -3,7 +3,7 @@
  * @slots [{"name":"", "title":"Tab Content"}]
  * @validParents ["sqm-tabs"]
  * @exampleGroup Layout
- * @example Tab - <sqm-tab header="Example">This is an example tab. Add your own content here.</sqm-tab>
+ * @example Tab - <sqm-tab header="Example"><p>This is an example tab. Add your own content here.</p></sqm-tab>
  */
 export declare class Tab {
   /** @uiName Tab Title  */

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

@@ -34,6 +34,7 @@ export declare class TaskCard {
   /**
    * @uiName Goal Repeatable
    * @uiGroup Goal
+   * @default
    */
   repeatable: boolean;
   /**
@@ -46,6 +47,7 @@ export declare class TaskCard {
   /**
    * @uiName Show Progress Bar
    * @uiGroup Goal
+   * @default
    */
   showProgressBar: boolean;
   /**
@@ -58,6 +60,7 @@ export declare class TaskCard {
   /**
    * @uiName Progress Bar Steps
    * @uiGroup Goal
+   * @default
    */
   steps: boolean;
   /**
@@ -128,6 +131,7 @@ export declare class TaskCard {
    * Button Link Opens in New Tab
    * @uiName Open In New Tab
    * @uiGroup Button
+   * @default
    */
   openNewTab: boolean;
   /**
@@ -149,7 +153,7 @@ export declare class TaskCard {
    */
   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.
+   * The ID of the program that is used to scope the task card. When no ID is specified, it defaults to the program context in which the component is rendered.
    *
    * @uiName Program ID Override
    * @uiWidget programSelector

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

@@ -1,5 +1,5 @@
 /**
- * @uiName Timeline Entry
+ * @uiName Program Timeline Entry
  * @validParents ["sqm-timeline"]
  * @exampleGroup Common Components
  * @example Timeline Entry - <sqm-timeline-entry reward="$50" unit="visa giftcard" desc="You refer a friend" icon="circle" > </sqm-timeline-entry>

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

@@ -7,7 +7,7 @@ import { Spacing } from "../../global/mixins";
  */
 export declare class TitledSection {
   /**
-   * Label for the section unless overwritten via the label slot.
+   * Text value shown when there is no label slot declared.
    *
    * @uiName Label
    */
@@ -20,13 +20,17 @@ export declare class TitledSection {
    */
   textAlign: "left" | "center" | "right";
   /**
-   * @uiName Label Margin Style
+   * Margin applied to the bottom of the label slot
+   *
+   * @uiName Label Bottom Margin
    * @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;
   /**
+   * Padding applied to all 4 sides of the container
+   *
    * @uiName Section Padding
    * @uiType string
    * @uiEnum ["none", "xxx-small", "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "xxx-large", "xxxx-large"]