@saasquatch/mint-components 1.6.2-7 → 1.6.2-8

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

@@ -1,13 +1,14 @@
 /**
- * The hero container
- *
  * @uiName Hero Layout
+ * @slots [{"name":"","title":"Primary Column Content"},{"name":"secondary-column","title":"Secondary Column Content"}]
  */
 export declare class Hero {
   /**
    * Number of columns in the layout
    *
    * @uiName Columns
+   * @uiEnum [1, 2]
+   * @uiEnumNames ["One", "Two"]
    */
   columns: 1 | 2;
   /**

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

@@ -1,7 +1,10 @@
 import { DemoData } from "../../global/demo";
 import { InputFieldViewProps } from "./sqm-input-field-view";
 /**
- * @uiName Input Field
+ * @uiName Form Input Field
+ * @validParents ["sqm-portal-register","sqm-portal-registration-form"]
+ * @exampleGroup Microsite Components
+ * @example Form Input Field - <sqm-input-field slot="formData" input-label="Field Label" field-type="text" error-message="Cannot be empty"></sqm-input-field>
  */
 export declare class InputField {
   ignored: boolean;

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

@@ -1,7 +1,10 @@
 import { DemoData } from "../../global/demo";
 import { NameFieldsViewProps } from "./sqm-name-fields-view";
 /**
- * @uiName Name Fields
+ * @uiName Form Name Fields
+ * @validParents ["sqm-portal-register","sqm-portal-registration-form"]
+ * @exampleGroup Microsite Components
+ * @example Form Name Fields - <sqm-name-fields first-name-label="First Name" last-name-label="Last Name"></sqm-name-fields>
  */
 export declare class NameFields {
   ignored: boolean;

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

@@ -1,7 +1,6 @@
 /**
- * A container for navigation menu items
- *
- * @uiName Navigation Sidebar
+ * @uiName Microsite Sidebar
+ * @slots [{"name":"", "title":"Sidebar Content", "validChildren":["sqm-navigation-sidebar-item"]}]
  */
 export declare class NavigationSidebar {
   ignored: boolean;

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

@@ -1,7 +1,10 @@
 import { DemoData } from "../../global/demo";
 import { NavigationSidebarItemViewProps } from "./sqm-navigation-sidebar-item-view";
 /**
- * @uiName Navigation Link
+ * @uiName Microsite Sidebar Item
+ * @validParents ["sqm-navigation-sidebar"]
+ * @exampleGroup Microsite Components
+ * @example Sidebar Item - <sqm-navigation-sidebar-item label="Sidebar Item" icon="house"></sqm-navigation-sidebar-item>
  */
 export declare class NavigationSidebarItem {
   /**

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

@@ -11,7 +11,10 @@ export interface PasswordFieldViewDemoProps {
   };
 }
 /**
- * @uiName Portal Password Field
+ * @uiName Form Password Field
+ * @validParents ["sqm-portal-register","sqm-portal-registration-form"]
+ * @exampleGroup Microsite Components
+ * @example Form Password Field - <sqm-password-field slot="formData" field-label="Password" enable-validation></sqm-password-field>
  */
 export declare class PortalPasswordField {
   ignored: boolean;

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

@@ -1,7 +1,7 @@
 import { PortalChangePasswordViewProps } from "./sqm-portal-change-password-view";
 import { DemoData } from "../../global/demo";
 /**
- * @uiName Portal Profile
+ * @uiName Microsite Password Change
  */
 export declare class PortalChangePassword {
   ignored: boolean;
@@ -36,7 +36,8 @@ export declare class PortalChangePassword {
   /**
    * Successful password change message
    *
-   * @uiName Successful Message
+   * @uiName Successful Password Change Message
+   * @uiWidget textArea
    */
   successMessage: string;
   /**

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

@@ -1,14 +1,14 @@
 import { DemoData } from "../../global/demo";
 import { PortalEmailVerificationViewProps } from "./sqm-portal-email-verification-view";
 /**
- * @uiName Portal Email Verification
+ * @uiName Microsite Email Verification
  */
 export declare class PortalEmailVerification {
   ignored: boolean;
   /**
-   * The page that users are redirected to from the verification email.
+   * The microsite page that participants are redirected to from the verification email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email Redirection Path
    */
   redirectPath: string;
   /**
@@ -21,6 +21,7 @@ export declare class PortalEmailVerification {
   resendEmailButtonText: string;
   /**
    * @uiName Email Verification Body Text
+   * @uiWidget textArea
    */
   verifyMessage: string;
   /**

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

@@ -38,18 +38,26 @@ export declare class PortalFooter {
   poweredByLink: string;
   /**
    * @uiName Padding Top
+   * @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"]
    */
   paddingTop: string;
   /**
    * @uiName Padding Right
+   * @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"]
    */
   paddingRight: string;
   /**
    * @uiName Padding Bottom
+   * @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"]
    */
   paddingBottom: string;
   /**
    * @uiName Padding Left
+   * @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"]
    */
   paddingLeft: string;
   constructor();

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

@@ -1,18 +1,18 @@
 import { DemoData } from "../../global/demo";
 import { PortalForgotPasswordViewProps } from "./sqm-portal-forgot-password-view";
 /**
- * @uiName Portal Forgot Password
+ * @uiName Microsite Forgot Password
  */
 export declare class PortalForgotPassword {
   ignored: boolean;
   /**
-   * The page that users are redirected to from the password reset email.
+   * The microsite page that participants are redirected to from the password reset email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email Redirection Path
    */
   redirectPath: string;
   /**
-   * @uiName Email Label
+   * @uiName Email Field Label
    */
   emailLabel: string;
   /**
@@ -20,9 +20,18 @@ export declare class PortalForgotPassword {
    */
   submitLabel: string;
   /**
-   * @uiName Login Page Routing Path
+   * @uiName Login Redirect Path
    */
   loginPath: string;
+  /**
+   * @uiName Header Text
+   * @uiWidget textArea
+   */
+  headerText: string;
+  /**
+   * Sign In Link Text
+   */
+  loginText: string;
   /**
    * @undocumented
    * @uiType object

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

@@ -5,6 +5,8 @@ export declare function usePortalForgotPassword(props: PortalForgotPassword): {
     error: string;
     success: boolean;
     loginPath: string;
+    headerText: string;
+    loginText: string;
   };
   callbacks: {
     submit: (event: any) => Promise<void>;

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

@@ -1,7 +1,8 @@
 import { PortalFrameViewProps } from "./sqm-portal-frame-view";
 import { DemoData } from "../../global/demo";
 /**
- * @uiName Portal Frame
+ * @uiName Microsite Frame
+ * @slots [{"name":"header","title":"Header Content"},{"name":"footer","title":"Footer Content"},{"name":"","title":"Body Content"}]
  */
 export declare class PortalFrame {
   ignored: boolean;

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

@@ -1,62 +1,49 @@
 import { DemoData } from "../../global/demo";
 import { PortalLoginViewProps } from "./sqm-portal-login-view";
 /**
- * @uiName Portal Login
+ * @uiName Microsite Login
  */
 export declare class PortalLogin {
   ignored: boolean;
   /**
-   * Page navigated to after sign-in
+   * Page participants are navigated to after login.
    *
-   * @uiName Next Page Path
+   * @uiName Login Redirect Path
    */
   nextPage: string;
   /**
-   * Label for email field
-   *
-   * @uiName Email Label
+   * @uiName Email Field Label
    */
   emailLabel: string;
   /**
-   * Label for password field
-   *
-   * @uiName Password Label
+   * @uiName Password Field Label
    */
   passwordLabel: string;
   /**
-   * Label for submit button
-   *
    * @uiName Submit Button Text
    */
   submitLabel: string;
   /**
-   * Label for forgotten password button
-   *
+   * @uiName Forgot Password Redirect Path
+   */
+  forgotPasswordPath: string;
+  /**
    * @uiName Forgot Password Text
    */
   forgotPasswordLabel: string;
   /**
-   * Label for register button
-   *
    * @uiName Register Button Text
    */
   registerLabel: string;
   /**
-   * @uiName Heading Label
-   */
-  pageLabel: string;
-  /**
-   * Register redirect path
-   *
-   * @uiName Register Path
+   * @uiName Register Button Redirect Path
    */
   registerPath: string;
   /**
-   * Forgot password redirect path
-   *
-   * @uiName Forgot Password Path
+   * @uiName Heading Label
+   * @uiWidget textArea
    */
-  forgotPasswordPath: string;
+  pageLabel: string;
   /**
    * @undocumented
    * @uiType object

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

@@ -1,10 +1,12 @@
 /**
- * @uiName Portal Logout
+ * @uiName Microsite Logout
  */
 export declare class PortalLogout {
   ignored: boolean;
   /**
-   * @uiName Next Page Path
+   * Redirect participants to this path when they log out
+   *
+   *  @uiName Logout Redirect Path
    */
   nextPage: string;
   constructor();

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

@@ -1,32 +1,24 @@
 import { PortalProfileViewProps } from "./sqm-portal-profile-view";
 import { DemoData } from "../../global/demo";
 /**
- * @uiName Portal Profile
+ * @uiName Microsite Participant Profile
  */
 export declare class PortalProfile {
   ignored: boolean;
   /**
-   * First name input field label
-   *
    * @uiName First Name Label
    */
   firstnametext: string;
   /**
-   * Last name input field label
-   *
-   * @uiName Last Name Label
+   * @uiName Last Name Field Label
    */
   lastnametext: string;
   /**
-   * Email input field label
-   *
-   * @uiName Email Label
+   * @uiName Email Field Label
    */
   emailtext: string;
   /**
-   * Country input field label
-   *
-   * @uiName Country Label
+   * @uiName Country Field Label
    */
   countrytext: string;
   /**
@@ -42,7 +34,7 @@ export declare class PortalProfile {
    */
   submitChangeButtonText: string;
   /**
-   * Show or hide the country field
+   * Show or hide the country field.
    *
    * @uiName Show Country Field
    */

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

@@ -1,19 +1,23 @@
 /**
- * @uiName Portal Protected Route
+ * @uiName Microsite Protected Route
+ * @slots [{"name":"","title":"Route Content"}]
  */
 export declare class PortalProtectedRoute {
   ignored: boolean;
   /**
+   * Redirect participants to this path they are not logged in.
+   *
    * @uiName Redirect Path
    */
   redirectTo: string;
   /**
    * @uiName Require Email Verification
-   * @default
    */
   requireEmailVerification: boolean;
   /**
-   * @uiName Redirect Unverified Users Path
+   * Redirect participants to this path when email verification is required but they have not verified their email.
+   *
+   * @uiName Unverified Participant Redirect Path
    */
   redirectToUnverified: string;
   constructor();

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

@@ -1,28 +1,29 @@
 import { DemoData } from "../../global/demo";
 import { PortalRegisterViewProps } from "./sqm-portal-register-view";
 /**
- * @uiName Portal Register
+ * @uiName Microsite Registration
+ * @slots [{"name":"formData","title":"Additional Fields"},{"name":"terms","title":"Terms And Conditions Fields"}]
  */
 export declare class PortalRegister {
   ignored: boolean;
   /**
-   * Page navigated to after registration
+   * Page participants are navigated to after registration.
    *
-   * @uiName Next Page
+   * @uiName Registration Redirect Path
    */
   nextPage: string;
   /**
-   * The page that users are redirected to from the verification email.
+   * The page that participants are redirected to from the verification email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email Redirection Path
    */
   redirectPath: string;
   /**
-   * @uiName Email Label
+   * @uiName Email Field Label
    */
   emailLabel: string;
   /**
-   * @uiName Password Label
+   * @uiName Password Field Label
    */
   passwordLabel: string;
   /**
@@ -38,10 +39,9 @@ export declare class PortalRegister {
    */
   confirmPasswordLabel: string;
   /**
-   * Show or hide the confirm password input
+   * Show or hide the confirm password input.
    *
    * @uiName Show Confirm Password Field
-   * @default
    */
   confirmPassword: boolean;
   /**
@@ -49,20 +49,19 @@ export declare class PortalRegister {
    */
   enablePasswordValidation: boolean;
   /**
-   * Hide default input fields to use custom fields
+   * Hide default input fields to use custom fields.
    *
    * @uiName Hide Default Inputs
-   * @default
    */
   hideInputs: boolean;
   /**
-   * @uiName Heading Label
+   * @uiName Header Text
    */
   pageLabel: string;
   /**
-   * Login button redirection path
+   * Login button redirection path.
    *
-   * @uiName Login Path
+   * @uiName Login Redirect Path
    */
   loginPath: string;
   /**

package/dist/types/components/sqm-portal-registration-form/sqm-portal-registration-form.d.ts

@@ -1,28 +1,29 @@
 import { DemoData } from "../../global/demo";
 import { PortalRegistrationFormViewProps } from "./sqm-portal-registration-form-view";
 /**
- * @uiName Portal Register
+ * @uiName Microsite Registration
+ * @slots [{"name":"formData","title":"Additional Fields"},{"name":"terms","title":"Terms And Conditions Fields"}]
  */
 export declare class PortalRegistrationForm {
   ignored: boolean;
   /**
-   * Page navigated to after registration
+   * Page participants are navigated to after registration.
    *
-   * @uiName Next Page
+   * @uiName Registration Redirect Path
    */
   nextPage: string;
   /**
-   * The page that users are redirected to from the verification email.
+   * The page that participants are redirected to from the verification email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email Redirection Path
    */
   redirectPath: string;
   /**
-   * @uiName Email Label
+   * @uiName Email Field Label
    */
   emailLabel: string;
   /**
-   * @uiName Password Label
+   * @uiName Password Field Label
    */
   passwordLabel: string;
   /**
@@ -38,10 +39,9 @@ export declare class PortalRegistrationForm {
    */
   confirmPasswordLabel: string;
   /**
-   * Show or hide the confirm password input
+   * Show or hide the confirm password input.
    *
    * @uiName Show Confirm Password Field
-   * @default
    */
   confirmPassword: boolean;
   /**
@@ -49,20 +49,19 @@ export declare class PortalRegistrationForm {
    */
   enablePasswordValidation: boolean;
   /**
-   * Hide default input fields to use custom fields
+   * Hide default input fields to use custom fields.
    *
    * @uiName Hide Default Inputs
-   * @default
    */
   hideInputs: boolean;
   /**
-   * @uiName Heading Label
+   * @uiName Header Text
    */
   pageLabel: string;
   /**
-   * Login button redirection path
+   * Login button redirection path.
    *
-   * @uiName Login Path
+   * @uiName Login Redirect Path
    */
   loginPath: string;
   /**

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

@@ -1,27 +1,26 @@
 import { DemoData } from "../../global/demo";
 import { PortalResetPasswordViewProps } from "./sqm-portal-reset-password-view";
 /**
- * @uiName Portal Reset Password
+ * @uiName Microsite Reset Password
  */
 export declare class PortalResetPassword {
   ignored: boolean;
   /**
-   * The page that users are redirected to when the password reset succeeds.
+   * The page that participants are redirected to when the password reset succeeds.
    *
-   * @uiName Next Page Path
+   * @uiName Reset Successful Redirect Path
    */
   nextPage: string;
   /**
-   * The page that users are redirected to if the reset fails due to outdated password reset attempt.
+   * The page that participants are redirected to if the reset fails due to outdated password reset attempt.
    *
-   * @uiName Failed Page Path
+   * @uiName Reset Failed Redirect Path
    */
   failedPage: string;
   /**
-   * Show or hide confirm password field
+   * Show or hide confirm password field.
    *
    * @uiName Show Confirm Password
-   * @default
    */
   confirmPassword: boolean;
   /**
@@ -29,9 +28,10 @@ export declare class PortalResetPassword {
    */
   resetPasswordHeader: string;
   /**
-   * Displayed after a successful password reset
+   * Displayed after a successful password reset.
    *
    * @uiName Successful Password Reset Text
+   * @uiWidget textArea
    */
   passwordResetHeader: string;
   /**
@@ -39,13 +39,13 @@ export declare class PortalResetPassword {
    */
   resetPasswordButtonText: string;
   /**
-   * Button text displayed after a successful password reset
+   * Button text displayed after a successful password reset.
    *
    * @uiName Continue Button Text
    */
   continueButtonText: string;
   /**
-   * @uiName Confirm Password Label
+   * @uiName Password Comfirmation Label
    */
   confirmPasswordFieldLabel: string;
   /**

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

@@ -1,20 +1,20 @@
 import { DemoData } from "../../global/demo";
 import { PortalVerifyEmailViewProps } from "./sqm-portal-verify-email-view";
 /**
- * @uiName Portal Verify Email
+ * @uiName Microsite Verify Email
  */
 export declare class PortalVerifyEmail {
   ignored: boolean;
   /**
-   * The page that users are redirected to when the verification succeeds.
+   * The page that participants are redirected to when the verification succeeds.
    *
-   * @uiName Next Page Path
+   * @uiName Verification Redirect Path
    */
   nextPage: string;
   /**
-   * The page that users are redirected to if verification fails due to outdated verification attempt.
+   * The page that participants are redirected to if verification fails due to outdated verification attempt.
    *
-   * @uiName Failed Page Path
+   * @uiName Verification Failed Redirect Path
    */
   failedPage: string;
   /**

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

@@ -1,5 +1,6 @@
 /**
- * @uiName Portal Menu
+ * @uiName Microsite Program Menu
+ * @slots [{"name":"","title":"Menu Content"}]
  * @canvasRenderer always-replace
  */
 export declare class ProgramMenu {