@saasquatch/mint-components 1.7.0-7 → 1.7.0-9

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

@@ -9,8 +9,6 @@ interface PortalContainerViewProps {
   minWidth?: string;
   maxWidth?: string;
   justifyContent?: "start" | "center" | "end" | "space-between" | "space-around" | "space-evenly";
-  backgroundColor?: string;
-  borderRadius?: number;
 }
 export declare function PortalContainerView(props: PortalContainerViewProps, children: VNode): any;
 export {};

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;
@@ -29,17 +29,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 Background Color
-   * @uiWidget color
-   */
-  backgroundColor?: string;
-  /**
-   * Configure border radius with pixel amount.
-   * @uiName Border Radius
-   */
-  borderRadius?: number;
-  /** @uiName Minimum width */
+  /** @uiName Minimum Width */
   minWidth?: string;
   /**
    * @uiName Display

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

@@ -29,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();

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,11 +34,9 @@ export declare class PortalProfile {
    */
   submitChangeButtonText: string;
   /**
-   * Show or hide the country field
-   *
-   * @uiName Show Country Field
+   * @uiName Hide Country Field
    */
-  showCountry: boolean;
+  hideCountry: boolean;
   /**
    * @undocumented
    * @uiType object

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

@@ -7,6 +7,6 @@ export interface PortalProfileProps {
   editProfileHeader: string;
   editProfileSubHeader: string;
   submitChangeButtonText: string;
-  showCountry: boolean;
+  hideCountry: boolean;
 }
 export declare function usePortalProfile(props: PortalProfileProps): PortalProfileViewProps;

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;
   /**
-   * @uiName Redirect Path
+   * Redirect participants to this page they are not logged in.
+   *
+   * @uiName Unauthenticated Participant Redirect
    */
   redirectTo: string;
   /**
    * @uiName Require Email Verification
-   * @default
    */
   requireEmailVerification: boolean;
   /**
-   * @uiName Redirect Unverified Users Path
+   * Redirect participants to this page when email verification is required but they have not verified their email.
+   *
+   * @uiName Unverified Participant Redirect
    */
   redirectToUnverified: string;
   constructor();

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

@@ -1,13 +1,13 @@
 import { VNode } from "../../stencil-public-runtime";
-import { FormState } from "./useValidationState";
+import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export interface PortalRegisterViewProps {
   states: {
     error: string;
     loading: boolean;
     confirmPassword: boolean;
     hideInputs: boolean;
-    validationState?: FormState;
-    enablePasswordValidation?: boolean;
+    registrationFormState: RegistrationFormState;
+    disablePasswordValidation?: boolean;
     loginPath: string;
   };
   callbacks: {

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

@@ -1,28 +1,31 @@
 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
+   * Redirect participants to this page from their verification email
    *
-   * @uiName Next Page
+   * @uiName Registration Redirect
+   * @uiWidget pageSelect
    */
   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 Verification Redirect
+   * @uiWidget pageSelect
    */
   redirectPath: string;
   /**
-   * @uiName Email Label
+   * @uiName Email Field Label
    */
   emailLabel: string;
   /**
-   * @uiName Password Label
+   * @uiName Password Field Label
    */
   passwordLabel: string;
   /**
@@ -34,35 +37,32 @@ export declare class PortalRegister {
    */
   loginLabel: string;
   /**
-   * @uiName Confirm Password Label
+   * @uiName Confirm Password Field Label
    */
   confirmPasswordLabel: string;
   /**
-   * Show or hide the confirm password input
-   *
    * @uiName Show Confirm Password Field
-   * @default
    */
   confirmPassword: boolean;
   /**
-   * @uiName Enable Password Validation
+   * @uiName Disable Password Validation
    */
-  enablePasswordValidation: boolean;
+  disablePasswordValidation: boolean;
   /**
-   * Hide default input fields to use custom fields
+   * Hides the email and password fields. Note: If you hide default inputs, you must add additional input fields. They must have the input name attributes "email" and "password" for this form to succeed.
    *
-   * @uiName Hide Default Inputs
-   * @default
+   * @uiName Hide Default Fields
    */
   hideInputs: boolean;
   /**
-   * @uiName Heading Label
+   * @uiName Header Text
    */
   pageLabel: string;
   /**
-   * Login button redirection path
+   * Redirect participants to this page after clicking the login button.
    *
-   * @uiName Login Path
+   * @uiName Login Redirect
+   * @uiWidget pageSelect
    */
   loginPath: string;
   /**

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

@@ -8,10 +8,11 @@ export declare function usePortalRegister(props: PortalRegister): {
   states: {
     loading: boolean;
     error: string;
-    validationState: import("./useValidationState").FormState;
+    registrationFormState: import("../sqm-portal-registration-form/useRegistrationFormState").RegistrationFormState;
     confirmPassword: boolean;
     hideInputs: boolean;
     loginPath: string;
+    disablePasswordValidation: boolean;
   };
   callbacks: {
     submit: (event: any) => Promise<void>;

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

@@ -0,0 +1,10 @@
+declare const _default: {
+  title: string;
+};
+export default _default;
+export declare const Default: () => any;
+export declare const RegisterWithError: () => any;
+export declare const RegisterLoading: () => any;
+export declare const FieldsHidden: () => any;
+export declare const SlottedInputs: () => any;
+export declare const TermsAndConditions: () => any;

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

@@ -0,0 +1,37 @@
+import { VNode } from "../../stencil-public-runtime";
+import { RegistrationFormState } from "./useRegistrationFormState";
+export interface PortalRegistrationFormViewProps {
+  states: {
+    error: string;
+    loading: boolean;
+    confirmPassword: boolean;
+    hideInputs: boolean;
+    registrationFormState?: RegistrationFormState;
+    enablePasswordValidation?: boolean;
+    loginPath: string;
+  };
+  callbacks: {
+    submit: Function;
+    inputFunction: Function;
+  };
+  content: {
+    formData?: VNode;
+    terms?: VNode;
+    passwordField?: VNode;
+    secondaryButton?: VNode;
+    emailLabel?: string;
+    passwordLabel?: string;
+    submitLabel?: string;
+    pageLabel?: string;
+    confirmPasswordLabel?: string;
+    networkErrorMessage?: string;
+    passwordMismatchErrorMessage?: string;
+    invalidEmailErrorMessage?: string;
+    formDisabledErrorMessage?: string;
+    requiredFieldErrorMessage?: string;
+  };
+  refs: {
+    formRef: any;
+  };
+}
+export declare function PortalRegistrationFormView(props: PortalRegistrationFormViewProps): any;

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

@@ -0,0 +1,118 @@
+import { DemoData } from "../../global/demo";
+import { PortalRegistrationFormViewProps } from "./sqm-portal-registration-form-view";
+/**
+ * @uiName Microsite Registration
+ * @slots [{"name":"formData","title":"Additional Fields"},{"name":"terms","title":"Terms And Conditions Fields"}]
+ */
+export declare class PortalRegistrationForm {
+  ignored: boolean;
+  /**
+   * Redirect participants to this page after they successfully register.
+   *
+   * @uiName Registration Redirect
+   * @uiWidget pageSelect
+   */
+  nextPage: string;
+  /**
+   * Redirect participants to this page from their verification email
+   *
+   * @uiName Email Verification Redirect
+   * @uiWidget pageSelect
+   */
+  redirectPath: string;
+  /**
+   * @uiName Email Field Label
+   */
+  emailLabel: string;
+  /**
+   * @uiName Password Field Label
+   */
+  passwordLabel: string;
+  /**
+   * @uiName Submit Button Text
+   */
+  submitLabel: string;
+  /**
+   * @uiName Login Button Text
+   */
+  loginLabel: string;
+  /**
+   * @uiName Confirm Password Field Label
+   */
+  confirmPasswordLabel: string;
+  /**
+   * @uiName Show Confirm Password Field
+   */
+  confirmPassword: boolean;
+  /**
+   * @uiName Disable Password Validation
+   */
+  disablePasswordValidation: boolean;
+  /**
+   * Hides the email and password fields. Note: If you hide default inputs, you must add additional input fields. They must have the input name attributes "email" and "password" for this form to succeed.
+   *
+   * @uiName Hide Default Fields
+   */
+  hideInputs: boolean;
+  /**
+   * @uiName Header Text
+   */
+  pageLabel: string;
+  /**
+   * Redirect participants to this page after clicking the login button.
+   *
+   * @uiName Login Redirect
+   * @uiWidget pageSelect
+   */
+  loginPath: string;
+  /**
+   * The message to be displayed when a required field is not filled.
+   *
+   * @uiName Required Field Message
+   * @uiWidget textArea
+   */
+  requiredFieldErrorMessage: string;
+  /**
+   * The message to be displayed when a the form submission fails unexpectedly.
+   *
+   * @uiName Network Error Message
+   * @uiWidget textArea
+   */
+  networkErrorMessage: string;
+  /**
+   * The message to be displayed when password inputs do not match.
+   *
+   * @uiName Password Mismatch Message
+   * @uiWidget textArea
+   */
+  passwordMismatchErrorMessage: string;
+  /**
+   * The message to be displayed when the email used is invalid or blocked.
+   *
+   * @uiName Invalid Email Message
+   * @uiWidget textArea
+   */
+  invalidEmailErrorMessage: string;
+  /**
+   * The message to be displayed when the registration form is disabled.
+   *
+   * @uiName Form Disabled Message
+   * @uiWidget textArea
+   */
+  formDisabledErrorMessage: string;
+  /**
+   * The key of the registration form used for this microsite.
+   *
+   * @uiName Form Key
+   * @required
+   */
+  formKey: string;
+  /**
+   * @undocumented
+   * @uiType object
+   */
+  demoData?: DemoData<PortalRegistrationFormViewProps>;
+  constructor();
+  disconnectedCallback(): void;
+  render(): any;
+}