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

package/dist/collection/components/sqm-share-link/sqm-share-link.js

@@ -59,131 +59,135 @@ export class ShareLink {
      */
     this.buttonStyle = "icon";
     /**
-     * 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
      */
     this.allowCustomization = false;
     /**
-     * Text shown below the share link input to trigger customization
+     * Text for the cancel button in editing mode
      *
-     * @uiName Customize link label
+     * @uiName Cancel button label
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.customizeLinkLabel = "Customize Link";
+    this.cancelLabelText = "Cancel";
     /**
-     * Text for the save button in editing mode
+     * Tooltip text shown when link customization is disabled
      *
-     * @uiName Save button label
+     * @uiName Customize disabled tooltip
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.saveLabelText = "Save";
+    this.customizeDisabledTooltip = "Link customization is not available.";
     /**
-     * Text for the cancel button in editing mode
+     * Displayed below the share link.
      *
-     * @uiName Cancel button label
+     * @uiName Customize link button label
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.cancelLabelText = "Cancel";
+    this.customizeLinkButtonLabel = "Customize Link";
     /**
-     * Title text shown when the custom link is already taken
+     * Message shown when the URL has been edited 5 times. To display a clickable link, use {supportLink} as a placeholder.
      *
-     * @uiName Existing code conflict error title
+     * @uiName Edit limit reached text
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiWidget textarea
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.existingCodeConflictErrorTitle = "This link is already taken";
+    this.editLimitReachedText = "5 edit limit reached. To make more changes, please contact {supportLink}.";
     /**
-     * Description text shown when the custom link is already taken
+     * Subtext shown while the user is customizing their URL.
      *
-     * @uiName Existing code conflict error description
+     * @uiName Edit limit text
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.existingCodeConflictErrorDescription = "Try adding numbers, a dash or underscore to create a unique link.";
+    this.editLimitText = "You can edit your link up to {editsRemaining} more times.";
     /**
-     * Title text shown when the link contains invalid characters
+     * Description text shown when the link contains invalid special characters.
      *
-     * @uiName Invalid characters error title
+     * @uiName Invalid characters error description
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiWidget textarea
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.invalidCharactersErrorTitle = "Please use only letters, numbers, dashes and underscores";
+    this.invalidCharactersErrorDescription = "Special characters can break the link when sharing.";
     /**
-     * Description 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 description
+     * @uiName Invalid characters error title
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.invalidCharactersErrorDescription = "Special characters can break the link when sharing.";
+    this.invalidCharactersErrorTitle = "Please use only letters, numbers, dashes and underscores";
     /**
-     * Title text shown when the link contains profanity
+     * Description text shown when the link has already been taken
      *
-     * @uiName Profanity error title
+     * @uiName Link taken error message
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiWidget textarea
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.profanityErrorTitle = "Please try a different link";
+    this.linkTakenErrorDescription = "Try adding numbers, a dash or underscore to create a unique link.";
     /**
-     * Description text shown when the link contains profanity
+     * Title of the error message shown when the link has already been taken
      *
-     * @uiName Profanity error description
+     * @uiName Link taken error title
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.profanityErrorDescription = "This link contains a restricted word.";
+    this.linkTakenErrorTitle = "This link is already taken";
     /**
-     * Text describing the edit limit
+     * Description text shown when the link contains profanity or brand names.
      *
-     * @uiName Edit limit text
+     * @uiName Restricted words error description
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiWidget textarea
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.editLimitText = "You can edit your link up to {editsRemaining} more times.";
+    this.restrictedWordsErrorDescription = "This link contains a restricted word.";
     /**
-     * Message shown when the edit limit has been reached. Use {supportLink} as a placeholder for the support link.
+     * Title of the error message shown when the link contains profanity or brand names.
      *
-     * @uiName Edit limit reached text
+     * @uiName Restricted words error title
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.editLimitReachedText = "5 edit limit reached. To make more changes, please contact {supportLink}.";
+    this.restrictedWordsErrorTitle = "Please try a different link";
     /**
-     * Display text for the support link in the edit limit reached message
+     * Text for the save button in editing mode
      *
-     * @uiName Support link text
+     * @uiName Save button label
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.supportLinkText = "Support";
+    this.saveLabelText = "Save";
     /**
-     * Tooltip text shown when link customization is disabled
+     * Display text for the support link in the edit limit reached message
      *
-     * @uiName Customize disabled tooltip
+     * @uiName Support link text
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.customizeDisabledTooltip = "Link customization is not available.";
+    this.supportLinkText = "Support";
     withHooks(this);
   }
   disconnectedCallback() { }
@@ -507,25 +511,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Customize URL",
+            "text": "Allow customization",
             "name": "uiName"
           }, {
             "text": "boolean",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Enable users to customize their referral link"
+        "text": "Let advocates customize their share links up to 5 times."
       },
       "attribute": "allow-customization",
       "reflect": false,
       "defaultValue": "false"
     },
-    "customizeLinkLabel": {
+    "cancelLabelText": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -537,25 +541,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Customize link label",
+            "text": "Cancel button label",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Text shown below the share link input to trigger customization"
+        "text": "Text for the cancel button in editing mode"
       },
-      "attribute": "customize-link-label",
+      "attribute": "cancel-label-text",
       "reflect": false,
-      "defaultValue": "\"Customize Link\""
+      "defaultValue": "\"Cancel\""
     },
-    "saveLabelText": {
+    "customizeDisabledTooltip": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -567,25 +571,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Save button label",
+            "text": "Customize disabled tooltip",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Text for the save button in editing mode"
+        "text": "Tooltip text shown when link customization is disabled"
       },
-      "attribute": "save-label-text",
+      "attribute": "customize-disabled-tooltip",
       "reflect": false,
-      "defaultValue": "\"Save\""
+      "defaultValue": "\"Link customization is not available.\""
     },
-    "cancelLabelText": {
+    "customizeLinkButtonLabel": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -597,25 +601,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Cancel button label",
+            "text": "Customize link button label",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Text for the cancel button in editing mode"
+        "text": "Displayed below the share link."
       },
-      "attribute": "cancel-label-text",
+      "attribute": "customize-link-button-label",
       "reflect": false,
-      "defaultValue": "\"Cancel\""
+      "defaultValue": "\"Customize Link\""
     },
-    "existingCodeConflictErrorTitle": {
+    "editLimitReachedText": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -627,25 +631,28 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Existing code conflict error title",
+            "text": "Edit limit reached text",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "textarea",
+            "name": "uiWidget"
+          }, {
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Title text shown when the custom link is already taken"
+        "text": "Message shown when the URL has been edited 5 times. To display a clickable link, use {supportLink} as a placeholder."
       },
-      "attribute": "existing-code-conflict-error-title",
+      "attribute": "edit-limit-reached-text",
       "reflect": false,
-      "defaultValue": "\"This link is already taken\""
+      "defaultValue": "\"5 edit limit reached. To make more changes, please contact {supportLink}.\""
     },
-    "existingCodeConflictErrorDescription": {
+    "editLimitText": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -657,25 +664,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Existing code conflict error description",
+            "text": "Edit limit text",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Description text shown when the custom link is already taken"
+        "text": "Subtext shown while the user is customizing their URL."
       },
-      "attribute": "existing-code-conflict-error-description",
+      "attribute": "edit-limit-text",
       "reflect": false,
-      "defaultValue": "\"Try adding numbers, a dash or underscore to create a unique link.\""
+      "defaultValue": "\"You can edit your link up to {editsRemaining} more times.\""
     },
-    "invalidCharactersErrorTitle": {
+    "invalidCharactersErrorDescription": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -687,25 +694,28 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Invalid characters error title",
+            "text": "Invalid characters error description",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "textarea",
+            "name": "uiWidget"
+          }, {
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Title text shown when the link contains invalid characters"
+        "text": "Description text shown when the link contains invalid special characters."
       },
-      "attribute": "invalid-characters-error-title",
+      "attribute": "invalid-characters-error-description",
       "reflect": false,
-      "defaultValue": "\"Please use only letters, numbers, dashes and underscores\""
+      "defaultValue": "\"Special characters can break the link when sharing.\""
     },
-    "invalidCharactersErrorDescription": {
+    "invalidCharactersErrorTitle": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -717,25 +727,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Invalid characters error description",
+            "text": "Invalid characters error title",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Description text shown when the link contains invalid characters"
+        "text": "Title of the error message shown when the link contains invalid special characters."
       },
-      "attribute": "invalid-characters-error-description",
+      "attribute": "invalid-characters-error-title",
       "reflect": false,
-      "defaultValue": "\"Special characters can break the link when sharing.\""
+      "defaultValue": "\"Please use only letters, numbers, dashes and underscores\""
     },
-    "profanityErrorTitle": {
+    "linkTakenErrorDescription": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -747,25 +757,28 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Profanity error title",
+            "text": "Link taken error message",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "textarea",
+            "name": "uiWidget"
+          }, {
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Title text shown when the link contains profanity"
+        "text": "Description text shown when the link has already been taken"
       },
-      "attribute": "profanity-error-title",
+      "attribute": "link-taken-error-description",
       "reflect": false,
-      "defaultValue": "\"Please try a different link\""
+      "defaultValue": "\"Try adding numbers, a dash or underscore to create a unique link.\""
     },
-    "profanityErrorDescription": {
+    "linkTakenErrorTitle": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -777,25 +790,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Profanity error description",
+            "text": "Link taken error title",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Description text shown when the link contains profanity"
+        "text": "Title of the error message shown when the link has already been taken"
       },
-      "attribute": "profanity-error-description",
+      "attribute": "link-taken-error-title",
       "reflect": false,
-      "defaultValue": "\"This link contains a restricted word.\""
+      "defaultValue": "\"This link is already taken\""
     },
-    "editLimitText": {
+    "restrictedWordsErrorDescription": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -807,25 +820,28 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Edit limit text",
+            "text": "Restricted words error description",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "textarea",
+            "name": "uiWidget"
+          }, {
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Text describing the edit limit"
+        "text": "Description text shown when the link contains profanity or brand names."
       },
-      "attribute": "edit-limit-text",
+      "attribute": "restricted-words-error-description",
       "reflect": false,
-      "defaultValue": "\"You can edit your link up to {editsRemaining} more times.\""
+      "defaultValue": "\"This link contains a restricted word.\""
     },
-    "editLimitReachedText": {
+    "restrictedWordsErrorTitle": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -837,25 +853,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Edit limit reached text",
+            "text": "Restricted words error title",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Message shown when the edit limit has been reached. Use {supportLink} as a placeholder for the support link."
+        "text": "Title of the error message shown when the link contains profanity or brand names."
       },
-      "attribute": "edit-limit-reached-text",
+      "attribute": "restricted-words-error-title",
       "reflect": false,
-      "defaultValue": "\"5 edit limit reached. To make more changes, please contact {supportLink}.\""
+      "defaultValue": "\"Please try a different link\""
     },
-    "supportLinkText": {
+    "saveLabelText": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -867,25 +883,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Support link text",
+            "text": "Save button label",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Display text for the support link in the edit limit reached message"
+        "text": "Text for the save button in editing mode"
       },
-      "attribute": "support-link-text",
+      "attribute": "save-label-text",
       "reflect": false,
-      "defaultValue": "\"Support\""
+      "defaultValue": "\"Save\""
     },
-    "customizeDisabledTooltip": {
+    "supportLinkText": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -897,23 +913,23 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Customize disabled tooltip",
+            "text": "Support link text",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Tooltip text shown when link customization is disabled"
+        "text": "Display text for the support link in the edit limit reached message"
       },
-      "attribute": "customize-disabled-tooltip",
+      "attribute": "support-link-text",
       "reflect": false,
-      "defaultValue": "\"Link customization is not available.\""
+      "defaultValue": "\"Support\""
     },
     "demoData": {
       "type": "unknown",
@@ -991,7 +1007,7 @@ function useDemoShareLink(props) {
       },
     },
     allowCustomization: props.allowCustomization,
-    customizeLinkLabel: props.customizeLinkLabel,
+    customizeLinkLabel: props.customizeLinkButtonLabel,
     saveLabelText: props.saveLabelText,
     cancelLabelText: props.cancelLabelText,
     isEditing,