Add ability to customize keyboard shortcuts #30840

rebron · 2023-06-06T03:17:56Z

Description

Provide a way for users to see via a list and to find via a search field, all the available keyboard shortcuts. Users should be able to easily add/remove, edit existing keyboard shortcuts and create new ones.

Keyboard shortcuts should be made available here: brave://settings/system/ and brave://settings/system/shortcuts

Expected result:

https://www.figma.com/file/tLXWGCpNoiJxDZDdpfordj/Desktop-Settings?node-id=3617-77370&t=HKTZrtO87yiUZkol-0

Brave version (brave://version info)

Targeting 1.56.x

Version/Channel Information:

Can you reproduce this issue with the current release? n/a
Can you reproduce this issue with the beta channel? yes
Can you reproduce this issue with the nightly channel? yes

Other Additional Information:

Does the issue resolve itself when disabling Brave Shields? n/a
Does the issue resolve itself when disabling Brave Rewards? n/a
Is the issue reproducible on the latest version of Chrome? n/a

Miscellaneous Information:

Related issues:

1.56.x uplift PR:
brave/brave-core#18780

To make life easier for @kjozwiak we're going to uplift these to 1.56.x in as few PRs as possible (seeing as non of these are critical unless most of them land).

Test Plan

Existing shortcuts should still work in a new profile - verify (CTRL+T for new tab, CTRL+N for new window, CTRL+L to focus the location bar.
It should be possible to add new shortcuts to these commands on brave://settings/system/shortcuts
1. Add Backspace as a shortcut for Back
2. Press Backspace - the browser should navigate back
3. Reset the shortcut. Backspace should no longer navigate back
4. Add ALT+LeftArrow as a shortcut for Forward. A warning should pop up saying This combination is being used for "Back". Saving will override that shortcut.
5. Pressing Alt+Left should now navigate forward.
6. Add Alt+Left as a shortcut to the Back command (neither back nor forward should be resettable now, as they are already at their defaults)
It should be possible to remove shortcuts from the commands
1. Remove Alt+Left from Back. Pressing the shortcut should no longer navigate back.
2. Add Alt+Left to Forward. No warning should appear.
It should be possible to add shortcuts to commands that didn't have them previously.
1. Add Alt+P to Pin Tab & Alt+D to duplicate tab
2. Alt+P should toggle whether a tab is pinned. Alt+D should duplicate the current tab (same as right-click duplicate)
It should be possible to reset all commands
1. Click the Reset all to defaults button at the bottom of the page.
2. All edited shortcuts should be reset.

Note: On macOS some shortcuts cannot be changed via the shortcuts UI. For these shortcuts, no remove button should show up, and it should not be possible to override them by adding their key combination to another shortcut.

The text was updated successfully, but these errors were encountered:

fallaciousreasoning · 2023-06-13T23:45:16Z

Note for QA: It's a known issue that pressing Shift+= will display as Shift++ in the recorder (but will still be recorded properly). See #30879

kjozwiak · 2023-07-06T20:45:46Z

@fallaciousreasoning @rebron should this issue be closed? I believe at this point we basically have everything merged into 1.56.x. Or should this stay in progress till #30879 is done? We have about ~week and a half left before we push out 1.56.x on July 18th.

Should #354 also be closed at this point?

CCing @LaurenWags

fallaciousreasoning · 2023-07-06T20:57:43Z

I think we can close this and #354, but let's have @rebron confirm. Thanks for all the uplifts/testing @kjozwiak & @LaurenWags!

LaurenWags · 2023-07-07T12:38:23Z

if we close this one out for 1.56.x we should have a test plan for it - we've verified various issues as listed above but afaik we still don't have a feature test plan, only the individual issues. I believe @rebron mentioned he'd work with you @fallaciousreasoning to get a test plan together?

fallaciousreasoning · 2023-07-09T22:18:09Z

Added a test plan to this issue 😄 Let me know if you think there's anything missing

LaurenWags · 2023-07-10T20:19:17Z

@fallaciousreasoning is there anything Windows (or Linux) specific we should be aware of when testing this one?

cc @brave/qa-team

stephendonner · 2023-07-10T20:39:47Z

Verification `PASSED` using

Brave | 1.56.1 Chromium: 115.0.5790.75 (Official Build) (x86_64)
-- | --
Revision | 3433e4d513e8454ba0243deea3d53693661dc0c3-refs/branch-heads/5790@{#1430}
OS | macOS Version 11.7.8 (Build 20G1351)

Shared Steps:

installed 1.56.1
launched Brave
opened brave://flags
set brave://flags/#brave-commands to Enabled
clicked Relaunch
opened brave://settings/
clicked on System
clicked on Shortcuts

`brave://flags`	`brave://settings/system/shortcuts`

Ensure (pre)existing shortcuts continue to work - PASSED

Ensured all of the following commands' keybindings/shortcuts worked:

New tab - command + T
New window - command + N
Focus location bar - command + L
Bookmark this tab - command + D
Back - command + {
Forward - command + }

Add new shortcuts to existing commands - PASSED

(continued from Shared Steps)

Back binding - PASSED

Steps:

clicked on Add next to Back
pressed delete (Backspace)
clicked Save
confirmed Back showed two keybindings/shortcuts
confirmed both worked
scrolled all the way down and clicked on Reset all to defaults
confirmed the added shortcut was removed
confirmed command + [ still navigated backwords

example	example	example	example	example	example

(continued from Shared Steps

Forward binding - PASSED

Steps:

clicked on Add next to Forward
pressed command + left arrow
clicked Save
confirmed Forward showed two keybindings/shortcuts
confirmed they both navigated forwards

example	example	example

Remove added shortcuts - PASSED

(continued from `Shared Steps`)

Steps:

added command + left arrow to Back
added command + right arrow to Forward
confirmed both worked
confirmed both had Reset next to Add, now
hovered over both command + left arrow & command+right arrow`
confirmed both had -
clicked on them
confirmed Reset disappears for both, as they are now back to their defaults

example	example	example	example

Add new shortcuts as a new command - PASSED

Steps:

(continued from Shared Steps)

searched for pin tab
clicked Add
pressed control + P
clicked Save
pressed control + P
confirmed the current tab became pinned

example	example	example	example

Unable to change system-level commands/key bindings - PASSED

(continued from Shared Steps)

Steps:

searched for back
confirmed no ability to remove the keybinding shortcut of command + [
clicked on Add for the next binding
tried to bind using command + [
confirmed I got an error about it being a system shortcut, and where to modify it, in System Settings
also confirmed with Print, Copy, etc.

example	example	example	example

Adding duplicate shortcuts - FAILED

(continued from Shared Steps)

clicked on Add next to Web app info
pressed Command + D
clicked Save
pressed Command + D

Expected:

Should open Web app info / not be allowed to be assigned as a shortcut

Actual:

Able to visibly create the assigned shortcut for Web app info, but it still works as regular Bookmark Tab

example	example	example

NOTE: Retest with latest nightly build after #31552 lands

Tested using

Brave | 1.56.3 Chromium: 115.0.5790.75 (Official Build) (x86_64)
-- | --
Revision | 3433e4d513e8454ba0243deea3d53693661dc0c3-refs/branch-heads/5790@{#1430}
OS | macOS Version 11.7.8 (Build 20G1351)

Reset all commands - PASSED

(continued from Shared Steps)

Steps:

assigned non-conflicting shortcuts to previously unassigned commands (Password Manager - Show app menu)
confirmed they worked
scrolled down to the bottom
clicked on Reset all to defaults
scrolled back up
confirmed shortcuts for Password Manager - Show app menu were reset and unassigned
confirmed the previous shortcuts no longer worked

example	example	example

Light mode - PASSED

example	example	example

Logged/encountered:

fallaciousreasoning · 2023-07-10T22:34:54Z

@fallaciousreasoning is there anything Windows (or Linux) specific we should be aware of when testing this one?

Nope, there's just the MacOS thing, where some shortcuts can't be edited.

MadhaviSeelam · 2023-07-11T00:34:14Z

Verification PASSED using

Brave | 1.56.1 Chromium: 115.0.5790.75 (Official Build) (64-bit)
-- | --
Revision | 3433e4d513e8454ba0243deea3d53693661dc0c3-refs/branch-heads/5790@{#1430}
OS | Windows 11 Version 22H2 (Build 22621.1928)

Shared Steps:

installed 1.56.1
launched Brave
opened brave://flags
set brave://flags/#brave-commands to Enabled
clicked Relaunch
opened brave://settings/
clicked on System
clicked on Shortcuts

`brave://flags`	`brave://settings/system/shortcuts`

Ensure (pre)existing shortcuts continue to work - PASSED

Ensured all of the following commands' keybindings/shortcuts worked:

New tab - CTRL + T
New window - CTRL+N + N
Focus location bar - CTRL+L
Bookmark this tab - CTRL + D
Back - Alt + ArrowLeft
Forward - Alt + ArrowRight

Add new shortcuts to existing commands - PASSED

(continued from Shared Steps)

Back shortcut- PASSED

Steps:

clicked on Add in the Back section
pressed Backspace as a new shortcut
clicked Save
confirmed Backspace shortcut is added
confirmed Alt+BrrowLeft& Backspace worked
clicked Reset.
confirmed Backspace no longer navigated back

example	example	example	example	example	example

Forward shortcut

clicked on Add in the Forward section
Press ALT+LeftArrow as a shortcut
A warning message shown This combination is being used for "Back". Saving will override that shortcut.
clicked Save
verified Alt+ArrowLeft is switched from Back to Forward
confirmed pressing Alt+ArrowLeft navigated forward.
clicked Add to add back Alt+ArrowLeft Or Reset
confirmed Alt+ArrowLeft is added to BackandResetoption is not available forBack&Forward` sections

example	example	example

Remove newly added and existing shortcuts - PASSED

(continued from Shared Steps)

Steps:

Removed existing Alt + ArrowLeft from Back
confirmed the shortcut no longer navigated back
Added Backspace to Back and verified it worked
removed Backspace
confirmed Backspace was removed and the shortcut no longer navigated back
added Alt + ArrowLeft to Forward
confirmed no warning message shown when Alt + ArrowLeft and verified that it navigated forward
hovered over both Alt + ArrowLeft
removed the shortcut via '-` from Forward section
confirmed Reset disappears for both, as they are now back to their defaults
clicked Reset in the `Back section
Alt + ArrowLeft shortcut shown in the Back section

example	example	example	example	example	example	example

Add new shortcuts as a new command - PASSED

Steps:

(continued from Shared Steps)

searched for pin
clicked Add
pressed Alt + P
clicked Save
pressed Alt + P
confirmed the current tab became pinned
confirmed able to toggle the pinned /unpinned tab with Alt+P
searched for Duplicate
added and over rided Alt+D shortcut
confirmed able to duplicate the tab with Alt+D shortcut

example	example	example	example

Reset all commands - PASSED

Added couple shortcuts for Pin tab (Alt+P) and Pin this page to Start screen.. (Cntrl + Alt + P)
click Reset all to defaults at the bottom of the page
both entries should be cleared
Edit existing shortcut for Focus bo0kmarks (Alt + Shift + B) to

Dark mode - PASSED

![image](https://github.com/brave/brave-browser/assets/98358127/c710da0f-c3f6-41a7-9424-2a3bce9c6275)

Upgrade - PASSED

Install 1.52.130
launch Brave
enabled #brave-commands in brave://flags
close the browser
shortcuts entry is not available in brave://settings/system as expected
launched Brave with 1.56.1
clicked shortcuts in `brave://settings/system

Confirmed Shortcuts UI is shown in brave://settings/system/shortcuts
Shortcuts are working as expected

example	example	example	example

GeetaSarvadnya · 2023-07-13T05:47:35Z

Verification PASSED on

Brave	1.56.5 Chromium: 115.0.5790.75 (Official Build) (64-bit) 
Revision	3433e4d513e8454ba0243deea3d53693661dc0c3-refs/branch-heads/5790@{#1430}
OS	Linux

Verified the test plan from Add ability to customize keyboard shortcuts #30840 (comment)
Logged Brave crashes when new key is added and reset and reload using CRTL+R #31614

Shared Steps:

installed 1.56.1
launched Brave
opened brave://flags
set brave://flags/#brave-commands to Enabled
clicked Relaunch
opened brave://settings/
clicked on System
clicked on Shortcuts

`brave://flags`	`brave://settings/system/shortcuts`	1	2	3	4	5	6	7	8	9	10	11	12	13	14

Ensure (pre)existing shortcuts continue to work - PASSED

Ensured all of the following commands' keybindings/shortcuts worked:

New tab - CTRL + T
New window - CTRL + N
Focus location bar - CTRL + L
Bookmark this tab - CTRL + D
Back - ALT + ArrowLeft
Forward - ALT + ArrowRight

Added Backspace as shortcut for Back cmd ensured when user press Backspace - the browser navigates back

Add new shortcuts to existing commands - PASSED

(continued from Shared Steps)

Back binding - PASSED

Steps:

clicked on Add next to Back
pressed delete (Backspace)
clicked Save
confirmed Back showed two keybindings/shortcuts
confirmed both worked
scrolled all the way down and clicked on Reset all to defaults
confirmed the added shortcut was removed
confirmed ALT + Arrowleft still navigated backwords

example	example	example	example	example	example

(continued from Shared Steps

Forward binding - PASSED

Steps:

clicked on Add next to Forward
pressed ALT + left arrow
clicked Save
confirmed Forward showed two keybindings/shortcuts
confirmed they both navigated forwards

example	example

Remove added shortcuts - PASSED

(continued from `Shared Steps`)

Steps:

added ALT + ArrowRight to Back
added ALT + ArrowLeft to Forward
confirmed both worked
confirmed both had Reset next to Add, now
hovered over both ALT + ArrowRight & ALT + ArrowLeft
confirmed both had -
clicked on them
confirmed Reset disappears for both, as they are now back to their defaults

example	example	example	example	example

Add new shortcuts as a new command - PASSED

Steps:

(continued from Shared Steps)

searched for pin tab
clicked Add
pressed control + P
clicked Save
pressed control + P
confirmed the current tab became pinned

example	example	example	example	example

Reset all commands - PASSED

Added couple shortcuts for Pin tab (Alt+P) and Pin this page to Start screen.. (Cntrl + Alt + P)
click Reset all to defaults at the bottom of the page
both entries should be cleared

Example	Example

rebron added the OS/Desktop label Jun 6, 2023

stephendonner added the feature/keyboard-shortcuts label Jun 6, 2023

rebron added release-notes/include feature/settings labels Jun 6, 2023

rebron assigned fallaciousreasoning Jun 6, 2023

fallaciousreasoning added the QA/Yes label Jun 14, 2023

LaurenWags added the QA/Test-All-Platforms label Jul 10, 2023

stephendonner added the QA/In-Progress Indicates that QA is currently in progress for that particular issue label Jul 10, 2023

MadhaviSeelam mentioned this issue Jul 11, 2023

Newly added shortcuts are not shown in the context menu #31574

Open

rebron mentioned this issue Jul 12, 2023

[Desktop] Users should be able to customize keyboard shortcuts #354

Closed

MadhaviSeelam added the QA Pass-Win64 label Jul 12, 2023

stephendonner added QA Pass-macOS and removed QA/In-Progress Indicates that QA is currently in progress for that particular issue labels Jul 12, 2023

GeetaSarvadnya mentioned this issue Jul 13, 2023

Brave crashes when new key is added and reset and reload using CRTL+R #31614

Closed

GeetaSarvadnya added the QA Pass-Linux label Jul 13, 2023

rebron closed this as completed Jul 18, 2023

rebron added this to the 1.56.x - Release milestone Jul 18, 2023

LaurenWags mentioned this issue Jul 18, 2023

Desktop Release Notes for 1.56.x Release #2 #31677

Closed

rebron changed the title ~~Add keyboard shortcuts~~ Add ability to customize keyboard shortcuts Jul 18, 2023

kjozwiak mentioned this issue Jul 19, 2023

Pending verification's/Release Notes from 1.56.x - Release #31725

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ability to customize keyboard shortcuts #30840

Add ability to customize keyboard shortcuts #30840

rebron commented Jun 6, 2023 •

edited

Loading

fallaciousreasoning commented Jun 13, 2023

kjozwiak commented Jul 6, 2023

fallaciousreasoning commented Jul 6, 2023

LaurenWags commented Jul 7, 2023 •

edited

Loading

fallaciousreasoning commented Jul 9, 2023

LaurenWags commented Jul 10, 2023

stephendonner commented Jul 10, 2023 •

edited

Loading

Steps:

Steps:

Steps:

Steps:

Steps:

fallaciousreasoning commented Jul 10, 2023

MadhaviSeelam commented Jul 11, 2023 •

edited

Loading

Steps:

Steps:

GeetaSarvadnya commented Jul 13, 2023 •

edited

Loading

Steps:

Steps:

Steps:

Add ability to customize keyboard shortcuts #30840

Add ability to customize keyboard shortcuts #30840

Comments

rebron commented Jun 6, 2023 • edited Loading

Description

Expected result:

Brave version (brave://version info)

Version/Channel Information:

Other Additional Information:

Miscellaneous Information:

Test Plan

fallaciousreasoning commented Jun 13, 2023

kjozwiak commented Jul 6, 2023

fallaciousreasoning commented Jul 6, 2023

LaurenWags commented Jul 7, 2023 • edited Loading

fallaciousreasoning commented Jul 9, 2023

LaurenWags commented Jul 10, 2023

stephendonner commented Jul 10, 2023 • edited Loading

Verification PASSED using

Shared Steps:

Steps:

Steps:

Steps:

Steps:

Steps:

Logged/encountered:

fallaciousreasoning commented Jul 10, 2023

MadhaviSeelam commented Jul 11, 2023 • edited Loading

Shared Steps:

Steps:

Steps:

GeetaSarvadnya commented Jul 13, 2023 • edited Loading

Shared Steps:

Steps:

Steps:

Steps:

rebron commented Jun 6, 2023 •

edited

Loading

LaurenWags commented Jul 7, 2023 •

edited

Loading

stephendonner commented Jul 10, 2023 •

edited

Loading

Verification `PASSED` using

MadhaviSeelam commented Jul 11, 2023 •

edited

Loading

GeetaSarvadnya commented Jul 13, 2023 •

edited

Loading