@saasquatch/mint-components 1.5.5-2 → 1.5.6-1

package/dist/types/components/sqm-portal-profile/sqm-portal-profile.d.ts

@@ -6,35 +6,45 @@ import { DemoData } from "../../global/demo";
 export declare class PortalProfile {
   ignored: boolean;
   /**
-   * @uiName First name input field label
+   * First name input field label
+   *
+   * @uiName First Name Label
    */
   firstnametext: string;
   /**
-   * @uiName Last name input field label
+   * Last name input field label
+   *
+   * @uiName Last Name Label
    */
   lastnametext: string;
   /**
-   * @uiName Email input field label
+   * Email input field label
+   *
+   * @uiName Email Label
    */
   emailtext: string;
   /**
-   * @uiName Country input field label
+   * Country input field label
+   *
+   * @uiName Country Label
    */
   countrytext: string;
   /**
-   * @uiName Edit profile header
+   * @uiName Edit Profile Header
    */
   editProfileHeader: string;
   /**
-   * @uiName Edit profile sub header
+   * @uiName Edit Profile Sub Header
    */
   editProfileSubHeader: string;
   /**
-   * @uiName Text for the submit changes button
+   * @uiName Submit Changes Button Text
    */
   submitChangeButtonText: string;
   /**
-   * @uiName Show or hide country field
+   * Show or hide the country field
+   *
+   * @uiName Show Country Field
    */
   showCountry: boolean;
   /**

package/dist/types/components/sqm-portal-protected-route/sqm-portal-protected-route.d.ts

@@ -12,7 +12,7 @@ export declare class PortalProtectedRoute {
    */
   requireEmailVerification: boolean;
   /**
-   * @uiName Redirect unverified users path
+   * @uiName Redirect Unverified Users Path
    */
   redirectToUnverified: string;
   constructor();

package/dist/types/components/sqm-portal-register/sqm-portal-register.d.ts

@@ -6,53 +6,61 @@ import { PortalRegisterViewProps } from "./sqm-portal-register-view";
 export declare class PortalRegister {
   ignored: boolean;
   /**
-   * @uiName Page navigated to after registration
+   * Page navigated to after registration
+   *
+   * @uiName Next Page
    */
   nextPage: string;
   /**
    * The page that users are redirected to from the verification email.
    *
-   * @uiName Email redirection base path
+   * @uiName Email Redirection Base Path
    */
   redirectPath: string;
   /**
-   * @uiName Label for email field
+   * @uiName Email Label
    */
   emailLabel: string;
   /**
-   * @uiName Label for password field
+   * @uiName Password Label
    */
   passwordLabel: string;
   /**
-   * @uiName Label for submit button
+   * @uiName Submit Button Text
    */
   submitLabel: string;
   /**
-   * @uiName Label for login navigation button
+   * @uiName Login Button Text
    */
   loginLabel: string;
   /**
-   * @uiName Label for confirm password field
+   * @uiName Confirm Password Label
    */
   confirmPasswordLabel: string;
   /**
-   * @uiName Show confirm password field
+   * Show or hide the confirm password input
+   *
+   * @uiName Show Confirm Password Field
    */
   confirmPassword: boolean;
   /**
-   * @uiName Use password field with live validation
+   * @uiName Enable Password Validation
    */
   enablePasswordValidation: boolean;
   /**
-   * @uiName Hide default input fields to use custom fields
+   * Hide default input fields to use custom fields
+   *
+   * @uiName Hide Default Inputs
    */
   hideInputs: boolean;
   /**
-   * @uiName Heading label
+   * @uiName Heading Label
    */
   pageLabel: string;
   /**
-   * @uiName Sign in button redirection path
+   * Login button redirection path
+   *
+   * @uiName Login Path
    */
   loginPath: string;
   /**

package/dist/types/components/sqm-portal-reset-password/sqm-portal-reset-password.d.ts

@@ -8,45 +8,47 @@ export declare class PortalResetPassword {
   /**
    * The page that users are redirected to when the password reset succeeds.
    *
-   * @uiName Next page path
+   * @uiName Next Page Path
    */
   nextPage: string;
   /**
    * The page that users are redirected to if the reset fails due to outdated password reset attempt.
    *
-   * @uiName Failed page redirection path
+   * @uiName Failed Page Path
    */
   failedPage: string;
   /**
-   * @uiName Show confirm password
+   * Show or hide confirm password field
+   *
+   * @uiName Show Confirm Password
    */
   confirmPassword: boolean;
   /**
-   * @uiName Password reset header text
+   * @uiName Reset Password Header Text
    */
   resetPasswordHeader: string;
   /**
    * Displayed after a successful password reset
    *
-   * @uiName Password reset header text
+   * @uiName Successful Password Reset Text
    */
   passwordResetHeader: string;
   /**
-   * @uiName Password reset button text
+   * @uiName Password Reset Button Text
    */
   resetPasswordButtonText: string;
   /**
-   * Displayed after a successful password reset
+   * Button text displayed after a successful password reset
    *
-   * @uiName Continue button text
+   * @uiName Continue Button Text
    */
   continueButtonText: string;
   /**
-   * @uiName Confirm password field label
+   * @uiName Confirm Password Label
    */
   confirmPasswordFieldLabel: string;
   /**
-   * @uiName Password field label
+   * @uiName Password Label
    */
   passwordFieldLabel: string;
   /**

package/dist/types/components/sqm-portal-verify-email/sqm-portal-verify-email.d.ts

@@ -8,13 +8,13 @@ export declare class PortalVerifyEmail {
   /**
    * The page that users are redirected to when the verification succeeds.
    *
-   * @uiName Next page path
+   * @uiName Next Page Path
    */
   nextPage: string;
   /**
    * The page that users are redirected to if verification fails due to outdated verification attempt.
    *
-   * @uiName Failed page redirection path
+   * @uiName Failed Page Path
    */
   failedPage: string;
   /**

package/dist/types/components/sqm-program-explainer/sqm-program-explainer.d.ts

@@ -1,5 +1,6 @@
 /**
  * @uiName Program Explainer
+ * @examples Program Explainer - <sqm-program-explainer header="How it works"><sqm-program-explainer-step description="Complete tasks like uploading your first video or sharing videos with friends" header="Earn points" icon="cash-stack" text-color="#000000"></sqm-program-explainer-step><sqm-program-explainer-step description="Use your points and redeem rewards like one free month of Enterprise or a visa giftcard" header="Redeem rewards" icon="people" text-color="#000000"></sqm-program-explainer-step></sqm-program-explainer>
  */
 export declare class ProgramExplainer {
   ignored: boolean;

package/dist/types/components/sqm-program-explainer-step/sqm-program-explainer-step.d.ts

@@ -1,5 +1,7 @@
 /**
  * @uiName Program Explainer Step
+ * @example Program Explainer Step - <sqm-program-explainer-step description="Complete tasks like uploading your first video or sharing videos with friends" header="Earn points" icon="cash-stack" text-color="#000000"></sqm-program-explainer-step>
+ * @validParents ["sqm-program-explainer"]
  */
 export declare class ProgramExplainerStep {
   /**

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

@@ -1,5 +1,6 @@
 /**
  * @uiName Referral Card
+ * @example Card with Timeline and Sharing - <sqm-referral-card><sqm-portal-container gap="large" slot="left"><sqm-text>Get rewarded when your friend uses Klip </sqm-text><sqm-timeline icon="circle"><sqm-timeline-entry reward="75" unit="points" desc="Your friends signs up for a free trial"></sqm-timeline-entry><sqm-timeline-entry reward="$50" unit="visa giftcard" desc="Your friends signs up for Klip Business"></sqm-timeline-entry><sqm-timeline-entry reward="$200" unit="visa giftcard" desc="Your friend qualifies as a good fit for Klip Enterprise"></sqm-timeline-entry><sqm-timeline-entry reward="$1000" unit="visa giftcard" desc="Your friend purchases Klip Enterprise"></sqm-timeline-entry></sqm-timeline></sqm-portal-container><sqm-portal-container gap="large" slot="right"><sqm-text>Choose how you want to share: </sqm-text><sqm-text><sub>Your unique referral link:</sub><sqm-share-link> </sqm-share-link></sqm-text><sqm-portal-container gap="x-small"><sqm-share-button medium="email">Share via email</sqm-share-button><sqm-share-button medium="linkedin">Share on LinkedIn</sqm-share-button><sqm-share-button medium="twitter">Tweet about us</sqm-share-button><sqm-share-button medium="sms">Text a friend</sqm-share-button></sqm-portal-container></sqm-portal-container></sqm-referral-card>
  */
 export declare class ReferralCard {
   ignored: boolean;

package/dist/types/components/sqm-referral-iframe/sqm-referral-iframe.d.ts

@@ -6,16 +6,19 @@ import { DemoData } from "../../global/demo";
 export declare class SqmReferralIframe {
   ignored: boolean;
   /**
-   * @uiName URL of iframe to display
-   * @uiRequired
+   * URL of iframe to display
+   * @uiName Iframe Source
+   * @required
    */
   iframeSrc: string;
   /**
-   * @uiName Height of the iframe container
+   * Height of the iframe container
+   * @uiName Iframe Height
    */
   iframeHeight: string;
   /**
-   * @uiName Width of the iframe container
+   * Width of the iframe container
+   * @uiName Iframe Width
    */
   iframeWidth: string;
   /**

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

@@ -1,6 +1,7 @@
 import { ReferralTableColumn } from "./ReferralTableColumn";
 /**
  * @uiName Referral Table Generic Column
+ * @validParents ["sqm-referral-table"]
  */
 export declare class ReferralTableGenericColumn implements ReferralTableColumn {
   /**

package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-date-column.d.ts

@@ -2,6 +2,7 @@ import { ReferralDates } from "../useReferralTable";
 import { ReferralTableColumn } from "./ReferralTableColumn";
 /**
  * @uiName Referral Table Date Column
+ * @validParents ["sqm-referral-table"]
  */
 export declare class ReferralTableDateColumn implements ReferralTableColumn {
   /**

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

@@ -1,6 +1,7 @@
 import { ReferralTableColumn } from "./ReferralTableColumn";
 /**
  * @uiName Referral Table Rewards Column
+ * @validParents ["sqm-referral-table"]
  */
 export declare class ReferralTableRewardsColumn implements ReferralTableColumn {
   /**

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

@@ -1,6 +1,7 @@
 import { ReferralTableColumn } from "./ReferralTableColumn";
 /**
  * @uiName Referral Table Status Column
+ * @validParents ["sqm-referral-table"]
  */
 export declare class ReferralTableStatusColumn implements ReferralTableColumn {
   /**

package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-user-column.d.ts

@@ -1,6 +1,7 @@
 import { ReferralTableColumn } from "./ReferralTableColumn";
 /**
  * @uiName Referral Table User Column
+ * @validParents ["sqm-referral-table"]
  */
 export declare class ReferralTableUserColumn implements ReferralTableColumn {
   /**
@@ -8,11 +9,15 @@ export declare class ReferralTableUserColumn implements ReferralTableColumn {
    */
   columnTitle: string;
   /**
-   * @uiName Name displayed for anonymous users
+   * Name displayed for unknown users
+   *
+   * @uiName Anonymous User Text
    */
   anonymousUser: string;
   /**
-   * @uiName Name displayed for deleted users
+   * Name displayed for deleted users
+   *
+   * @uiName Deleted User Text
    */
   deletedUser: string;
   constructor();

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

@@ -12,20 +12,29 @@ export declare class ReferralTable {
    * @uiName Program
    */
   programId: string;
-  /** @uiName Number of referrals per page */
+  /**
+   * Number of referrals displayed per page
+   *
+   * @uiName Referrals Per Page
+   */
   perPage: number;
-  /** @uiName Show column labels */
+  /** @uiName Show Column Labels */
   showLabels?: boolean;
-  /** @uiName Previous button text  */
+  /** @uiName Previous Button Text  */
   prevLabel?: string;
-  /** @uiName View More button text  */
+  /** @uiName View More Button Text  */
   moreLabel?: string;
-  /** @uiName Show Referred by user in table  */
+  /**
+   * Show referred by user in table
+   *
+   * @uiName Show Referrer
+   */
   showReferrer?: boolean;
   /**
    * Provide the column numbers (0 indexed) that should not be displayed in mobile views. Ex. 0,2,3
    *
-   *  @uiName Mobile Hidden Columns  */
+   * @uiName Hidden Mobile Columns
+   */
   hiddenColumns?: string;
   /** @uiName Mobile Breakpoint  */
   smBreakpoint?: number;

package/dist/types/components/sqm-reward-exchange-list/sqm-reward-exchange-list.d.ts

@@ -6,7 +6,9 @@ import { DemoData } from "../../global/demo";
 export declare class SqmRewardExchangeList {
   ignored: boolean;
   /**
-   * @uiName Exchange button text
+   * Error message shown when reward is not available
+   *
+   * @uiName Not Available Error
    */
   notAvailableError: string;
   /**
@@ -38,7 +40,7 @@ export declare class SqmRewardExchangeList {
    */
   continueText: string;
   /**
-  * Displayed on the reward selection page.
+   * Displayed on the reward selection page.
    * @uiName Continue to Confirmation Button Text
    */
   continueToConfirmationText: string;
@@ -47,17 +49,20 @@ export declare class SqmRewardExchangeList {
    */
   redeemText: string;
   /**
-  * Displayed as the header for the confirmation page.
+   * Displayed as the header for the confirmation page.
+   *
    * @uiName Confirmation Title Text
    */
   redeemTitle: string;
   /**
-  * Displayed on the success screen when a user successfully exchanges for a reward.
+   * Displayed on the success screen when a user successfully exchanges for a reward.
+   *
    * @uiName Redemption Success Message
    */
   redemptionSuccessText: string;
   /**
-  * Displayed on the reward exchange cards.
+   * Displayed on the reward exchange cards.
+   *
    * @uiName Reward Exchange Amount Text
    */
   sourceAmountMessage: string;
@@ -76,17 +81,19 @@ export declare class SqmRewardExchangeList {
    */
   selectText: string;
   /**
-  * Shown if an error occurs when loading the reward exchange.
+   * Shown if an error occurs when loading the reward exchange.
+   *
    * @uiName Reward List Error Message
    */
   queryError: string;
   /**
-  * Shown if an error occurs during the reward exchange.
+   * Shown if an error occurs during the reward exchange.
+   *
    * @uiName Redemption Error Message
    */
   redemptionError: string;
   /**
-   * @uiName Not Enough Available Error Message
+   * @uiName Not Enough Error Message
    */
   notEnoughError: string;
   /**
@@ -100,7 +107,7 @@ export declare class SqmRewardExchangeList {
   /**
    * Set the number of placeholder cards to be shown in loading state.
    *
-   * @undocumented Loading Cards
+   * @uiName Loading Cards
    */
   skeletonCardNum: number;
   /**

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

@@ -1,6 +1,7 @@
 import { RewardTableColumn } from "./RewardTableColumn";
 /**
  * @uiName Reward Table Date Column
+ * @validParents ["sqm-rewards-table"]
  */
 export declare class RewardTableDateColumn implements RewardTableColumn {
   /**

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

@@ -1,6 +1,7 @@
 import { RewardTableColumn } from "./RewardTableColumn";
 /**
  * @uiName Reward Table Customer Note Column
+ * @validParents ["sqm-rewards-table"]
  */
 export declare class RewardTableCustomerNoteColumn implements RewardTableColumn {
   /**

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

@@ -1,10 +1,11 @@
 import { RewardTableColumn } from "./RewardTableColumn";
 /**
  * @uiName Rewards Table Reward Column
+ * @validParents ["sqm-rewards-table"]
  */
 export declare class RewardsTableColumn implements RewardTableColumn {
   /**
-   * @uiName Reward column title
+   * @uiName Reward Column Title
    */
   columnTitle: string;
   /**

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

@@ -1,6 +1,7 @@
 import { RewardTableColumn } from "./RewardTableColumn";
 /**
  * @uiName Reward Table Source Column
+ * @validParents ["sqm-rewards-table"]
  */
 export declare class RewardTableUserColumn implements RewardTableColumn {
   /**
@@ -8,15 +9,19 @@ export declare class RewardTableUserColumn implements RewardTableColumn {
    */
   columnTitle: string;
   /**
-   * @uiName Name displayed for anonymous users
+   * Name displayed for unknown users
+   *
+   * @uiName Anonymous User Text
    */
   anonymousUser: string;
   /**
-   * @uiName Name displayed for deleted users
+   * Name displayed for deleted users
+   *
+   * @uiName Deleted User Text
    */
   deletedUser: string;
   /**
-   * @uiName Reward Exchange label
+   * @uiName Reward Exchange Label
    */
   rewardExchangeText: string;
   /**

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

@@ -1,6 +1,7 @@
 import { RewardTableColumn } from "./RewardTableColumn";
 /**
  * @uiName Reward Table Status Column
+ * @validParents ["sqm-rewards-table"]
  */
 export declare class RewardTableStatusColumn implements RewardTableColumn {
   /**

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

@@ -7,7 +7,7 @@ export interface RouteProps {
 export declare class SqmRoute {
   ignored: boolean;
   /**
-   * @uiName Navigation path name
+   * @uiName Navigation Path Name
    */
   path: string;
   disconnectedCallback(): void;

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

@@ -3,6 +3,9 @@ import { DemoData } from "../../global/demo";
 /**
  * @uiName Share Button
  * @uiOrder ["medium", "program-id", "*", "pill", "disabled", "hideicon"]
+ * @example SMS hare Button - <sqm-share-button medium="sms">Text a friend</sqm-share-button>
+ * @example Email Share Button - <sqm-share-button medium="email">Share via email</sqm-share-button>
+ * @example Linkedin Share Button - <sqm-share-button medium="linkedin">Share on LinkedIn</sqm-share-button>
  */
 export declare class ShareButton {
   /**
@@ -22,21 +25,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 +71,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

@@ -11,9 +11,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

@@ -13,13 +13,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

@@ -5,7 +5,7 @@ import { Spacing } from "../../global/mixins";
 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  */