@saasquatch/mint-components 2.1.8-24 → 2.1.8-25

package/dist/types/components/sqm-share-link/sqm-share-link.d.ts

@@ -91,29 +91,29 @@ export declare class ShareLink {
    */
   buttonStyle?: "icon" | "button-outside" | "button-below";
   /**
-   * Enable users to customize their referral link
+   * Let advocates customize their share links up to 5 times.
    *
-   * @uiName Customize URL
+   * @uiName Allow customization
    * @uiType boolean
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
   allowCustomization?: boolean;
   /**
-   * Text shown below the share link input to trigger customization
+   * Displayed below the share link.
    *
-   * @uiName Customize link label
+   * @uiName Customize link button label
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
-  customizeLinkLabel?: string;
+  customizeLinkButtonLabel?: string;
   /**
    * Text for the save button in editing mode
    *
    * @uiName Save button label
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
   saveLabelText?: string;
@@ -122,79 +122,83 @@ export declare class ShareLink {
    *
    * @uiName Cancel button label
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
   cancelLabelText?: string;
   /**
-   * Title text shown when the custom link is already taken
+   * Title of the error message shown when the link has already been taken
    *
-   * @uiName Existing code conflict error title
+   * @uiName Link taken error title
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
-  existingCodeConflictErrorTitle?: string;
+  linkTakenErrorTitle?: string;
   /**
-   * Description text shown when the custom link is already taken
+   * Description text shown when the link has already been taken
    *
-   * @uiName Existing code conflict error description
+   * @uiName Link taken error message
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiWidget textarea
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
-  existingCodeConflictErrorDescription?: string;
+  linkTakenErrorDescription?: string;
   /**
-   * Title text shown when the link contains invalid characters
+   * Title of the error message shown when the link contains invalid special characters.
    *
    * @uiName Invalid characters error title
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
   invalidCharactersErrorTitle?: string;
   /**
-   * Description text shown when the link contains invalid characters
+   * Description text shown when the link contains invalid special characters.
    *
    * @uiName Invalid characters error description
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiWidget textarea
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
   invalidCharactersErrorDescription?: string;
   /**
-   * Title text shown when the link contains profanity
+   * Title of the error message shown when the link contains profanity or brand names.
    *
-   * @uiName Profanity error title
+   * @uiName Restricted words error title
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
-  profanityErrorTitle?: string;
+  restrictedWordsErrorTitle?: string;
   /**
-   * Description text shown when the link contains profanity
+   * Description text shown when the link contains profanity or brand names.
    *
-   * @uiName Profanity error description
+   * @uiName Restricted words error description
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiWidget textarea
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
-  profanityErrorDescription?: string;
+  restrictedWordsErrorDescription?: string;
   /**
-   * Text describing the edit limit
+   * Subtext shown while the user is customizing their URL.
    *
    * @uiName Edit limit text
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
   editLimitText?: string;
   /**
-   * Message shown when the edit limit has been reached. Use {supportLink} as a placeholder for the support link.
+   * Message shown when the URL has been edited 5 times. To display a clickable link, use {supportLink} as a placeholder.
    *
    * @uiName Edit limit reached text
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiWidget textarea
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
   editLimitReachedText?: string;
@@ -203,7 +207,7 @@ export declare class ShareLink {
    *
    * @uiName Support link text
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
   supportLinkText?: string;
@@ -212,7 +216,7 @@ export declare class ShareLink {
    *
    * @uiName Customize disabled tooltip
    * @uiType string
-   * @uiGroup Customize Vanity Link
+   * @uiGroup Customizable Vanity Link
    * @requiredFlavor impact
    */
   customizeDisabledTooltip?: string;

package/dist/types/components/sqm-share-link/useShareLink.d.ts

@@ -6,7 +6,7 @@ export interface ShareLinkProps {
   linkOverride?: string;
   allowCustomization?: boolean;
   customizeUrlText?: string;
-  customizeLinkLabel?: string;
+  customizeLinkButtonLabel?: string;
   saveLabelText?: string;
   cancelLabelText?: string;
   textAlign?: "left" | "center" | "right";
@@ -17,12 +17,12 @@ export interface ShareLinkProps {
   buttonType?: "primary" | "secondary";
   copyButtonLabel?: string;
   borderColor?: string;
-  existingCodeConflictErrorTitle?: string;
-  existingCodeConflictErrorDescription?: string;
+  linkTakenErrorTitle?: string;
+  linkTakenErrorDescription?: string;
   invalidCharactersErrorTitle?: string;
   invalidCharactersErrorDescription?: string;
-  profanityErrorTitle?: string;
-  profanityErrorDescription?: string;
+  restrictedWordsErrorTitle?: string;
+  restrictedWordsErrorDescription?: string;
   editLimitText?: string;
   editLimitReachedText?: string;
   supportLinkText?: string;

package/dist/types/components.d.ts

@@ -4890,10 +4890,10 @@ export namespace Components {
     }
     interface SqmShareLink {
         /**
-          * Enable users to customize their referral link
-          * @uiName Customize URL
+          * Let advocates customize their share links up to 5 times.
+          * @uiName Allow customization
           * @uiType boolean
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "allowCustomization"?: boolean;
@@ -4942,7 +4942,7 @@ export namespace Components {
           * Text for the cancel button in editing mode
           * @uiName Cancel button label
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "cancelLabelText"?: string;
@@ -4954,99 +4954,103 @@ export namespace Components {
           * Tooltip text shown when link customization is disabled
           * @uiName Customize disabled tooltip
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "customizeDisabledTooltip"?: string;
         /**
-          * Text shown below the share link input to trigger customization
-          * @uiName Customize link label
+          * Displayed below the share link.
+          * @uiName Customize link button label
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
-        "customizeLinkLabel"?: string;
+        "customizeLinkButtonLabel"?: string;
         /**
           * @undocumented 
           * @uiType object
          */
         "demoData"?: DemoData<ShareLinkViewProps>;
         /**
-          * Message shown when the edit limit has been reached. Use {supportLink} as a placeholder for the support link.
+          * Message shown when the URL has been edited 5 times. To display a clickable link, use {supportLink} as a placeholder.
           * @uiName Edit limit reached text
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "editLimitReachedText"?: string;
         /**
-          * Text describing the edit limit
+          * Subtext shown while the user is customizing their URL.
           * @uiName Edit limit text
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "editLimitText"?: string;
         "editsRemaining"?: number;
         /**
-          * Description text shown when the custom link is already taken
-          * @uiName Existing code conflict error description
-          * @uiType string
-          * @uiGroup Customize Vanity Link
-          * @requiredFlavor impact
-         */
-        "existingCodeConflictErrorDescription"?: string;
-        /**
-          * Title text shown when the custom link is already taken
-          * @uiName Existing code conflict error title
-          * @uiType string
-          * @uiGroup Customize Vanity Link
-          * @requiredFlavor impact
-         */
-        "existingCodeConflictErrorTitle"?: string;
-        /**
-          * Description text shown when the link contains invalid characters
+          * Description text shown when the link contains invalid special characters.
           * @uiName Invalid characters error description
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "invalidCharactersErrorDescription"?: string;
         /**
-          * Title text shown when the link contains invalid characters
+          * Title of the error message shown when the link contains invalid special characters.
           * @uiName Invalid characters error title
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "invalidCharactersErrorTitle"?: string;
         /**
-          * Description text shown when the link contains profanity
-          * @uiName Profanity error description
+          * Description text shown when the link has already been taken
+          * @uiName Link taken error message
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
-        "profanityErrorDescription"?: string;
+        "linkTakenErrorDescription"?: string;
         /**
-          * Title text shown when the link contains profanity
-          * @uiName Profanity error title
+          * Title of the error message shown when the link has already been taken
+          * @uiName Link taken error title
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
-        "profanityErrorTitle"?: string;
+        "linkTakenErrorTitle"?: string;
         /**
           * The ID of the program that should generate the link. Defaults to the program ID in context where this widget is loaded.
           * @uiName Program ID
           * @uiWidget programSelector
          */
         "programId"?: string;
+        /**
+          * Description text shown when the link contains profanity or brand names.
+          * @uiName Restricted words error description
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "restrictedWordsErrorDescription"?: string;
+        /**
+          * Title of the error message shown when the link contains profanity or brand names.
+          * @uiName Restricted words error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "restrictedWordsErrorTitle"?: string;
         /**
           * Text for the save button in editing mode
           * @uiName Save button label
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "saveLabelText"?: string;
@@ -5054,7 +5058,7 @@ export namespace Components {
           * Display text for the support link in the edit limit reached message
           * @uiName Support link text
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "supportLinkText"?: string;
@@ -12896,10 +12900,10 @@ declare namespace LocalJSX {
     }
     interface SqmShareLink {
         /**
-          * Enable users to customize their referral link
-          * @uiName Customize URL
+          * Let advocates customize their share links up to 5 times.
+          * @uiName Allow customization
           * @uiType boolean
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "allowCustomization"?: boolean;
@@ -12948,7 +12952,7 @@ declare namespace LocalJSX {
           * Text for the cancel button in editing mode
           * @uiName Cancel button label
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "cancelLabelText"?: string;
@@ -12960,99 +12964,103 @@ declare namespace LocalJSX {
           * Tooltip text shown when link customization is disabled
           * @uiName Customize disabled tooltip
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "customizeDisabledTooltip"?: string;
         /**
-          * Text shown below the share link input to trigger customization
-          * @uiName Customize link label
+          * Displayed below the share link.
+          * @uiName Customize link button label
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
-        "customizeLinkLabel"?: string;
+        "customizeLinkButtonLabel"?: string;
         /**
           * @undocumented 
           * @uiType object
          */
         "demoData"?: DemoData<ShareLinkViewProps>;
         /**
-          * Message shown when the edit limit has been reached. Use {supportLink} as a placeholder for the support link.
+          * Message shown when the URL has been edited 5 times. To display a clickable link, use {supportLink} as a placeholder.
           * @uiName Edit limit reached text
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "editLimitReachedText"?: string;
         /**
-          * Text describing the edit limit
+          * Subtext shown while the user is customizing their URL.
           * @uiName Edit limit text
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "editLimitText"?: string;
         "editsRemaining"?: number;
         /**
-          * Description text shown when the custom link is already taken
-          * @uiName Existing code conflict error description
-          * @uiType string
-          * @uiGroup Customize Vanity Link
-          * @requiredFlavor impact
-         */
-        "existingCodeConflictErrorDescription"?: string;
-        /**
-          * Title text shown when the custom link is already taken
-          * @uiName Existing code conflict error title
-          * @uiType string
-          * @uiGroup Customize Vanity Link
-          * @requiredFlavor impact
-         */
-        "existingCodeConflictErrorTitle"?: string;
-        /**
-          * Description text shown when the link contains invalid characters
+          * Description text shown when the link contains invalid special characters.
           * @uiName Invalid characters error description
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "invalidCharactersErrorDescription"?: string;
         /**
-          * Title text shown when the link contains invalid characters
+          * Title of the error message shown when the link contains invalid special characters.
           * @uiName Invalid characters error title
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "invalidCharactersErrorTitle"?: string;
         /**
-          * Description text shown when the link contains profanity
-          * @uiName Profanity error description
+          * Description text shown when the link has already been taken
+          * @uiName Link taken error message
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
-        "profanityErrorDescription"?: string;
+        "linkTakenErrorDescription"?: string;
         /**
-          * Title text shown when the link contains profanity
-          * @uiName Profanity error title
+          * Title of the error message shown when the link has already been taken
+          * @uiName Link taken error title
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
-        "profanityErrorTitle"?: string;
+        "linkTakenErrorTitle"?: string;
         /**
           * The ID of the program that should generate the link. Defaults to the program ID in context where this widget is loaded.
           * @uiName Program ID
           * @uiWidget programSelector
          */
         "programId"?: string;
+        /**
+          * Description text shown when the link contains profanity or brand names.
+          * @uiName Restricted words error description
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "restrictedWordsErrorDescription"?: string;
+        /**
+          * Title of the error message shown when the link contains profanity or brand names.
+          * @uiName Restricted words error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "restrictedWordsErrorTitle"?: string;
         /**
           * Text for the save button in editing mode
           * @uiName Save button label
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "saveLabelText"?: string;
@@ -13060,7 +13068,7 @@ declare namespace LocalJSX {
           * Display text for the support link in the edit limit reached message
           * @uiName Support link text
           * @uiType string
-          * @uiGroup Customize Vanity Link
+          * @uiGroup Customizable Vanity Link
           * @requiredFlavor impact
          */
         "supportLinkText"?: string;