ember-learn / ember-learn/ember-cli-addon-docs

Make keyboard shortcuts optional

Open
#263 0 comments 2 reactions 0 assignees View on GitHub
bug
Dominant language
JavaScript
Stars
172
Forks
142
PR merge metrics
No merged PRs in 30d

Description

In addition to the `{{docs-keyboard-shortcuts}}` component, there are some keyboard shortcuts baked into `controllers/application.js` and `docs-viewer/component.js` that are enabled on initialization. These can interfere with components that have custom keyboard interactions.

A configuration option that disables shortcut initialization could solve this issue for some users.

Contributor guide

Open the contributing guide

Research direction

Start in controllers/application.js and docs-viewer/component.js, tracing the keyboard shortcuts enabled during initialization and how configuration is currently handled. Define the configuration entry point and verify that disabling it prevents those shortcuts while preserving the {{docs-keyboard-shortcuts}} component behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.