Skip to content

Commit 50a3479

Browse files
vj-venkatesanvj-venkatesan
committed
fix: update aria labels for consistency and improved accessibility in embedding documentation
1 parent 6714810 commit 50a3479

File tree

2 files changed

+27
-28
lines changed

2 files changed

+27
-28
lines changed

Diff for: ‎docs/embedding.md

+26-27
Original file line numberDiff line numberDiff line change
@@ -428,31 +428,31 @@ _These settings are NOT configurable via the Endpoint Editor in Cognigy.AI_
428428

429429
The following table defines the default aria labels used throughout the Webchat for accessibility. Use them for managing aria-labels based on the preferred language
430430

431-
| Name | Type | Default | Description |
432-
| ------------------------- | ------ | ---------------------------- | -------------------------------------------------------------- |
433-
| unreadMessages | string | "Unread messages" | Label indicating the unread messages status. |
434-
| scrollToBottom | string | "Scroll to bottom" | Label for the button that scrolls the chat view to the bottom. |
435-
| close | string | "Close" | Label for close buttons in modals or dialogs. |
436-
| togglePersistentMenu | string | "Toggle menu" | Label for the button toggling the persistent menu. |
437-
| addAttachment | string | "Add attachment" | Label for the button that allows uploading attachments. |
438-
| messageToSend | string | "Type your message" | Label for the message input field. |
439-
| speechToText | string | "Activate speech-to-text" | Label for the speech-to-text control button. |
440-
| sendMessage | string | "Send message" | Label for the send message button. |
441-
| removeFileAttachment | string | "Remove attachment" | Label for the button to remove a file attachment. |
442-
| closeWarning | string | "Close warning" | Label for closing warning dialogs. |
443-
| goBack | string | "Go back" | Label for buttons allowing the user to go back. |
444-
| deleteAllConversations | string | "Delete all conversations" | Label for the button to delete all conversations. |
445-
| chatOptions | string | "Chat options" | Label for accessing the chat options. |
446-
| minimizeChat | string | "Minimize chat" | Label for minimizing the chat window. |
447-
| closeChat | string | "Close chat" | Label for closing the chat window. |
448-
| openChat | string | "Open chat" | Label for opening the chat window. |
449-
| unreadMessageSingularText | string | "One unread message in chat" | Label for a single unread message indicator. |
450-
| unreadMessagePluralText | string | "unread messages in chat" | Label for multiple unread messages indicator. |
451-
| closeTeaserMessage | string | "Close teaser message" | Label for the teaser message close button. |
452-
| opensInNewTab | string | "Opens in new tab" | Label for links that open in a new tab. |
453-
| thumbsUp | string | "Thumbs up" | Label for the positive feedback button. |
454-
| thumbsDown | string | "Thumbs down" | Label for the negative feedback button. |
455-
| openConversation | string | "Open conversation" | Label for the button that opens a conversation thread. |
431+
| Name | Type | Default | Description |
432+
| ------------------------- | ------ | ---------------------------- | ----------------------------------------------------------------------------------- |
433+
| scrollToBottom | string | "Scroll to bottom" | Label for the button that scrolls the chat view to the bottom. |
434+
| close | string | "Close" | Label for close buttons in modals or dialogs. |
435+
| togglePersistentMenu | string | "Toggle menu" | Label for the button toggling the persistent menu. |
436+
| addAttachment | string | "Add attachment" | Label for the button that allows uploading attachments. |
437+
| messageToSend | string | "Type your message" | Label for the message input field. |
438+
| speechToText | string | "Activate speech-to-text" | Label for the speech-to-text control button. |
439+
| sendMessage | string | "Send message" | Label for the send message button. |
440+
| removeFileAttachment | string | "Remove attachment" | Label for the button to remove a file attachment. |
441+
| closeWarning | string | "Close warning" | Label for closing warning dialogs. |
442+
| goBack | string | "Go back" | Label for buttons allowing the user to go back. |
443+
| deleteAllConversations | string | "Delete all conversations" | Label for the button to delete all conversations. |
444+
| chatOptions | string | "Chat options" | Label for accessing the chat options. |
445+
| minimizeChat | string | "Minimize chat" | Label for minimizing the chat window. |
446+
| closeChat | string | "Close chat" | Label for closing the chat window. |
447+
| openChat | string | "Open chat" | Label for opening the chat window. |
448+
| unreadMessages | string | "Unread messages" | Label indicating the unread messages status in the badge inside chat toggle button. |
449+
| unreadMessageSingularText | string | "One unread message in chat" | Label for a single unread message indicator for the chat toggle button. |
450+
| unreadMessagePluralText | string | "unread messages in chat" | Label for multiple unread messages indicator for the chat toggle button. |
451+
| closeTeaserMessage | string | "Close teaser message" | Label for the teaser message close button. |
452+
| opensInNewTab | string | "Opens in new tab" | Label for links that open in a new tab. |
453+
| thumbsUp | string | "Thumbs up" | Label for the positive feedback button. |
454+
| thumbsDown | string | "Thumbs down" | Label for the negative feedback button. |
455+
| openConversation | string | "Open conversation" | Label for the button that opens a conversation thread. |
456456

457457
#### Settings Interface
458458

@@ -667,8 +667,6 @@ interface IWebchatSettings {
667667
delete_anyway?: string;
668668
cancel?: string;
669669
ariaLabels?: {
670-
branding?: string;
671-
unreadMessages?: string;
672670
scrollToBottom?: string;
673671
close?: string;
674672
togglePersistentMenu?: string;
@@ -684,6 +682,7 @@ interface IWebchatSettings {
684682
minimizeChat?: string;
685683
closeChat?: string;
686684
openChat?: string;
685+
unreadMessages?: string;
687686
unreadMessageSingularText?: string;
688687
unreadMessagePluralText?: string;
689688
closeTeaserMessage?: string;

Diff for: ‎src/common/interfaces/webchat-config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,6 @@ export interface IWebchatSettings {
315315
delete_anyway: string;
316316
cancel: string;
317317
ariaLabels?: {
318-
unreadMessages?: string;
319318
scrollToBottom?: string;
320319
close?: string;
321320
togglePersistentMenu?: string;
@@ -331,6 +330,7 @@ export interface IWebchatSettings {
331330
minimizeChat?: string;
332331
closeChat?: string;
333332
openChat?: string;
333+
unreadMessages?: string;
334334
unreadMessageSingularText?: string;
335335
unreadMessagePluralText?: string;
336336
closeTeaserMessage?: string;

0 commit comments

Comments
 (0)