@saasquatch/mint-components 1.5.6-2 → 1.6.0-0

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

@@ -1,7 +1,7 @@
 /**
  *
  * @uiName Brand Container
- * @slots [{"name":"","title":"Branded Content"}]
+ * @slot Controls the brand color and font of Mint Components wrapped by the container.
  */
 export declare class BrandComponent {
   /**

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

@@ -1,6 +1,5 @@
 /**
  * @uiName Card Feed
- * @slots [{"name":"","title":"Cards"}]
  */
 export declare class CardFeed {
   ignored: boolean;

package/dist/types/components/sqm-checkbox-field/sqm-checkbox-field.d.ts

@@ -6,25 +6,24 @@ import { CheckboxFieldViewProps } from "./sqm-checkbox-field-view";
 export declare class CheckboxField {
   ignored: boolean;
   /**
-   * @uiName Checkbox Name Attribute
+   * @uiName Checkbox name attribute
    */
   checkboxName: string;
   /**
-   * @uiName Checkbox Label
+   * @uiName Checkbox label
    */
   checkboxLabel: string;
   /**
+   * @uiName Checkbox label link
    * Used with link text if the checkbox label contains {labelLink}
-   *
-   * @uiName Checkbox Label Link
    */
   checkboxLabelLink: string;
   /**
-   * @uiName Checkbox Label Link Text
+   * @uiName Checkbox label link text
    */
   checkboxLabelLinkText: string;
   /**
-   * @uiName Unchecked Error Message
+   * @uiName Unchecked error message
    */
   errorMessage: string;
   /**

package/dist/types/components/sqm-divided-layout/sqm-divided-layout.d.ts

@@ -13,8 +13,8 @@ export declare class DividedLayout {
    */
   direction: "row" | "column";
   /**
-   * Uses Shorthand CSS border syntax
-   * @uiName Border Style
+   * Uses CSS border style syntax
+   * @uiName Border style
    */
   dividerStyle: string;
   constructor();

package/dist/types/components/sqm-dropdown-field/sqm-dropdown-field.d.ts

@@ -6,15 +6,15 @@ import { DropdownFieldViewProps } from "./sqm-dropdown-field-view";
 export declare class DropdownField {
   ignored: boolean;
   /**
-   * @uiName Dropdown Name Attribute
+   * @uiName Dropdown name attribute
    */
   dropdownName: string;
   /**
-   * @uiName Dropdown Label
+   * @uiName Dropdown label
    */
   dropdownLabel: string;
   /**
-   * @uiName Unselected Error Message
+   * @uiName Unselected error message
    */
   errorMessage: string;
   /**

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

@@ -10,34 +10,31 @@ export declare class EditProfile {
    */
   editprofileheader: string;
   /**
-   * Enable editing button text
-   *
-   * @uiName Edit Profile Text
+   * @uiName Enable editing button text
    */
   editprofiletext: string;
   /**
-   * @uiName Cancel Button Text
+   * @uiName Cancel button text
    */
   canceltext: string;
   /**
-   * @uiName Info Button Text
+   * @uiName Update info button text
    */
   updatetext: string;
   /**
-   * @uiName First Name Label
+   * @uiName First name field label
    */
   firstnametext: string;
   /**
-   * @uiName Last Name Label
+   * @uiName Last name field label
    */
   lastnametext: string;
   /**
-   * @uiName Region Field Label
+   * @uiName Region field label
    */
   currentregiontext: string;
   /**
-   * Show or hide current region
-   * @uiName Show Region
+   * @uiName Show or hide current region
    */
   showregion: boolean;
   /**

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

@@ -1,6 +1,5 @@
 /**
  * @uiName Empty State Content
- * @validParents ["sqm-referral-table","sqm-rewards-table","sqm-leaderboard", "sqm-reward-exchange-list"]
  */
 export declare class HeroImage {
   /**

package/dist/types/components/sqm-form-message/sqm-form-message.d.ts

@@ -3,15 +3,9 @@
  */
 export declare class FormMessage {
   ignored: boolean;
-  /**
-   * @uiName Alert Type
-   */
+  /** @uiName Type of alert */
   type: string;
-  /**
-   * Icon to use in alert
-   *
-   * @uiName Icon
-   */
+  /** @uiName Icon to use in alert */
   icon?: string;
   constructor();
   disconnectedCallback(): void;

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

@@ -4,31 +4,19 @@
  * @uiName Hero Layout
  */
 export declare class Hero {
-  /**
-   * Number of columns in the layout
-   *
-   * @uiName Columns
-   */
+  /** @uiName Number of columns in the layout */
   columns: 1 | 2;
   /**
-   * Can be an image url, colour or Shoelace variable.
-   *
-   * @uiName Background
-   */
+  * Can either be an image url, colour or Shoelace variable.
+  *
+  * @uiName Background
+  */
   background?: string;
-  /** @uiName Padding Size */
+  /** @uiName Padding size */
   paddingSize: "none" | "small" | "medium" | "large";
-  /**
-   * Secondary background image or color (for use in the right column)
-   *
-   * @uiName Secondary Background
-   */
+  /** @uiName Secondary background image or color (for use in right column)*/
   secondaryBackground?: string;
-  /**
-   * Flexbox wrap direction, accepts wrap or wrap-reverse
-   *
-   * @uiName Wrap Direction
-   */
+  /** @uiName Wrap direction */
   wrapDirection: "wrap" | "wrap-reverse";
   constructor();
   disconnectedCallback(): void;

package/dist/types/components/sqm-hero-image/sqm-hero-image.d.ts

@@ -1,8 +1,6 @@
 import { Spacing } from "../../global/mixins";
 /**
  * @uiName Hero Image
- * @example Two Column Layout - <sqm-hero-image image-url="https://res.cloudinary.com/saasquatch/image/upload/v1644000275/squatch-assets/yr6ER3R.png" header="MyCompany Rewards" description="Refer a friend and earn up to $1200 in rewards" layout="columns" image-pos="right" background-color="#F9F9F9"></sqm-hero-image>
- * @example Overlay - <sqm-hero-image image-url="https://res.cloudinary.com/saasquatch/image/upload/v1644000275/squatch-assets/yr6ER3R.png" header="MyCompany Rewards" description="Refer a friend and earn up to $1200 in rewards" layout="overlay" image-pos="center" background-color="#F9F9F9" button-link="https://www.example.com" button-new-tab button-text="Earn!" image-percentage="45" overlay-opacity=".5" padding-image="small" padding-text="xxxx-large"></sqm-hero-image>
  */
 export declare class HeroImage {
   /**
@@ -72,9 +70,7 @@ export declare class HeroImage {
    */
   buttonLink?: string;
   /**
-   * CTA Button Opens Link in New Tab
-   *
-   * @uiName Button New Tab
+   * @uiName CTA Button Link Open in New Tab
    */
   buttonNewTab?: boolean;
   /**

package/dist/types/components/sqm-hook-story-container/sqm-hook-story-container.d.ts

@@ -1,7 +1,4 @@
 import { FunctionalComponent } from "../../stencil-public-runtime";
-/**
- * @undocumented
- */
 export declare class SqmHookStoryContainer {
   ignored: boolean;
   hookStory: FunctionalComponent;

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

@@ -2,9 +2,6 @@ import { DemoData } from "../../global/demo";
 import { LeaderboardViewProps } from "./sqm-leaderboard-view";
 /**
  * @uiName Leaderboard
- * @example Referral Converted Leaderboard - <sqm-leaderboard usersheading="Referrer" statsheading="Referrals" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topConvertedReferrers" show-rank anonymous-user="Anonymous User"> <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to refer a friend and reach the top of the leaderboard" > </sqm-empty></sqm-leaderboard>
- * @example Referral Started Leaderboard - <sqm-leaderboard usersheading="Referrer" statsheading="Referrals" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topStartedReferrers" show-rank anonymous-user="Anonymous User"> <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to refer a friend and reach the top of the leaderboard" > </sqm-empty></sqm-leaderboard>
- * @example Point Earners Leaderboard - <sqm-leaderboard usersheading="Users" statsheading="Points Earned" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topPointEarners" show-rank anonymous-user="Anonymous User"> <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to earn points and reach the top of the leaderboard" ></sqm-empty></sqm-leaderboard>
  */
 export declare class Leaderboard {
   /**
@@ -27,7 +24,7 @@ export declare class Leaderboard {
    */
   rankheading?: string;
   /**
-   * @uiName Show Leaderboard Rank
+   * @uiName Show Rank Column
    */
   showRank: boolean;
   /**
@@ -51,14 +48,17 @@ export declare class Leaderboard {
    */
   leaderboardType: "topStartedReferrers" | "topConvertedReferrers" | "topPointEarners";
   /**
-   * Title displayed for users without names
-   * @uiName Unknown User Text
+   * Text displayed for users without names in the leaderboard
+   *
+   * @uiName Anonymous User Name
    */
   anonymousUser: string;
   /**
+   * Only count leaderboard activity within a given interval
+   *
    * @uiName Leaderboard Time Interval
    * @uiWidget DateRange
-   * @uiWidgetOptions {"allowPastDates":true, "months": 1}
+   * @uiOptions {"allowPastDates":true, "months": 1}
    */
   interval: string;
   /**

package/dist/types/components/sqm-leaderboard-rank/sqm-leaderboard-rank.d.ts

@@ -5,7 +5,7 @@ import { DemoData } from "../../global/demo";
  */
 export declare class LeaderboardRank {
   /**
-   * @uiName Default Rank
+   * @uiName Default rank
    * @uiType string
    * @uiEnum ["rowNumber", "rank", "denseRank"]
    * @uiEnumNames ["Row Number", "Rank", "Dense Rank"]
@@ -16,7 +16,7 @@ export declare class LeaderboardRank {
    */
   rankText: string;
   /**
-   * @uiName Leaderboard Type
+   * @uiName Leaderboard type
    * @uiType string
    * @uiEnum ["topStartedReferrers", "topConvertedReferrers", "topPointEarners"]
    * @uiEnumNames ["Top Started Referrers", "Top Converted Referrers", "Top Point Earners"]
@@ -27,9 +27,9 @@ export declare class LeaderboardRank {
    */
   unrankedText: string;
   /**
-   * @uiName Leaderboard Time Interval
+   * @uiName Leaderboard time interval
    * @uiWidget DateRange
-   * @uiWidgetOptions {"allowPastDates":true, "months": 1}
+   * @uiOptions {"allowPastDates":true, "months": 1}
    */
   interval: string;
   /**

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

@@ -6,11 +6,11 @@ import { NameFieldsViewProps } from "./sqm-name-fields-view";
 export declare class NameFields {
   ignored: boolean;
   /**
-   * @uiName First Name label
+   * @uiName First name field label
    */
   firstNameLabel: string;
   /**
-   * @uiName Last Name label
+   * @uiName Last name field label
    */
   lastNameLabel: string;
   /**

package/dist/types/components/sqm-navigation-menu/sqm-navigation-menu.d.ts

@@ -6,13 +6,11 @@ import { DemoData } from "../../global/demo";
 export declare class NavigationMenu {
   ignored: boolean;
   /**
-   * @uiName Include Dropdown Menu
+   * @uiName Include dropdown menu
    */
   includeDropdown: boolean;
   /**
-   * Label on the header menu
-   *
-   * @uiName Menu Label
+   * @uiName Label on the header menu
    */
   menuLabel: string;
   /**

package/dist/types/components/sqm-navigation-sidebar/sqm-navigation-sidebar.d.ts

@@ -1,5 +1,5 @@
 /**
- * A container for navigation menu items
+ * A holder for navigation menu items
  *
  * @uiName Navigation Sidebar
  */

package/dist/types/components/sqm-navigation-sidebar-item/sqm-navigation-sidebar-item.d.ts

@@ -5,7 +5,7 @@ import { NavigationSidebarItemViewProps } from "./sqm-navigation-sidebar-item-vi
  */
 export declare class NavigationSidebarItem {
   /**
-   * @uiName Navigation Path
+   * @uiName Navigation path
    */
   path: string;
   /**

package/dist/types/components/sqm-password-field/sqm-password-field.d.ts

@@ -14,14 +14,11 @@ export interface PasswordFieldViewDemoProps {
 export declare class PortalPasswordField {
   ignored: boolean;
   /**
-   * Label for password field
-   *
-   * @uiName Password Label
+   * @uiName Label for password field
    */
   fieldLabel: string;
   /**
-   * Enable live password validation
-   * @uiName Enable Validation
+   * @uiName Enable live password validation
    */
   enableValidation: boolean;
   /**

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

@@ -1,37 +1,22 @@
 /**
- * @uiName Popup Container For Widgets
+ * @uiName Popup container for widgets
  */
 export declare class PopupContainer {
-  /**
-   * Show Powered By SaaSquatch link
-   *
-   * @uiName Show Powered By
-   */
+  /** @uiName Show SaaSquatch Powered By messaging */
   poweredBy: boolean;
-  /**
-   * Display a close button on the popup
-   *
-   * @uiName Show Close Button
-   */
+  /** @uiName Display a close button on the popup */
   closeButton: boolean;
-  /**
-   * Text inside the close button
-   *
-   * @uiName Close Button Text
-   */
+  /** @uiName Text to be used as the close button */
   closeButtonText: string;
   /**
-   * Specify padding on the popup contents when in embedded mode
-   *
-   * @uiName Embed Padding
+   * @uiName Specify padding on the popup contents when in embedded mode
    * @uiType string
    * @uiEnum ["none", "small", "medium", "large"]
    * @uiEnumNames ["None", "Small", "Medium", "Large"]
    */
   embedPadding?: "none" | "small" | "medium" | "large";
   /**
-   * Specify padding on the popup contents when in popup mode
-   * @uiName Popup Padding
+   * @uiName  Specify padding on the popup contents when in popup mode
    * @uiType string
    * @uiEnum ["none", "small", "medium", "large"]
    * @uiEnumNames ["None", "Small", "Medium", "Large"]

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

@@ -6,47 +6,35 @@ import { DemoData } from "../../global/demo";
 export declare class PortalChangePassword {
   ignored: boolean;
   /**
-   * @uiName Change Password Modal Header
+   * @uiName Change password modal header
    */
   modalChangePasswordHeader: string;
   /**
-   * Modal cancel button text
-   *
-   * @uiName Cancel Button Text
+   * @uiName Modal cancel password change button text
    */
   cancelText: string;
   /**
-   * Modal change password button text
-   *
-   * @uiName Change Password Button Text
+   * @uiName Modal change password button text
    */
   changePasswordButtonText: string;
   /**
-   * Password input field label
-   *
-   * @uiName Password Label
+   * @uiName Password input field label
    */
   passwordFieldLabel: string;
   /**
-   * Password confirmation input field label
-   *
-   * @uiName Confirm Password Label
+   * @uiName Password confirmation input field label
    */
   confirmPasswordFieldLabel: string;
   /**
-   * Successful password change message
-   *
-   * @uiName Successful Message
+   * @uiName Successful password change message
    */
   successMessage: string;
   /**
-   * Portal change password section header
-   *
-   * @uiName Change Password Header
+   * @uiName Portal change password section header
    */
   portalChangePasswordHeader: string;
   /**
-   * @uiName Change Password Button Text
+   * @uiName Portal change password button text
    */
   portalChangePasswordButtonText: string;
   /**

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

@@ -1,7 +1,6 @@
 import { Spacing } from "../../global/mixins";
 /**
  * @uiName Portal Container
- * @slots [{"name":"","title":"Widget Content"}]
  */
 export declare class PortalContainer {
   ignored: boolean;
@@ -26,7 +25,7 @@ export declare class PortalContainer {
    * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
    */
   gap: Spacing;
-  /** @uiName Minimum Width */
+  /** @uiName Minimum width */
   minWidth?: string;
   /**
    * @uiName Display
@@ -36,9 +35,7 @@ export declare class PortalContainer {
    */
   display: "grid" | "flex";
   /**
-   * Defines how the container distributes space between & around content items along the main-axis of a flex container
-   *
-   * @uiName Justify Content
+   * @uiName Justify content
    * @uiType string
    * @uiEnum ["start", "center", "end", "space-between", "space-around", "space-evenly"]
    * @uiEnumNames ["Start", "Center", "End", "Space Between", "Space Around", "Space Evenly"]
@@ -49,7 +46,7 @@ export declare class PortalContainer {
    */
   maxWidth?: string;
   /**
-   * @uiName Center Content
+   * @uiName Center content
    */
   center?: boolean;
   constructor();

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

@@ -8,19 +8,19 @@ export declare class PortalEmailVerification {
   /**
    * The page that users are redirected to from the verification email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email redirection base path
    */
   redirectPath: string;
   /**
-   * @uiName Email Verification Header Text
+   * @uiName Email verification header text
    */
   emailVerificationHeader: string;
   /**
-   * @uiName Re-send Email Button Text
+   * @uiName Re-send email button text
    */
   resendEmailButtonText: string;
   /**
-   * @uiName Email Verification Body Text
+   * @uiName Email verification body text
    */
   verifyMessage: string;
   /**

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

@@ -8,19 +8,19 @@ export declare class PortalForgotPassword {
   /**
    * The page that users are redirected to from the password reset email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email redirection base path
    */
   redirectPath: string;
   /**
-   * @uiName Email Label
+   * @uiName Email label
    */
   emailLabel: string;
   /**
-   * @uiName Password Reset Button Text
+   * @uiName Password reset button text
    */
   submitLabel: string;
   /**
-   * @uiName Login Page Routing Path
+   * @uiName Routing path to login page
    */
   loginPath: string;
   /**

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

@@ -6,55 +6,39 @@ import { PortalLoginViewProps } from "./sqm-portal-login-view";
 export declare class PortalLogin {
   ignored: boolean;
   /**
-   * Page navigated to after sign-in
-   *
-   * @uiName Next Page Path
+   * @uiName Page navigated to after sign-in
    */
   nextPage: string;
   /**
-   * Label for email field
-   *
-   * @uiName Email Label
+   * @uiName Label for email field
    */
   emailLabel: string;
   /**
-   * Label for password field
-   *
-   * @uiName Password Label
+   * @uiName Label for password field
    */
   passwordLabel: string;
   /**
-   * Label for submit button
-   *
-   * @uiName Submit Button Text
+   * @uiName Label for submit button
    */
   submitLabel: string;
   /**
-   * Label for forgotten password button
-   *
-   * @uiName Forgot Password Text
+   * @uiName Label for forgotten password button
    */
   forgotPasswordLabel: string;
   /**
-   * Label for register button
-   *
-   * @uiName Register Button Text
+   * @uiName Label for register navigation button
    */
   registerLabel: string;
   /**
-   * @uiName Heading Label
+   * @uiName Heading label
    */
   pageLabel: string;
   /**
-   * Register redirect path
-   *
-   * @uiName Register Path
+   * @uiName Register button redirection path
    */
   registerPath: string;
   /**
-   * Forgot password redirect path
-   *
-   * @uiName Forgot Password Path
+   * @uiName Forgot password button redirect path
    */
   forgotPasswordPath: string;
   /**

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

@@ -4,7 +4,7 @@
 export declare class PortalLogout {
   ignored: boolean;
   /**
-   * @uiName Next Page Path
+   * @uiName Next Page path
    */
   nextPage: string;
   constructor();