Handle keyboard-dependent focus outlines in Vuex #4847
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /* global kolibriGlobal */ | ||
| /** | ||
| * Adapted from https://github.com/alice/modality | ||
| * Version: 1.0.2 | ||
| * | ||
| * For Kolibri, this mirrors in Vuex the DOM updates done by modality.js in Keen-UI, | ||
| * which gives the code in theme.js easier access to the current modality. | ||
| */ | ||
|
|
||
| document.addEventListener('DOMContentLoaded', () => { | ||
| let hadKeyboardEvent = false; | ||
| const keyboardModalityWhitelist = [ | ||
| 'input:not([type])', | ||
| 'input[type=text]', | ||
| 'input[type=number]', | ||
| 'input[type=date]', | ||
| 'input[type=time]', | ||
| 'input[type=datetime]', | ||
| 'textarea', | ||
| '[role=textbox]', | ||
| '[supports-modality=keyboard]', | ||
| ].join(','); | ||
|
|
||
| let isHandlingKeyboardThrottle; | ||
|
|
||
| const matcher = (() => { | ||
| const el = document.body; | ||
|
|
||
| if (el.matchesSelector) { | ||
| return el.matchesSelector; | ||
| } | ||
|
|
||
| if (el.webkitMatchesSelector) { | ||
| return el.webkitMatchesSelector; | ||
| } | ||
|
|
||
| if (el.mozMatchesSelector) { | ||
| return el.mozMatchesSelector; | ||
| } | ||
|
|
||
| if (el.msMatchesSelector) { | ||
| return el.msMatchesSelector; | ||
| } | ||
|
|
||
| /* eslint-disable-next-line */ | ||
| console.error("Couldn't find any matchesSelector method on document.body."); | ||
| })(); | ||
|
|
||
| const disableFocusRingByDefault = function() { | ||
| const css = 'body:not([modality=keyboard]) :focus { outline: none; }'; | ||
| const head = document.head || document.getElementsByTagName('head')[0]; | ||
| const style = document.createElement('style'); | ||
|
|
||
| style.type = 'text/css'; | ||
| style.id = 'disable-focus-ring'; | ||
|
|
||
| if (style.styleSheet) { | ||
| style.styleSheet.cssText = css; | ||
| } else { | ||
| style.appendChild(document.createTextNode(css)); | ||
| } | ||
|
|
||
| head.insertBefore(style, head.firstChild); | ||
| }; | ||
|
|
||
| const focusTriggersKeyboardModality = function(el) { | ||
| let triggers = false; | ||
|
|
||
| if (matcher) { | ||
| triggers = | ||
| matcher.call(el, keyboardModalityWhitelist) && matcher.call(el, ':not([readonly])'); | ||
| } | ||
|
|
||
| return triggers; | ||
| }; | ||
|
|
||
| disableFocusRingByDefault(); | ||
|
|
||
| document.body.addEventListener( | ||
| 'keydown', | ||
| () => { | ||
| hadKeyboardEvent = true; | ||
|
|
||
| if (isHandlingKeyboardThrottle) { | ||
| clearTimeout(isHandlingKeyboardThrottle); | ||
| } | ||
|
|
||
| isHandlingKeyboardThrottle = setTimeout(() => { | ||
| hadKeyboardEvent = false; | ||
| }, 100); | ||
| }, | ||
| true | ||
| ); | ||
|
There was a problem hiding this comment. I know this was probably just copied over during the port so fine to leave as-is. However heads-up that we have two throttling libraries already included:
|
||
|
|
||
| document.body.addEventListener( | ||
| 'focus', | ||
| e => { | ||
| if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) { | ||
| kolibriGlobal.coreVue.vuex.store.commit('SET_MODALITY', 'keyboard'); | ||
|
There was a problem hiding this comment. Any reason we can't just import the store here, rather than referencing the global? |
||
| } | ||
| }, | ||
| true | ||
| ); | ||
|
|
||
| document.body.addEventListener( | ||
| 'blur', | ||
| () => { | ||
| kolibriGlobal.coreVue.vuex.store.commit('SET_MODALITY', null); | ||
|
|
||
| }, | ||
| true | ||
| ); | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this function here? Presumably the Keen-UI helper is still doing this part?