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

package/dist/collection/components/sqm-portal-profile/sqm-portal-profile.js

@@ -12,35 +12,45 @@ export class PortalProfile {
   constructor() {
     this.ignored = true;
     /**
-     * @uiName First name input field label
+     * First name input field label
+     *
+     * @uiName First Name Label
      */
     this.firstnametext = "First Name";
     /**
-     * @uiName Last name input field label
+     * Last name input field label
+     *
+     * @uiName Last Name Label
      */
     this.lastnametext = "Last Name";
     /**
-     * @uiName Email input field label
+     * Email input field label
+     *
+     * @uiName Email Label
      */
     this.emailtext = "Email";
     /**
-     * @uiName Country input field label
+     * Country input field label
+     *
+     * @uiName Country Label
      */
     this.countrytext = "Country";
     /**
-     * @uiName Edit profile header
+     * @uiName Edit Profile Header
      */
     this.editProfileHeader = "Edit your profile";
     /**
-     * @uiName Edit profile sub header
+     * @uiName Edit Profile Sub Header
      */
     this.editProfileSubHeader = "Personal Information";
     /**
-     * @uiName Text for the submit changes button
+     * @uiName Submit Changes Button Text
      */
     this.submitChangeButtonText = "Submit Changes";
     /**
-     * @uiName Show or hide country field
+     * Show or hide the country field
+     *
+     * @uiName Show Country Field
      */
     this.showCountry = true;
     withHooks(this);
@@ -67,10 +77,10 @@ export class PortalProfile {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "First name input field label",
+            "text": "First Name Label",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "First name input field label"
       },
       "attribute": "firstnametext",
       "reflect": false,
@@ -88,10 +98,10 @@ export class PortalProfile {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Last name input field label",
+            "text": "Last Name Label",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Last name input field label"
       },
       "attribute": "lastnametext",
       "reflect": false,
@@ -109,10 +119,10 @@ export class PortalProfile {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email input field label",
+            "text": "Email Label",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Email input field label"
       },
       "attribute": "emailtext",
       "reflect": false,
@@ -130,10 +140,10 @@ export class PortalProfile {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Country input field label",
+            "text": "Country Label",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Country input field label"
       },
       "attribute": "countrytext",
       "reflect": false,
@@ -151,7 +161,7 @@ export class PortalProfile {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Edit profile header",
+            "text": "Edit Profile Header",
             "name": "uiName"
           }],
         "text": ""
@@ -172,7 +182,7 @@ export class PortalProfile {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Edit profile sub header",
+            "text": "Edit Profile Sub Header",
             "name": "uiName"
           }],
         "text": ""
@@ -193,7 +203,7 @@ export class PortalProfile {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Text for the submit changes button",
+            "text": "Submit Changes Button Text",
             "name": "uiName"
           }],
         "text": ""
@@ -214,10 +224,10 @@ export class PortalProfile {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Show or hide country field",
+            "text": "Show Country Field",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Show or hide the country field"
       },
       "attribute": "show-country",
       "reflect": false,

package/dist/collection/components/sqm-portal-protected-route/sqm-portal-protected-route.js

@@ -17,7 +17,7 @@ export class PortalProtectedRoute {
      */
     this.requireEmailVerification = false;
     /**
-     * @uiName Redirect unverified users path
+     * @uiName Redirect Unverified Users Path
      */
     this.redirectToUnverified = "/emailVerification";
     withHooks(this);
@@ -87,7 +87,7 @@ export class PortalProtectedRoute {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Redirect unverified users path",
+            "text": "Redirect Unverified Users Path",
             "name": "uiName"
           }],
         "text": ""

package/dist/collection/components/sqm-portal-register/sqm-portal-register.js

@@ -11,53 +11,61 @@ export class PortalRegister {
   constructor() {
     this.ignored = true;
     /**
-     * @uiName Page navigated to after registration
+     * Page navigated to after registration
+     *
+     * @uiName Next Page
      */
     this.nextPage = "/";
     /**
      * The page that users are redirected to from the verification email.
      *
-     * @uiName Email redirection base path
+     * @uiName Email Redirection Base Path
      */
     this.redirectPath = "/verifyEmail";
     /**
-     * @uiName Label for email field
+     * @uiName Email Label
      */
     this.emailLabel = "Email";
     /**
-     * @uiName Label for password field
+     * @uiName Password Label
      */
     this.passwordLabel = "Password";
     /**
-     * @uiName Label for submit button
+     * @uiName Submit Button Text
      */
     this.submitLabel = "Register";
     /**
-     * @uiName Label for login navigation button
+     * @uiName Login Button Text
      */
     this.loginLabel = "Sign in";
     /**
-     * @uiName Label for confirm password field
+     * @uiName Confirm Password Label
      */
     this.confirmPasswordLabel = "Confirm Password";
     /**
-     * @uiName Show confirm password field
+     * Show or hide the confirm password input
+     *
+     * @uiName Show Confirm Password Field
      */
     this.confirmPassword = false;
     /**
-     * @uiName Use password field with live validation
+     * @uiName Enable Password Validation
      */
     this.enablePasswordValidation = true;
     /**
-     * @uiName Hide default input fields to use custom fields
+     * Hide default input fields to use custom fields
+     *
+     * @uiName Hide Default Inputs
      */
     this.hideInputs = false;
     /**
-     * @uiName Heading label
+     * @uiName Heading Label
      */
     this.pageLabel = "Register";
     /**
-     * @uiName Sign in button redirection path
+     * Login button redirection path
+     *
+     * @uiName Login Path
      */
     this.loginPath = "/login";
     withHooks(this);
@@ -95,10 +103,10 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Page navigated to after registration",
+            "text": "Next Page",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Page navigated to after registration"
       },
       "attribute": "next-page",
       "reflect": false,
@@ -116,7 +124,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email redirection base path",
+            "text": "Email Redirection Base Path",
             "name": "uiName"
           }],
         "text": "The page that users are redirected to from the verification email."
@@ -137,7 +145,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Label for email field",
+            "text": "Email Label",
             "name": "uiName"
           }],
         "text": ""
@@ -158,7 +166,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Label for password field",
+            "text": "Password Label",
             "name": "uiName"
           }],
         "text": ""
@@ -179,7 +187,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Label for submit button",
+            "text": "Submit Button Text",
             "name": "uiName"
           }],
         "text": ""
@@ -200,7 +208,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Label for login navigation button",
+            "text": "Login Button Text",
             "name": "uiName"
           }],
         "text": ""
@@ -221,7 +229,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Label for confirm password field",
+            "text": "Confirm Password Label",
             "name": "uiName"
           }],
         "text": ""
@@ -242,10 +250,10 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Show confirm password field",
+            "text": "Show Confirm Password Field",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Show or hide the confirm password input"
       },
       "attribute": "confirm-password",
       "reflect": false,
@@ -263,7 +271,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Use password field with live validation",
+            "text": "Enable Password Validation",
             "name": "uiName"
           }],
         "text": ""
@@ -284,10 +292,10 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Hide default input fields to use custom fields",
+            "text": "Hide Default Inputs",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Hide default input fields to use custom fields"
       },
       "attribute": "hide-inputs",
       "reflect": false,
@@ -305,7 +313,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Heading label",
+            "text": "Heading Label",
             "name": "uiName"
           }],
         "text": ""
@@ -326,10 +334,10 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Sign in button redirection path",
+            "text": "Login Path",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Login button redirection path"
       },
       "attribute": "login-path",
       "reflect": false,

package/dist/collection/components/sqm-portal-reset-password/sqm-portal-reset-password.js

@@ -13,45 +13,47 @@ export class PortalResetPassword {
     /**
      * The page that users are redirected to when the password reset succeeds.
      *
-     * @uiName Next page path
+     * @uiName Next Page Path
      */
     this.nextPage = "/";
     /**
      * 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
      */
     this.failedPage = "/";
     /**
-     * @uiName Show confirm password
+     * Show or hide confirm password field
+     *
+     * @uiName Show Confirm Password
      */
     this.confirmPassword = false;
     /**
-     * @uiName Password reset header text
+     * @uiName Reset Password Header Text
      */
     this.resetPasswordHeader = "Reset your password";
     /**
      * Displayed after a successful password reset
      *
-     * @uiName Password reset header text
+     * @uiName Successful Password Reset Text
      */
     this.passwordResetHeader = "Password reset";
     /**
-     * @uiName Password reset button text
+     * @uiName Password Reset Button Text
      */
     this.resetPasswordButtonText = "Reset Password";
     /**
-     * Displayed after a successful password reset
+     * Button text displayed after a successful password reset
      *
-     * @uiName Continue button text
+     * @uiName Continue Button Text
      */
     this.continueButtonText = "Continue";
     /**
-     * @uiName Confirm password field label
+     * @uiName Confirm Password Label
      */
     this.confirmPasswordFieldLabel = "Confirm Password";
     /**
-     * @uiName Password field label
+     * @uiName Password Label
      */
     this.passwordFieldLabel = "New Password";
     withHooks(this);
@@ -78,7 +80,7 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Next page path",
+            "text": "Next Page Path",
             "name": "uiName"
           }],
         "text": "The page that users are redirected to when the password reset succeeds."
@@ -99,7 +101,7 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Failed page redirection path",
+            "text": "Failed Page Path",
             "name": "uiName"
           }],
         "text": "The page that users are redirected to if the reset fails due to outdated password reset attempt."
@@ -120,10 +122,10 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Show confirm password",
+            "text": "Show Confirm Password",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Show or hide confirm password field"
       },
       "attribute": "confirm-password",
       "reflect": false,
@@ -141,7 +143,7 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Password reset header text",
+            "text": "Reset Password Header Text",
             "name": "uiName"
           }],
         "text": ""
@@ -162,7 +164,7 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Password reset header text",
+            "text": "Successful Password Reset Text",
             "name": "uiName"
           }],
         "text": "Displayed after a successful password reset"
@@ -183,7 +185,7 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Password reset button text",
+            "text": "Password Reset Button Text",
             "name": "uiName"
           }],
         "text": ""
@@ -204,10 +206,10 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Continue button text",
+            "text": "Continue Button Text",
             "name": "uiName"
           }],
-        "text": "Displayed after a successful password reset"
+        "text": "Button text displayed after a successful password reset"
       },
       "attribute": "continue-button-text",
       "reflect": false,
@@ -225,7 +227,7 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Confirm password field label",
+            "text": "Confirm Password Label",
             "name": "uiName"
           }],
         "text": ""
@@ -246,7 +248,7 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Password field label",
+            "text": "Password Label",
             "name": "uiName"
           }],
         "text": ""

package/dist/collection/components/sqm-portal-verify-email/sqm-portal-verify-email.js

@@ -13,13 +13,13 @@ export class PortalVerifyEmail {
     /**
      * The page that users are redirected to when the verification succeeds.
      *
-     * @uiName Next page path
+     * @uiName Next Page Path
      */
     this.nextPage = "/";
     /**
      * The page that users are redirected to if verification fails due to outdated verification attempt.
      *
-     * @uiName Failed page redirection path
+     * @uiName Failed Page Path
      */
     this.failedPage = "/";
     withHooks(this);
@@ -46,7 +46,7 @@ export class PortalVerifyEmail {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Next page path",
+            "text": "Next Page Path",
             "name": "uiName"
           }],
         "text": "The page that users are redirected to when the verification succeeds."
@@ -67,7 +67,7 @@ export class PortalVerifyEmail {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Failed page redirection path",
+            "text": "Failed Page Path",
             "name": "uiName"
           }],
         "text": "The page that users are redirected to if verification fails due to outdated verification attempt."

package/dist/collection/components/sqm-program-explainer/sqm-program-explainer.js

@@ -4,6 +4,7 @@ import { getProps } from "../../utils/utils";
 import { ProgramExplainerView } from "./sqm-program-explainer-view";
 /**
  * @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 class ProgramExplainer {
   constructor() {

package/dist/collection/components/sqm-program-explainer-step/sqm-program-explainer-step.js

@@ -4,6 +4,8 @@ import { getProps } from "../../utils/utils";
 import { ProgramExplainerStepView } from "./sqm-program-explainer-step-view";
 /**
  * @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 class ProgramExplainerStep {
   constructor() {

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

@@ -4,6 +4,7 @@ import { getProps } from "../../utils/utils";
 import { ReferralCardView } from "./sqm-referral-card-view";
 /**
  * @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 class ReferralCard {
   constructor() {

package/dist/collection/components/sqm-referral-iframe/sqm-referral-iframe.js

@@ -13,11 +13,13 @@ export class SqmReferralIframe {
   constructor() {
     this.ignored = true;
     /**
-     * @uiName Height of the iframe container
+     * Height of the iframe container
+     * @uiName Iframe Height
      */
     this.iframeHeight = "100%";
     /**
-     * @uiName Width of the iframe container
+     * Width of the iframe container
+     * @uiName Iframe Width
      */
     this.iframeWidth = "100%";
     withHooks(this);
@@ -53,13 +55,13 @@ export class SqmReferralIframe {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "URL of iframe to display",
+            "text": "Iframe Source",
             "name": "uiName"
           }, {
             "text": undefined,
-            "name": "uiRequired"
+            "name": "required"
           }],
-        "text": ""
+        "text": "URL of iframe to display"
       },
       "attribute": "iframe-src",
       "reflect": false
@@ -76,10 +78,10 @@ export class SqmReferralIframe {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Height of the iframe container",
+            "text": "Iframe Height",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Height of the iframe container"
       },
       "attribute": "iframe-height",
       "reflect": false,
@@ -97,10 +99,10 @@ export class SqmReferralIframe {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Width of the iframe container",
+            "text": "Iframe Width",
             "name": "uiName"
           }],
-        "text": ""
+        "text": "Width of the iframe container"
       },
       "attribute": "iframe-width",
       "reflect": false,

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

@@ -3,6 +3,7 @@ import { Component, getElement, h, Host, Method, Prop } from "@stencil/core";
 import { useRequestRerender } from "../../../tables/re-render";
 /**
  * @uiName Referral Table Generic Column
+ * @validParents ["sqm-referral-table"]
  */
 export class ReferralTableGenericColumn {
   constructor() {

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

@@ -3,6 +3,7 @@ import { Component, h, Host, Method, Prop } from "@stencil/core";
 import { useRequestRerender } from "../../../tables/re-render";
 /**
  * @uiName Referral Table Date Column
+ * @validParents ["sqm-referral-table"]
  */
 export class ReferralTableDateColumn {
   constructor() {

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

@@ -3,6 +3,7 @@ import { Component, h, Host, Method, Prop } from "@stencil/core";
 import { useRequestRerender } from "../../../tables/re-render";
 /**
  * @uiName Referral Table Rewards Column
+ * @validParents ["sqm-referral-table"]
  */
 export class ReferralTableRewardsColumn {
   constructor() {

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

@@ -3,6 +3,7 @@ import { Component, h, Host, Method, Prop } from "@stencil/core";
 import { useRequestRerender } from "../../../tables/re-render";
 /**
  * @uiName Referral Table Status Column
+ * @validParents ["sqm-referral-table"]
  */
 export class ReferralTableStatusColumn {
   constructor() {