@saasquatch/mint-components 2.1.10-56 → 2.1.10

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

@@ -0,0 +1,41 @@
+import { CopyTextViewProps } from "../views/copy-text-view";
+export declare type ValidationErrorCode = "EXISTING_CODE_CONFLICT" | "INVALID_CHARACTER" | "BLOCKED_WORD" | null;
+export interface ValidationErrorInfo {
+  code: ValidationErrorCode;
+  title: string;
+  description: string;
+}
+export interface ShareLinkViewProps {
+  copyTextViewProps: CopyTextViewProps;
+  allowCustomization: boolean;
+  customizeLinkLabel: string;
+  saveLabelText: string;
+  savingLabelText: string;
+  cancelLabelText: string;
+  editLabelText: string;
+  charactersRemainingText: string;
+  validatingLabelText: string;
+  isEditing: boolean;
+  editValue: string;
+  domainPrefix: string;
+  editsRemaining: number;
+  maxEdits: number;
+  limitReached: boolean;
+  validationError: ValidationErrorInfo | null;
+  isValidating: boolean;
+  isSaving: boolean;
+  characterLimit: number;
+  minCharacters: number;
+  charactersRemaining: number;
+  editLimitText: string;
+  editLimitReachedText: string;
+  minCharactersText: string;
+  supportLinkText: string;
+  customizeDisabled: boolean;
+  customizeDisabledTooltip: string;
+  onCustomizeClick: () => void;
+  onEditValueChange: (value: string) => void;
+  onSave: () => void;
+  onCancel: () => void;
+}
+export declare function ShareLinkView(props: ShareLinkViewProps): any;

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

@@ -1,5 +1,5 @@
 import { DemoData } from "../../global/demo";
-import { CopyTextViewProps } from "../views/copy-text-view";
+import { ShareLinkViewProps } from "./sqm-share-link-view";
 /**
  * @uiName Share Link
  * @exampleGroup Sharing
@@ -90,11 +90,204 @@ export declare class ShareLink {
    * @uiGroup Style
    */
   buttonStyle?: "icon" | "button-outside" | "button-below";
+  /**
+   * Let advocates customize their share links up to 5 times.
+   *
+   * @uiName Allow customization
+   * @uiType boolean
+   * @uiGroup Customizable Vanity Link
+   * @uiWidget CustomLinkSwitch
+   * @requiredFlavor impact
+   */
+  allowCustomization?: boolean;
+  /**
+   * Text for the cancel button in editing mode
+   *
+   * @uiName Cancel button label
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  cancelLabelText?: string;
+  /**
+   * Tooltip text shown when link customization is disabled
+   *
+   * @uiName Customize disabled tooltip
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  customizeDisabledTooltip?: string;
+  /**
+   * Displayed below the share link.
+   *
+   * @uiName Customize link button label
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  customizeLinkButtonLabel?: string;
+  /**
+   * 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
+   * @uiWidget textarea
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  editLimitReachedText?: string;
+  /**
+   * Subtext shown while the user is customizing their URL.
+   *
+   * @uiName Edit limit text
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  editLimitText?: string;
+  /**
+   * Description text shown when the link contains invalid special characters.
+   *
+   * @uiName Invalid characters error description
+   * @uiType string
+   * @uiWidget textarea
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  invalidCharactersErrorDescription?: string;
+  /**
+   * Title of the error message shown when the link contains invalid special characters.
+   *
+   * @uiName Invalid characters error title
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  invalidCharactersErrorTitle?: string;
+  /**
+   * Description text shown when the link has already been taken
+   *
+   * @uiName Link taken error message
+   * @uiType string
+   * @uiWidget textarea
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  linkTakenErrorDescription?: string;
+  /**
+   * Title of the error message shown when the link has already been taken
+   *
+   * @uiName Link taken error title
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  linkTakenErrorTitle?: 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 Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  saveLabelText?: string;
+  /**
+   * Text for the save button while saving is in progress
+   *
+   * @uiName Saving button label
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  savingLabelText?: string;
+  /**
+   * Label shown above the link input while editing
+   *
+   * @uiName Edit input label
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  editLabelText?: string;
+  /**
+   * Text shown when nearing the character limit. Use {charactersRemaining} as a placeholder for the count.
+   *
+   * @uiName Characters remaining text
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  charactersRemainingText?: string;
+  /**
+   * Text shown while the link is being validated
+   *
+   * @uiName Validating label
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  validatingLabelText?: string;
+  /**
+   * @uiName Min characters text
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  minCharactersText?: string;
+  /**
+   * Display text for the support link in the edit limit reached message
+   *
+   * @uiName Support link text
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  supportLinkText?: string;
+  /**
+   * Title shown when saving fails with an unknown error
+   *
+   * @uiName Save error title
+   * @uiType string
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  saveErrorTitle?: string;
+  /**
+   * Description shown when saving fails with an unknown error
+   *
+   * @uiName Save error description
+   * @uiType string
+   * @uiWidget textarea
+   * @uiGroup Customizable Vanity Link
+   * @requiredFlavor impact
+   */
+  saveErrorDescription?: string;
   /**
    * @undocumented
    * @uiType object
    */
-  demoData?: DemoData<CopyTextViewProps>;
+  demoData?: DemoData<ShareLinkViewProps>;
   constructor();
   disconnectedCallback(): void;
   render(): any;

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

@@ -1,9 +1,38 @@
-import { CopyTextViewProps } from "../views/copy-text-view";
-interface ShareLinkProps {
+import { ShareLinkViewProps } from "./sqm-share-link-view";
+export interface ShareLinkProps {
   programId?: string;
   tooltiptext: string;
   tooltiplifespan: number;
   linkOverride?: string;
+  allowCustomization?: boolean;
+  customizeUrlText?: string;
+  customizeLinkButtonLabel?: string;
+  saveLabelText?: string;
+  savingLabelText?: string;
+  cancelLabelText?: string;
+  editLabelText?: string;
+  charactersRemainingText?: string;
+  validatingLabelText?: string;
+  textAlign?: "left" | "center" | "right";
+  buttonStyle?: "icon" | "button-outside" | "button-below";
+  backgroundColor?: string;
+  textColor?: string;
+  borderRadius?: string;
+  buttonType?: "primary" | "secondary";
+  copyButtonLabel?: string;
+  borderColor?: string;
+  linkTakenErrorTitle?: string;
+  linkTakenErrorDescription?: string;
+  invalidCharactersErrorTitle?: string;
+  invalidCharactersErrorDescription?: string;
+  restrictedWordsErrorTitle?: string;
+  restrictedWordsErrorDescription?: string;
+  editLimitText?: string;
+  editLimitReachedText?: string;
+  supportLinkText?: string;
+  customizeDisabledTooltip?: string;
+  minCharactersText?: string;
+  saveErrorTitle?: string;
+  saveErrorDescription?: string;
 }
-export declare function useShareLink(props: ShareLinkProps): CopyTextViewProps;
-export {};
+export declare function useShareLink(props: ShareLinkProps): ShareLinkViewProps;