@mantine-vue/whatsapp-inbox 3.2.0

package/lib/labels.d.ts

@@ -0,0 +1,184 @@
+/**
+ * Every user-visible string the extension renders on its own.
+ *
+ * Nothing is hard-coded inside a template: a consumer localizes the whole inbox by passing one
+ * `labels` object to `WhatsAppInboxProvider`, and any component can still override a single key
+ * without losing the rest.
+ */
+export interface WhatsAppInboxLabels {
+    conversationsLabel: string;
+    searchPlaceholder: string;
+    searchLabel: string;
+    unreadFilterLabel: string;
+    statusFilterLabel: string;
+    statusFilterPlaceholder: string;
+    assigneeFilterLabel: string;
+    assigneeFilterPlaceholder: string;
+    unassigned: string;
+    clearFilters: string;
+    newConversation: string;
+    newConversationTitle: string;
+    newConversationDescription: string;
+    newConversationPhoneLabel: string;
+    newConversationPhonePlaceholder: string;
+    newConversationNameLabel: string;
+    newConversationNamePlaceholder: string;
+    newConversationSubmit: string;
+    newConversationInvalidPhone: string;
+    newConversationExists: string;
+    loadMoreConversations: string;
+    loadingConversations: string;
+    conversationsError: string;
+    emptyInbox: string;
+    emptySearch: string;
+    unreadCountLabel: (count: number) => string;
+    conversationItemLabel: (name: string) => string;
+    noConversationSelected: string;
+    noConversationSelectedDescription: string;
+    emptyConversation: string;
+    emptyConversationDescription: string;
+    conversationError: string;
+    messagesError: string;
+    loadingMessages: string;
+    loadOlderMessages: string;
+    loadingOlderMessages: string;
+    backToConversations: string;
+    scrollToBottom: string;
+    newMessages: (count: number) => string;
+    messageHistoryLabel: string;
+    today: string;
+    yesterday: string;
+    statusPending: string;
+    statusSent: string;
+    statusDelivered: string;
+    statusRead: string;
+    statusFailed: string;
+    messageStatusLabel: (status: string) => string;
+    inboundMessageLabel: string;
+    outboundMessageLabel: string;
+    forwarded: string;
+    retrySend: string;
+    sendFailed: string;
+    composerPlaceholder: string;
+    composerLabel: string;
+    send: string;
+    sending: string;
+    attachFile: string;
+    emoji: string;
+    templates: string;
+    interactiveMessage: string;
+    cancelReply: string;
+    replyingTo: string;
+    messageTooLong: (max: number) => string;
+    characterCount: (count: number, max: number) => string;
+    emptyMessage: string;
+    emojiPickerLabel: string;
+    emojiPickerSearchPlaceholder: string;
+    emojiPickerNoResults: string;
+    emojiPickerSearchResults: string;
+    emojiGroupRecent: string;
+    emojiGroupSmileys: string;
+    emojiGroupPeople: string;
+    emojiGroupAnimals: string;
+    emojiGroupFood: string;
+    emojiGroupActivity: string;
+    emojiGroupTravel: string;
+    emojiGroupObjects: string;
+    emojiGroupSymbols: string;
+    emojiGroupFlags: string;
+    windowClosedTitle: string;
+    windowClosedDescription: string;
+    windowExpiresAt: (time: string) => string;
+    sendTemplateInstead: string;
+    composerDisabled: string;
+    templateSelectorTitle: string;
+    templateSearchPlaceholder: string;
+    templateCategoryLabel: string;
+    templateLanguageLabel: string;
+    templateStatusLabel: string;
+    templatesEmpty: string;
+    templatesError: string;
+    templatesLoading: string;
+    templateParameters: string;
+    templateHeaderVariables: string;
+    templateBodyVariables: string;
+    templateButtonVariables: string;
+    templatePreview: string;
+    templateRequiredField: string;
+    templateBack: string;
+    templateSubmit: string;
+    templateUnavailable: string;
+    templateHeaderMedia: string;
+    templateHeaderMediaRequired: string;
+    interactiveTitle: string;
+    interactiveType: string;
+    interactiveTypeButton: string;
+    interactiveTypeCtaUrl: string;
+    interactiveTypeList: string;
+    interactiveBody: string;
+    interactiveFooter: string;
+    interactiveHeader: string;
+    interactiveButtons: string;
+    interactiveAddButton: string;
+    interactiveRemoveButton: string;
+    interactiveButtonText: string;
+    interactiveCtaDisplayText: string;
+    interactiveCtaUrl: string;
+    interactiveListButton: string;
+    interactiveListSections: string;
+    interactiveAddSection: string;
+    interactiveRemoveSection: string;
+    interactiveAddRow: string;
+    interactiveRemoveRow: string;
+    interactiveSectionTitle: string;
+    interactiveRowTitle: string;
+    interactiveRowDescription: string;
+    interactiveSubmit: string;
+    interactiveBodyRequired: string;
+    interactiveButtonsRequired: string;
+    interactiveUrlRequired: string;
+    interactiveRowsRequired: string;
+    download: string;
+    openInNewTab: string;
+    removeAttachment: string;
+    retryUpload: string;
+    cancelUpload: string;
+    uploading: string;
+    uploadFailed: string;
+    attachmentsLabel: string;
+    playAudio: string;
+    fileTooLarge: (fileName: string, max: string) => string;
+    fileInvalidType: (fileName: string) => string;
+    tooManyFiles: (max: number) => string;
+    mediaUnavailable: string;
+    contactPanelTitle: string;
+    contactPanelToggle: string;
+    contactPhoneNumber: string;
+    contactEmail: string;
+    contactAbout: string;
+    contactTags: string;
+    contactStatus: string;
+    contactAssignee: string;
+    messageTypeImage: string;
+    messageTypeVideo: string;
+    messageTypeAudio: string;
+    messageTypeDocument: string;
+    messageTypeSticker: string;
+    messageTypeLocation: string;
+    messageTypeContacts: string;
+    messageTypeTemplate: string;
+    messageTypeInteractive: string;
+    messageTypeUnsupported: string;
+    retry: string;
+    close: string;
+    cancel: string;
+    loading: string;
+}
+/** English defaults. Every key can be replaced through `labels`. */
+export declare const DEFAULT_WHATSAPP_INBOX_LABELS: WhatsAppInboxLabels;
+/** Partial override of the built-in labels. */
+export type WhatsAppInboxLabelsOverride = Partial<WhatsAppInboxLabels>;
+/** Reads one label, applying an override on top of the defaults. */
+export declare function getWhatsAppLabel<Key extends keyof WhatsAppInboxLabels>(key: Key, override?: WhatsAppInboxLabelsOverride): WhatsAppInboxLabels[Key];
+/** Merges one or more overrides over the defaults, later sources winning. */
+export declare function mergeWhatsAppLabels(...overrides: (WhatsAppInboxLabelsOverride | undefined)[]): WhatsAppInboxLabels;