@saasquatch/mint-components 1.6.2-4 → 1.6.2-40

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

@@ -3,6 +3,7 @@
  * Spacing is left up to the child
  *
  * @uiName Divided Layout
+ * @slots [{"name":"", "title":"Layout Content"}]
  */
 export declare class DividedLayout {
   /**
@@ -13,7 +14,7 @@ export declare class DividedLayout {
    */
   direction: "row" | "column";
   /**
-   * Uses Shorthand CSS border syntax
+   * Uses Shorthand CSS border syntax allowing specification of thickness, fill style and color.
    * @uiName Border Style
    */
   dividerStyle: string;

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

@@ -1,8 +1,8 @@
 import { VNode } from "../../stencil-public-runtime";
-import { ValidationErrors } from "../sqm-portal-register/useValidationState";
+import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export interface DropdownFieldViewProps {
   states: {
-    validationErrors?: ValidationErrors;
+    registrationFormState?: RegistrationFormState;
   };
   content: {
     dropdownName: string;

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

@@ -1,12 +1,18 @@
 import { DemoData } from "../../global/demo";
 import { DropdownFieldViewProps } from "./sqm-dropdown-field-view";
 /**
- * @uiName Dropdown Field
+ * @uiName Form Dropdown Field
+ * @validParents ["sqm-portal-register","sqm-portal-registration-form"]
+ * @slots [{"name":"", "title":"Drop Down Option"}]
+ * @exampleGroup Microsite Components
+ * @example Form Dropdown Field - <sqm-dropdown-field dropdown-label="Select an option" error-message="Select an option"><sl-menu-item value="option-1">Option 1</sl-menu-item><sl-menu-item value="option-2">Option 2</sl-menu-item><sl-menu-item value="option-3">Option 3</sl-menu-item></sqm-dropdown-field>
  */
 export declare class DropdownField {
   ignored: boolean;
   /**
+   * This name is used as the key for this form field on submission. The name must be unique within this specific form.
    * @uiName Dropdown Name Attribute
+   * @required
    */
   dropdownName: string;
   /**

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

@@ -1,5 +1,6 @@
+import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export declare function useDropdownField(): {
   states: {
-    validationErrors: import("../sqm-portal-register/useValidationState").ValidationErrors;
+    registrationFormState: RegistrationFormState;
   };
 };

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

@@ -1,7 +1,7 @@
 import { EditProfileViewProps } from "./sqm-edit-profile-view";
 import { DemoData } from "../../global/demo";
 /**
- * @uiName Edit Profile
+ * @uiName Microsite Edit Profile
  */
 export declare class EditProfile {
   ignored: boolean;

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

@@ -1,5 +1,6 @@
 /**
  * @uiName Form Message
+ * @slots [{"name":"","title":"Message Content"}]
  */
 export declare class FormMessage {
   ignored: boolean;

package/dist/types/components/sqm-graphql-client-provider/sqm-graphql-client-provider.d.ts

@@ -1,6 +1,7 @@
 /**
  * @uiName GraphQL Client Provider
  * @canvasRenderer always-replace
+ * @slots [{"name":"","title":"Provider Content"}]
  */
 export declare class GraphQLClientProvider {
   ignored: boolean;

package/dist/types/components/sqm-header-logo/sqm-header-logo.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @uiName Header Logo
+ */
+export declare class HeroImage {
+  /**
+   * @uiWidget ImageUpload
+   * @format url
+   * @uiName Logo Image
+   */
+  imageUrl: string;
+  /**
+   * Page participants are navigated to after clicking the header logo.
+   *
+   * @uiName Redirect Path
+   * @uiWidget pageSelect
+   */
+  nextPage: string;
+  /**
+   * @uiName Logo Height
+   */
+  height: number;
+  constructor();
+  disconnectedCallback(): void;
+  render(): any;
+}

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-hero-image/sqm-hero-image.d.ts

@@ -2,8 +2,8 @@ import { Spacing } from "../../global/mixins";
 /**
  * @uiName Hero Image
  * @exampleGroup Common Components
- * @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>
+ * @example Two Column Hero Image - <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 Hero Image - <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 {
   /**

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

@@ -21,7 +21,7 @@ export declare class Image {
   /**
    * @uiName Background Color
    * @uiWidget color
-   * @format
+   * @format color
    */
   backgroundColor: string;
   /**

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

@@ -1,7 +1,7 @@
-import { ValidationErrors } from "../sqm-portal-register/useValidationState";
+import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export interface InputFieldViewProps {
   states: {
-    validationErrors?: ValidationErrors;
+    registrationFormState?: RegistrationFormState;
   };
   content: {
     fieldName: string;

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

@@ -1,14 +1,18 @@
 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 input-label="Field Label" field-type="text" error-message="Cannot be empty"></sqm-input-field>
  */
 export declare class InputField {
   ignored: boolean;
   /**
-   * Used as the key of the inputs value in form data.
+   * This name is used as the key for this form field on submission. The name must be unique within this specific form.
    *
    * @uiName Input Name Attribute
+   * @required
    */
   fieldName: string;
   /**

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

@@ -1,5 +1,6 @@
+import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export declare function useInputField(): {
   states: {
-    validationErrors: import("../sqm-portal-register/useValidationState").ValidationErrors;
+    registrationFormState: RegistrationFormState;
   };
 };

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

@@ -1,8 +1,6 @@
-import { ValidationErrors } from "../sqm-portal-register/useValidationState";
 import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export interface NameFieldsViewProps {
   states: {
-    validationErrors?: ValidationErrors;
     registrationFormState?: RegistrationFormState;
     content: {
       firstNameLabel: string;

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-name-fields/useNameFields.d.ts

@@ -2,7 +2,6 @@ import { RegistrationFormState } from "../sqm-portal-registration-form/useRegist
 import { NameFields } from "./sqm-name-fields";
 export declare function useNameFields(props: NameFields): {
   states: {
-    validationErrors: import("../sqm-portal-register/useValidationState").ValidationErrors;
     registrationFormState: RegistrationFormState;
     content: {
       lastNameLabel: string;

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"}]
  */
 export declare class NavigationSidebar {
   ignored: boolean;

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

@@ -1,11 +1,15 @@
 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 {
   /**
    * @uiName Navigation Path
+   * @uiWidget pageSelect
    */
   path: string;
   /**

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

@@ -5,7 +5,6 @@ export interface PortalPasswordFieldViewProps {
     enableValidation: boolean;
     dynamicValidation: VNode | string;
     registrationFormState: RegistrationFormState;
-    validationErrors: Record<string, string>;
     content: {
       fieldLabel: string;
     };

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

@@ -3,7 +3,6 @@ export interface PasswordFieldViewDemoProps {
   initValue: string;
   states: {
     enableValidation: boolean;
-    validationErrors: Record<string, string>;
     registrationFormState: RegistrationFormState;
     content: {
       fieldLabel: string;
@@ -11,7 +10,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 field-label="Password"></sqm-password-field>
  */
 export declare class PortalPasswordField {
   ignored: boolean;
@@ -22,10 +24,10 @@ export declare class PortalPasswordField {
    */
   fieldLabel: string;
   /**
-   * Enable live password validation
-   * @uiName Enable Validation
+   * Disable live password validation
+   * @uiName Disable Validation
    */
-  enableValidation: boolean;
+  disableValidation: boolean;
   /**
    * @undocumented
    * @uiType object

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

@@ -1,5 +1,7 @@
 /**
- * @uiName Popup Container For Widgets
+ * @uiName Popup Container
+ * @slots [{"name":"","title":"Content"}]
+ * @canvasRenderer always-replace
  */
 export declare class PopupContainer {
   /**

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;
@@ -10,25 +10,25 @@ export declare class PortalChangePassword {
    */
   modalChangePasswordHeader: string;
   /**
-   * Modal cancel button text
+   * Found in modal
    *
    * @uiName Cancel Button Text
    */
   cancelText: string;
   /**
-   * Modal change password button text
+   * Found in modal
    *
    * @uiName Change Password Button Text
    */
   changePasswordButtonText: string;
   /**
-   * Password input field label
+   * Found in modal
    *
-   * @uiName Password Label
+   * @uiName New Password Field Label
    */
   passwordFieldLabel: string;
   /**
-   * Password confirmation input field label
+   * Found in modal
    *
    * @uiName Confirm Password Label
    */
@@ -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-container/sqm-portal-container.d.ts

@@ -3,8 +3,8 @@ import { Spacing } from "../../global/mixins";
  * @uiName Container
  * @slots [{"name":"", "title":"Widget Content"}]
  * @exampleGroup Layout
- * @example Row Layout Container - <sqm-portal-container direction="row" padding="none" gap="xxx-large" display="flex" max-width="100%"><p>Add your column content above or below!</p></sqm-portal-container>
- * @example Column Layout Container - <sqm-portal-container direction="column" padding="none" gap="xxx-large" display="grid" max-width="100%"><p>Add your column content to the left or right!</p></sqm-portal-container>
+ * @example Row Layout Container - <sqm-portal-container direction="row" padding="none" gap="xxx-large" display="flex" max-width="100%"><p>Add your row content!</p></sqm-portal-container>
+ * @example Column Layout Container - <sqm-portal-container direction="column" padding="none" gap="xxx-large" display="grid" max-width="100%"><p>Add your column content!</p></sqm-portal-container>
  */
 export declare class PortalContainer {
   ignored: boolean;

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

@@ -1,14 +1,15 @@
 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.
+   * Redirect participants to this page from their verification email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email Redirect
+   * @uiWidget pageSelect
    */
   redirectPath: string;
   /**
@@ -21,6 +22,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-view.d.ts

@@ -9,7 +9,7 @@ declare type PortalFooterViewProps = {
   termsText?: string;
   supportText?: string;
   supportEmail?: string;
-  showPoweredBy?: boolean;
+  hidePoweredBy?: boolean;
   poweredByLink?: string;
 };
 export declare function PortalFooterView(props: PortalFooterViewProps): any;

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

@@ -1,5 +1,5 @@
 /**
- * @uiName Portal Footer
+ * @uiName Footer
  */
 export declare class PortalFooter {
   ignored: boolean;
@@ -9,6 +9,7 @@ export declare class PortalFooter {
   supportEmail: string;
   /**
    * @uiName Support Text
+   * @uiWidget textArea
    */
   supportText: string;
   /**
@@ -28,27 +29,35 @@ export declare class PortalFooter {
    */
   faqText?: string;
   /**
-   * @uiName Show Powered By SaaSquatch
+   * @uiName Hide Powered By SaaSquatch
    */
-  showPoweredBy: boolean;
+  hidePoweredBy: boolean;
   /**
    * @uiName Powered By Link
    */
   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,19 @@
 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.
+   * Redirect participants to this page after they verify their email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email Redirect
+   * @uiWidget pageSelect
    */
   redirectPath: string;
   /**
-   * @uiName Email Label
+   * @uiName Email Field Label
    */
   emailLabel: string;
   /**
@@ -20,9 +21,19 @@ export declare class PortalForgotPassword {
    */
   submitLabel: string;
   /**
-   * @uiName Login Page Routing Path
+   * @uiName Login Redirect Path
+   * @uiWidget pageSelect
    */
   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-view.d.ts

@@ -7,5 +7,6 @@ export interface PortalFrameViewProps {
   callbacks: {
     rerender: Function;
   };
+  notFullScreen?: boolean;
 }
 export declare function PortalFrameView(props: PortalFrameViewProps, children: VNode): any;

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

@@ -1,10 +1,15 @@
 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;
+  /**
+   * @undocumented
+   */
+  notFullScreen?: boolean;
   /**
    * @undocumented
    * @uiType object

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

@@ -1,62 +1,54 @@
 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
+   * Redirect participants to this page after they successfully login.
    *
-   * @uiName Next Page Path
+   * @uiName Login Redirect
+   * @uiWidget pageSelect
    */
   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
-   *
+   * Redirect participants to this page to reset their password
+   * @uiName Forgot Password Redirect
+   * @uiWidget pageSelect
+   */
+  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
+   * Redirect participants to this page to start registration.
+   * @uiName Register Button Redirect
+   * @uiWidget pageSelect
    */
   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,13 @@
 /**
- * @uiName Portal Logout
+ * @uiName Microsite Logout
  */
 export declare class PortalLogout {
   ignored: boolean;
   /**
-   * @uiName Next Page Path
+   * Redirect participants to this page when they log out.
+   *
+   * @uiName Logout Redirect Path
+   * @uiWidget pageSelect
    */
   nextPage: string;
   constructor();