@saasquatch/mint-components 1.14.6-9 → 1.14.7-0

package/dist/types/components/sqm-lead-form/LeadCheckboxField.stories.d.ts

@@ -0,0 +1,55 @@
+declare const _default: {
+  title: string;
+  parameters: {
+    scenario: string;
+  };
+};
+export default _default;
+export declare const Default: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
+export declare const DefaultChecked: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
+export declare const CustomLabel: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
+export declare const Error: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
+export declare const CustomError: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
+export declare const TermsAndConditions: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
+export declare const TermsAndConditionsCustomLabel: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
+export declare const TermsAndConditionsLongCustomLabel: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};

package/dist/types/components/sqm-lead-form/LeadFormDropdownField.stories.d.ts

@@ -3,6 +3,7 @@ declare const _default: {
 };
 export default _default;
 export declare const Default: () => any;
+export declare const Multiple: () => any;
 export declare const WithError: () => any;
 export declare const Disabled: () => any;
 export declare const Loading: () => any;

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

@@ -0,0 +1,19 @@
+import { LeadFormState } from "./useLeadFormState";
+export interface LeadCheckboxFieldViewProps {
+  states: {
+    leadFormState?: LeadFormState;
+    checked: boolean;
+  };
+  content: {
+    checkboxName: string;
+    checkboxLabel: string;
+    checkboxLabelLink?: string;
+    checkboxLabelLinkText?: string;
+    checkboxOptional?: boolean;
+    errorMessage?: string;
+  };
+  callbacks: {
+    setChecked: Function;
+  };
+}
+export declare function LeadCheckboxFieldView(props: LeadCheckboxFieldViewProps): any;

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

@@ -0,0 +1,46 @@
+import { DemoData } from "../../global/demo";
+import { LeadCheckboxFieldViewProps } from "./sqm-lead-checkbox-field-view";
+/**
+ * @uiName Lead Form Checkbox Field
+ * @validParents ["sqm-lead-form"]
+ */
+export declare class LeadCheckboxField {
+  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 Checkbox name attribute
+   * @required
+   */
+  checkboxName: string;
+  /**
+   * @uiName Checkbox label
+   * @uiWidget textArea
+   */
+  checkboxLabel: string;
+  /**
+   * Used with link text if the checkbox label contains {labelLink}
+   *
+   * @uiName Checkbox label link
+   */
+  checkboxLabelLink?: string;
+  /**
+   * @uiName Checkbox label link lext
+   */
+  checkboxLabelLinkText?: string;
+  /**
+   * @uiName Unchecked error message
+   */
+  errorMessage?: string;
+  /**
+   * @uiName Optional
+   */
+  checkboxOptional?: boolean;
+  /**
+   * @undocumented
+   * @uiType object
+   */
+  demoData?: DemoData<LeadCheckboxFieldViewProps>;
+  constructor();
+  disconnectedCallback(): void;
+  render(): any;
+}

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

@@ -7,7 +7,9 @@ export interface DropdownFieldViewProps {
   content: {
     dropdownName: string;
     dropdownLabel: string;
-    dropdownOptional?: boolean;
+    dropdownOptional: boolean;
+    optionalLabel: string;
+    multiple: boolean;
     requiredFieldErrorMessage?: string;
     selectOptions?: VNode | VNode[];
   };

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

@@ -3,9 +3,7 @@ import { DropdownFieldViewProps } from "./sqm-lead-dropdown-field-view";
 /**
  * @uiName Lead Form Dropdown Field
  * @validParents ["sqm-lead-form"]
- * @slots [{"name":"", "title":"Drop Down Option"}]
- * @exampleGroup Microsite Components
- * @example Lead Form Dropdown Field - <sqm-lead-dropdown-field dropdown-label="Select an option" required-field-error-message="Please 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-lead-dropdown-field>
+ * @slots [{"name":"", "title":"Dropdown Option"}]
  */
 export declare class LeadDropdownField {
   ignored: boolean;
@@ -26,11 +24,20 @@ export declare class LeadDropdownField {
    * @uiWidget textArea
    */
   requiredFieldErrorMessage: string;
+  /**
+   * @uiName Optional label
+   */
+  optionalLabel: string;
   /**
    * @uiName Optional
    * @default
    */
-  dropdownOptional?: boolean;
+  dropdownOptional: boolean;
+  /**
+   * @uiName Multiple selection
+   * @default
+   */
+  multiple: boolean;
   /**
    * @undocumented
    * @uiType object

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

@@ -11,6 +11,7 @@ export interface LeadFormViewProps {
   callbacks: {
     submit: Function;
     inputFunction: Function;
+    resetForm: Function;
   };
   content: {
     formData?: VNode;
@@ -20,7 +21,7 @@ export interface LeadFormViewProps {
     submitLabel?: string;
     resubmitFormLabel?: string;
     pageLabel?: string;
-    supportLink?: string;
+    supportLinkText?: string;
     submitSuccessHeader?: string;
     submitSuccessDescription?: string;
     submitErrorHeader?: string;

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

@@ -2,7 +2,7 @@ import { DemoData } from "../../global/demo";
 import { LeadFormViewProps } from "./sqm-lead-form-view";
 /**
  * @uiName Lead Form
- * @slots [{"name":"formData","title":"Additional Fields"},{"name":"terms","title":"Terms And Conditions Fields"}]
+ * @slots [{"name":"formData","title":"Additional Fields"}]
  */
 export declare class LeadForm {
   ignored: boolean;
@@ -30,43 +30,52 @@ export declare class LeadForm {
    * @uiName Header text
    */
   pageLabel: string;
+  /**
+   * Key of the form to connect to. Create and manage forms in the /advocate dashboard under Data > Forms.
+   * @uiName Form key
+   */
   formKey: string;
   /**
-   * Optional support link for error messages.
+   * Optional support link text for error messages.
+   * @uiName Support link text
    */
-  supportLink: string;
+  supportLinkText: string;
   /**
-   * Header text shown on successful submission.
+   * Header text shown on successful lead submission.
+   * @uiName Submit success header
    */
   submitSuccessHeader: string;
   /**
-   * Description text shown on successful submission.
+   * Description text shown on successful lead submission.
+   * @uiName Submit success description
    */
   submitSuccessDescription: string;
   /**
-   * Header text shown when an error occurs.
+   *  Header text shown if an error occurs.
+   * @uiName Submit error header
    */
   submitErrorHeader: string;
   /**
-   * Description text shown when an error occurs.
+   * Description text shown if an error occurs.
+   * @uiName Submit error description
    */
   submitErrorDescription: string;
   /**
-   * The message to be displayed when a required field is not filled.
+   * The message to be displayed if 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.
+   * The message to be displayed if a the form submission fails unexpectedly.
    *
    * @uiName Network error message
    * @uiWidget textArea
    */
   networkErrorMessage: string;
   /**
-   * The message to be displayed when the email used is invalid or blocked.
+   * The message to be displayed if the email used is invalid.
    *
    * @uiName Invalid email message
    * @uiWidget textArea

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

@@ -6,6 +6,7 @@ export interface LeadInputFieldViewProps {
   content: {
     fieldName: string;
     fieldLabel: string;
+    optionalLabel: string;
     fieldType: "date" | "tel" | "text";
     fieldOptional?: boolean;
     requiredFieldErrorMessage: string;

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

@@ -3,8 +3,6 @@ import { LeadInputFieldViewProps } from "./sqm-lead-input-field-view";
 /**
  * @uiName Lead Form Input Field
  * @validParents ["sqm-lead-form"]
- * @exampleGroup Microsite Components
- * @example Lead Form Input Field - <sqm-input-field input-label="Field Label" field-type="text" error-message="Cannot be empty"></sqm-input-field>
  */
 export declare class LeadInputField {
   ignored: boolean;
@@ -19,6 +17,10 @@ export declare class LeadInputField {
    * @uiName Input label
    */
   fieldLabel: string;
+  /**
+   * @uiName Optional label
+   */
+  optionalLabel: string;
   /**
    * @uiName Input type
    * @uiType string

package/dist/types/components/sqm-lead-form/useCheckboxField.d.ts

@@ -0,0 +1,11 @@
+import { LeadFormState } from "./useLeadFormState";
+import { LeadCheckboxField } from "./sqm-lead-checkbox-field";
+export declare function useLeadCheckboxField(props: LeadCheckboxField): {
+  states: {
+    leadFormState: LeadFormState;
+    checked: boolean;
+  };
+  callbacks: {
+    setChecked: (value: boolean | ((prev: boolean) => boolean)) => void;
+  };
+};

package/dist/types/components/sqm-lead-form/useLeadForm.d.ts

@@ -18,6 +18,7 @@ export declare function useLeadForm(props: LeadForm): {
   callbacks: {
     submit: (event: any) => Promise<void>;
     inputFunction: (e: any) => void;
+    resetForm: () => void;
   };
   refs: {
     formRef: {

package/dist/types/components/sqm-referral-iframe/useReferralIframe.d.ts

@@ -1,3 +1,3 @@
 import { SqmReferralIframe } from "./sqm-referral-iframe";
 import { ReferralIframeViewProps } from "./sqm-referral-iframe-view";
-export declare function useReferralIframe(props?: SqmReferralIframe): ReferralIframeViewProps;
+export declare function useReferralIframe(props: SqmReferralIframe): ReferralIframeViewProps;

package/dist/types/components.d.ts

@@ -22,6 +22,7 @@ import { UseIndirectTaxFormResult } from "./components/tax-and-cash/sqm-indirect
 import { InputFieldViewProps } from "./components/sqm-input-field/sqm-input-field-view";
 import { EmailRegistrationViewProps } from "./components/views/email-registration-view";
 import { GenericTableViewProps } from "./tables/GenericTableView";
+import { LeadCheckboxFieldViewProps } from "./components/sqm-lead-form/sqm-lead-checkbox-field-view";
 import { DropdownFieldViewProps as DropdownFieldViewProps1 } from "./components/sqm-lead-form/sqm-lead-dropdown-field-view";
 import { LeadFormViewProps } from "./components/sqm-lead-form/sqm-lead-form-view";
 import { LeadInputFieldViewProps } from "./components/sqm-lead-form/sqm-lead-input-field-view";
@@ -1480,6 +1481,41 @@ export namespace Components {
         "renderCell": (data: Invoice) => Promise<any>;
         "renderLabel": () => Promise<any>;
     }
+    interface SqmLeadCheckboxField {
+        /**
+          * @uiName Checkbox label
+          * @uiWidget textArea
+         */
+        "checkboxLabel": string;
+        /**
+          * Used with link text if the checkbox label contains {labelLink}
+          * @uiName Checkbox label link
+         */
+        "checkboxLabelLink"?: string;
+        /**
+          * @uiName Checkbox label link lext
+         */
+        "checkboxLabelLinkText"?: string;
+        /**
+          * This name is used as the key for this form field on submission. The name must be unique within this specific form.
+          * @uiName Checkbox name attribute
+          * @required
+         */
+        "checkboxName": string;
+        /**
+          * @uiName Optional
+         */
+        "checkboxOptional"?: boolean;
+        /**
+          * @undocumented 
+          * @uiType object
+         */
+        "demoData"?: DemoData<LeadCheckboxFieldViewProps>;
+        /**
+          * @uiName Unchecked error message
+         */
+        "errorMessage"?: string;
+    }
     interface SqmLeadDropdownField {
         /**
           * @undocumented 
@@ -1500,7 +1536,16 @@ export namespace Components {
           * @uiName Optional
           * @default
          */
-        "dropdownOptional"?: boolean;
+        "dropdownOptional": boolean;
+        /**
+          * @uiName Multiple selection
+          * @default
+         */
+        "multiple": boolean;
+        /**
+          * @uiName Optional label
+         */
+        "optionalLabel": string;
         /**
           * The message to be displayed when a required field is not filled.
           * @uiName Required field message
@@ -1522,9 +1567,13 @@ export namespace Components {
           * @uiName First Name field label
          */
         "firstNameLabel": string;
+        /**
+          * Key of the form to connect to. Create and manage forms in the /advocate dashboard under Data > Forms.
+          * @uiName Form key
+         */
         "formKey": string;
         /**
-          * The message to be displayed when the email used is invalid or blocked.
+          * The message to be displayed if the email used is invalid.
           * @uiName Invalid email message
           * @uiWidget textArea
          */
@@ -1534,7 +1583,7 @@ export namespace Components {
          */
         "lastNameLabel": string;
         /**
-          * The message to be displayed when a the form submission fails unexpectedly.
+          * The message to be displayed if a the form submission fails unexpectedly.
           * @uiName Network error message
           * @uiWidget textArea
          */
@@ -1544,7 +1593,7 @@ export namespace Components {
          */
         "pageLabel": string;
         /**
-          * The message to be displayed when a required field is not filled.
+          * The message to be displayed if a required field is not filled.
           * @uiName Required field message
           * @uiWidget textArea
          */
@@ -1554,11 +1603,13 @@ export namespace Components {
          */
         "resubmitFormLabel": string;
         /**
-          * Description text shown when an error occurs.
+          * Description text shown if an error occurs.
+          * @uiName Submit error description
          */
         "submitErrorDescription": string;
         /**
-          * Header text shown when an error occurs.
+          * Header text shown if an error occurs.
+          * @uiName Submit error header
          */
         "submitErrorHeader": string;
         /**
@@ -1566,17 +1617,20 @@ export namespace Components {
          */
         "submitLabel": string;
         /**
-          * Description text shown on successful submission.
+          * Description text shown on successful lead submission.
+          * @uiName Submit success description
          */
         "submitSuccessDescription": string;
         /**
-          * Header text shown on successful submission.
+          * Header text shown on successful lead submission.
+          * @uiName Submit success header
          */
         "submitSuccessHeader": string;
         /**
-          * Optional support link for error messages.
+          * Optional support link text for error messages.
+          * @uiName Support link text
          */
-        "supportLink": string;
+        "supportLinkText": string;
     }
     interface SqmLeadInputField {
         /**
@@ -1606,6 +1660,10 @@ export namespace Components {
           * @uiEnumNames ["Text", "Date", "Phone Number"]
          */
         "fieldType": "text" | "date" | "tel";
+        /**
+          * @uiName Optional label
+         */
+        "optionalLabel": string;
         /**
           * The message to be displayed when a required field is not filled.
           * @uiName Required field message
@@ -6359,6 +6417,12 @@ declare global {
         prototype: HTMLSqmInvoiceTableDownloadColumnElement;
         new (): HTMLSqmInvoiceTableDownloadColumnElement;
     };
+    interface HTMLSqmLeadCheckboxFieldElement extends Components.SqmLeadCheckboxField, HTMLStencilElement {
+    }
+    var HTMLSqmLeadCheckboxFieldElement: {
+        prototype: HTMLSqmLeadCheckboxFieldElement;
+        new (): HTMLSqmLeadCheckboxFieldElement;
+    };
     interface HTMLSqmLeadDropdownFieldElement extends Components.SqmLeadDropdownField, HTMLStencilElement {
     }
     var HTMLSqmLeadDropdownFieldElement: {
@@ -6941,6 +7005,7 @@ declare global {
         "sqm-invoice-table-date-column": HTMLSqmInvoiceTableDateColumnElement;
         "sqm-invoice-table-download-cell": HTMLSqmInvoiceTableDownloadCellElement;
         "sqm-invoice-table-download-column": HTMLSqmInvoiceTableDownloadColumnElement;
+        "sqm-lead-checkbox-field": HTMLSqmLeadCheckboxFieldElement;
         "sqm-lead-dropdown-field": HTMLSqmLeadDropdownFieldElement;
         "sqm-lead-form": HTMLSqmLeadFormElement;
         "sqm-lead-input-field": HTMLSqmLeadInputFieldElement;
@@ -8450,6 +8515,41 @@ declare namespace LocalJSX {
     }
     interface SqmInvoiceTableDownloadColumn {
     }
+    interface SqmLeadCheckboxField {
+        /**
+          * @uiName Checkbox label
+          * @uiWidget textArea
+         */
+        "checkboxLabel"?: string;
+        /**
+          * Used with link text if the checkbox label contains {labelLink}
+          * @uiName Checkbox label link
+         */
+        "checkboxLabelLink"?: string;
+        /**
+          * @uiName Checkbox label link lext
+         */
+        "checkboxLabelLinkText"?: string;
+        /**
+          * This name is used as the key for this form field on submission. The name must be unique within this specific form.
+          * @uiName Checkbox name attribute
+          * @required
+         */
+        "checkboxName"?: string;
+        /**
+          * @uiName Optional
+         */
+        "checkboxOptional"?: boolean;
+        /**
+          * @undocumented 
+          * @uiType object
+         */
+        "demoData"?: DemoData<LeadCheckboxFieldViewProps>;
+        /**
+          * @uiName Unchecked error message
+         */
+        "errorMessage"?: string;
+    }
     interface SqmLeadDropdownField {
         /**
           * @undocumented 
@@ -8471,6 +8571,15 @@ declare namespace LocalJSX {
           * @default
          */
         "dropdownOptional"?: boolean;
+        /**
+          * @uiName Multiple selection
+          * @default
+         */
+        "multiple"?: boolean;
+        /**
+          * @uiName Optional label
+         */
+        "optionalLabel"?: string;
         /**
           * The message to be displayed when a required field is not filled.
           * @uiName Required field message
@@ -8492,9 +8601,13 @@ declare namespace LocalJSX {
           * @uiName First Name field label
          */
         "firstNameLabel"?: string;
+        /**
+          * Key of the form to connect to. Create and manage forms in the /advocate dashboard under Data > Forms.
+          * @uiName Form key
+         */
         "formKey"?: string;
         /**
-          * The message to be displayed when the email used is invalid or blocked.
+          * The message to be displayed if the email used is invalid.
           * @uiName Invalid email message
           * @uiWidget textArea
          */
@@ -8504,7 +8617,7 @@ declare namespace LocalJSX {
          */
         "lastNameLabel"?: string;
         /**
-          * The message to be displayed when a the form submission fails unexpectedly.
+          * The message to be displayed if a the form submission fails unexpectedly.
           * @uiName Network error message
           * @uiWidget textArea
          */
@@ -8514,7 +8627,7 @@ declare namespace LocalJSX {
          */
         "pageLabel"?: string;
         /**
-          * The message to be displayed when a required field is not filled.
+          * The message to be displayed if a required field is not filled.
           * @uiName Required field message
           * @uiWidget textArea
          */
@@ -8524,11 +8637,13 @@ declare namespace LocalJSX {
          */
         "resubmitFormLabel"?: string;
         /**
-          * Description text shown when an error occurs.
+          * Description text shown if an error occurs.
+          * @uiName Submit error description
          */
         "submitErrorDescription"?: string;
         /**
-          * Header text shown when an error occurs.
+          * Header text shown if an error occurs.
+          * @uiName Submit error header
          */
         "submitErrorHeader"?: string;
         /**
@@ -8536,17 +8651,20 @@ declare namespace LocalJSX {
          */
         "submitLabel"?: string;
         /**
-          * Description text shown on successful submission.
+          * Description text shown on successful lead submission.
+          * @uiName Submit success description
          */
         "submitSuccessDescription"?: string;
         /**
-          * Header text shown on successful submission.
+          * Header text shown on successful lead submission.
+          * @uiName Submit success header
          */
         "submitSuccessHeader"?: string;
         /**
-          * Optional support link for error messages.
+          * Optional support link text for error messages.
+          * @uiName Support link text
          */
-        "supportLink"?: string;
+        "supportLinkText"?: string;
     }
     interface SqmLeadInputField {
         /**
@@ -8576,6 +8694,10 @@ declare namespace LocalJSX {
           * @uiEnumNames ["Text", "Date", "Phone Number"]
          */
         "fieldType"?: "text" | "date" | "tel";
+        /**
+          * @uiName Optional label
+         */
+        "optionalLabel"?: string;
         /**
           * The message to be displayed when a required field is not filled.
           * @uiName Required field message
@@ -13128,6 +13250,7 @@ declare namespace LocalJSX {
         "sqm-invoice-table-date-column": SqmInvoiceTableDateColumn;
         "sqm-invoice-table-download-cell": SqmInvoiceTableDownloadCell;
         "sqm-invoice-table-download-column": SqmInvoiceTableDownloadColumn;
+        "sqm-lead-checkbox-field": SqmLeadCheckboxField;
         "sqm-lead-dropdown-field": SqmLeadDropdownField;
         "sqm-lead-form": SqmLeadForm;
         "sqm-lead-input-field": SqmLeadInputField;
@@ -13260,6 +13383,7 @@ declare module "@stencil/core" {
             "sqm-invoice-table-date-column": LocalJSX.SqmInvoiceTableDateColumn & JSXBase.HTMLAttributes<HTMLSqmInvoiceTableDateColumnElement>;
             "sqm-invoice-table-download-cell": LocalJSX.SqmInvoiceTableDownloadCell & JSXBase.HTMLAttributes<HTMLSqmInvoiceTableDownloadCellElement>;
             "sqm-invoice-table-download-column": LocalJSX.SqmInvoiceTableDownloadColumn & JSXBase.HTMLAttributes<HTMLSqmInvoiceTableDownloadColumnElement>;
+            "sqm-lead-checkbox-field": LocalJSX.SqmLeadCheckboxField & JSXBase.HTMLAttributes<HTMLSqmLeadCheckboxFieldElement>;
             "sqm-lead-dropdown-field": LocalJSX.SqmLeadDropdownField & JSXBase.HTMLAttributes<HTMLSqmLeadDropdownFieldElement>;
             "sqm-lead-form": LocalJSX.SqmLeadForm & JSXBase.HTMLAttributes<HTMLSqmLeadFormElement>;
             "sqm-lead-input-field": LocalJSX.SqmLeadInputField & JSXBase.HTMLAttributes<HTMLSqmLeadInputFieldElement>;