remove keyboard helper screen from web chat by amirmursal · Pull Request #5234 · microsoft/BotFramework-WebChat

amirmursal · 2024-07-02T06:35:31Z

Fix candidate for #5220, #5212, #4965, #4918

Changelog Entry

Fixes #4965. Removed keyboard helper screen in #5234, by @amirmursal

Description

Removed keyboard control screen from the chat window to address several accessibility issues

I have added tests and executed them locally
I have updated CHANGELOG.md
I have updated documentation

Review Checklist

This section is for contributors to review your work.

Accessibility reviewed (tab order, content readability, alt text, color contrast)
~~Browser and platform compatibilities reviewed~~
~~CSS styles reviewed (minimal rules, no z-index)~~
Documents reviewed (docs, samples, live demo)
~~Internationalization reviewed (strings, unit formatting)~~
~~package.json and package-lock.json reviewed~~
~~Security reviewed (no data URIs, check for nonce leak)~~
Tests reviewed (coverage, legitimacy)

OEvgeny

Please update tests according to my comment

OEvgeny · 2024-07-29T16:37:54Z

We probably want to cleanup localizations as well:

BotFramework-WebChat/packages/api/src/localization/en-US.json

Lines 74 to 90 in e069c62

    
           "KEYBOARD_HELP_CHAT_HISTORY_ACCESS_ITEMS_IN_MESSAGE_BODY": "Enter key", 
        
           "KEYBOARD_HELP_CHAT_HISTORY_ACCESS_ITEMS_IN_MESSAGE_HEADER": "Access items in message", 
        
           "KEYBOARD_HELP_CHAT_HISTORY_HEADER": "Chat history", 
        
           "KEYBOARD_HELP_CHAT_HISTORY_LEAVE_MESSAGE_BODY": "Escape key", 
        
           "KEYBOARD_HELP_CHAT_HISTORY_LEAVE_MESSAGE_HEADER": "Exit message", 
        
           "_KEYBOARD_HELP_CHAT_HISTORY_LEAVE_MESSAGE_HEADER.comment": "While focus is on the message, when the user press ESCAPE key, it should exit the message focus mode and focus back on the text box in the send box.", 
        
           "KEYBOARD_HELP_CHAT_HISTORY_MOVE_BETWEEN_ITEMS_BODY": "Tab key\nShift + tab key", 
        
           "KEYBOARD_HELP_CHAT_HISTORY_MOVE_BETWEEN_ITEMS_HEADER": "Move between items in a message", 
        
           "KEYBOARD_HELP_CHAT_HISTORY_MOVE_BETWEEN_MESSAGES_BODY": "Arrow up key\nArrow down key", 
        
           "KEYBOARD_HELP_CHAT_HISTORY_MOVE_BETWEEN_MESSAGES_HEADER": "Move between messages", 
        
           "KEYBOARD_HELP_CHAT_WINDOW_BODY_DO_ACTION_BODY": "Enter key", 
        
           "KEYBOARD_HELP_CHAT_WINDOW_BODY_DO_ACTION_HEADER": "Do action", 
        
           "KEYBOARD_HELP_CHAT_WINDOW_BODY_MOVE_BETWEEN_ITEMS_BODY": "Tab key\nShift + tab key", 
        
           "KEYBOARD_HELP_CHAT_WINDOW_BODY_MOVE_BETWEEN_ITEMS_HEADER": "Move between items in the chat window", 
        
           "KEYBOARD_HELP_CHAT_WINDOW_HEADER": "Chat window", 
        
           "KEYBOARD_HELP_CLOSE_BUTTON_ALT": "Close", 
        
           "KEYBOARD_HELP_HEADER": "Keyboard controls",

Co-authored-by: Eugene <EOlonov@gmail.com>

OEvgeny · 2024-08-15T16:12:22Z

We probably want to cleanup localizations as well:

BotFramework-WebChat/packages/api/src/localization/en-US.json

Lines 74 to 90 in e069c62

"KEYBOARD_HELP_CHAT_HISTORY_ACCESS_ITEMS_IN_MESSAGE_BODY": "Enter key",

"KEYBOARD_HELP_CHAT_HISTORY_ACCESS_ITEMS_IN_MESSAGE_HEADER": "Access items in message",

"KEYBOARD_HELP_CHAT_HISTORY_HEADER": "Chat history",

"KEYBOARD_HELP_CHAT_HISTORY_LEAVE_MESSAGE_BODY": "Escape key",

"KEYBOARD_HELP_CHAT_HISTORY_LEAVE_MESSAGE_HEADER": "Exit message",

"_KEYBOARD_HELP_CHAT_HISTORY_LEAVE_MESSAGE_HEADER.comment": "While focus is on the message, when the user press ESCAPE key, it should exit the message focus mode and focus back on the text box in the send box.",

"KEYBOARD_HELP_CHAT_HISTORY_MOVE_BETWEEN_ITEMS_BODY": "Tab key\nShift + tab key",

"KEYBOARD_HELP_CHAT_HISTORY_MOVE_BETWEEN_ITEMS_HEADER": "Move between items in a message",

"KEYBOARD_HELP_CHAT_HISTORY_MOVE_BETWEEN_MESSAGES_BODY": "Arrow up key\nArrow down key",

"KEYBOARD_HELP_CHAT_HISTORY_MOVE_BETWEEN_MESSAGES_HEADER": "Move between messages",

"KEYBOARD_HELP_CHAT_WINDOW_BODY_DO_ACTION_BODY": "Enter key",

"KEYBOARD_HELP_CHAT_WINDOW_BODY_DO_ACTION_HEADER": "Do action",

"KEYBOARD_HELP_CHAT_WINDOW_BODY_MOVE_BETWEEN_ITEMS_BODY": "Tab key\nShift + tab key",

"KEYBOARD_HELP_CHAT_WINDOW_BODY_MOVE_BETWEEN_ITEMS_HEADER": "Move between items in the chat window",

"KEYBOARD_HELP_CHAT_WINDOW_HEADER": "Chat window",

"KEYBOARD_HELP_CLOSE_BUTTON_ALT": "Close",

"KEYBOARD_HELP_HEADER": "Keyboard controls",

Done

OEvgeny · 2024-08-22T22:25:43Z

Closes #4995
Closes #4996
Closes #4997
as well

* remove keyboard helper screen from web chat * update test case for transcript avigation isualKeyboardIndicator * update change log file for pull request changes * update test case for visual keyboard indicator * remove keyboard navigation steps in test case * Update CHANGELOG.md Co-authored-by: Eugene <EOlonov@gmail.com> * Update translations * Remove snapshots and test tooling * Update docs --------- Co-authored-by: Amir Mursal <amirmursal@microsoft.com> Co-authored-by: Eugene <EOlonov@gmail.com>

* remove keyboard helper screen from web chat (#5234) * remove keyboard helper screen from web chat * update test case for transcript avigation isualKeyboardIndicator * update change log file for pull request changes * update test case for visual keyboard indicator * remove keyboard navigation steps in test case * Update CHANGELOG.md Co-authored-by: Eugene <EOlonov@gmail.com> * Update translations * Remove snapshots and test tooling * Update docs --------- Co-authored-by: Amir Mursal <amirmursal@microsoft.com> Co-authored-by: Eugene <EOlonov@gmail.com> * Update entry * Use download-artifact/upload-artifact@v4 * Use docker compose * Move to MockBot4 * Merge test result * Fix tests * Update conversationStart tests * Update conversationStart tests * Update conversationStart screenshots * Skipping some tests related to MockBot4 * Use browser variant of simple-update-in * Remove unneeded tests * Fix speechRecognition.simple test * Update ignore pattern * Fix token endpoint --------- Co-authored-by: Amir Mursal <amir.mursal@nuance.com> Co-authored-by: Amir Mursal <amirmursal@microsoft.com> Co-authored-by: Eugene <EOlonov@gmail.com>

amirmursal requested review from a-b-r-o-w-n, beyackle2, compulim, cwhitten, srinaath and tdurnford as code owners July 2, 2024 06:35

beyackle2 previously approved these changes Jul 8, 2024

View reviewed changes

OEvgeny reviewed Jul 8, 2024

View reviewed changes

Comment thread __tests__/html/transcript.navigation.visualKeyboardIndicator.html

OEvgeny requested changes Jul 8, 2024

View reviewed changes

amirmursal dismissed beyackle2’s stale review via e3d16f6 July 9, 2024 13:22

OEvgeny reviewed Jul 9, 2024

View reviewed changes

Comment thread __tests__/html/transcript.navigation.visualKeyboardIndicator.html Outdated

OEvgeny self-requested a review July 9, 2024 17:03

OEvgeny previously approved these changes Jul 9, 2024

View reviewed changes

OEvgeny reviewed Jul 9, 2024

View reviewed changes

Comment thread CHANGELOG.md Outdated

amirmursal dismissed OEvgeny’s stale review via 1fca14b July 10, 2024 13:24

Amir Mursal and others added 7 commits August 15, 2024 09:11

remove keyboard helper screen from web chat

4e0bb4f

update test case for transcript avigation isualKeyboardIndicator

e3addf6

update change log file for pull request changes

8596629

update test case for visual keyboard indicator

35feb80

remove keyboard navigation steps in test case

f81bb97

Update CHANGELOG.md

50cc35d

Co-authored-by: Eugene <EOlonov@gmail.com>

Update translations

3ee5239

OEvgeny force-pushed the keyboardScreen branch from b8cdfc7 to 3ee5239 Compare August 15, 2024 16:11

OEvgeny added 2 commits August 15, 2024 09:18

Remove snapshots and test tooling

6565d05

Update docs

619b65b

OEvgeny requested a review from beyackle2 August 15, 2024 16:26

OEvgeny enabled auto-merge (squash) August 15, 2024 16:27

Remove obsoleted screenshots

3197e30

Move entry to unreleased

b8da2be

compulim approved these changes Aug 15, 2024

View reviewed changes

OEvgeny merged commit 0f4674e into main Aug 15, 2024

OEvgeny deleted the keyboardScreen branch August 15, 2024 21:53

OEvgeny mentioned this pull request Aug 26, 2024

The button to open the ‘Keyboard Controls’ modal dialog is visually missing. #5211

Closed

compulim mentioned this pull request Jul 23, 2025

[QFE] Cherry-pick remove keyboard help screen to 4.17.1 #5522

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

remove keyboard helper screen from web chat#5234

remove keyboard helper screen from web chat#5234
OEvgeny merged 11 commits intomainfrom
keyboardScreen

amirmursal commented Jul 2, 2024 •

edited by compulim

Loading

Uh oh!

Uh oh!

OEvgeny left a comment

Uh oh!

Uh oh!

Uh oh!

OEvgeny commented Jul 29, 2024

Uh oh!

OEvgeny commented Aug 15, 2024 •

edited

Loading

Uh oh!

OEvgeny commented Aug 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

amirmursal commented Jul 2, 2024 • edited by compulim Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog Entry

Description

Review Checklist

Uh oh!

Uh oh!

OEvgeny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

OEvgeny commented Jul 29, 2024

Uh oh!

OEvgeny commented Aug 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OEvgeny commented Aug 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

amirmursal commented Jul 2, 2024 •

edited by compulim

Loading

OEvgeny commented Aug 15, 2024 •

edited

Loading