Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add keyboard focus border for dropdown options #3

Merged
merged 3 commits into from
Jan 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion src/components/Select.vue
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,11 @@
isOptionDeselectable(option) && index === typeAheadPointer,
'vs__dropdown-option--selected': isOptionSelected(option),
'vs__dropdown-option--highlight': index === typeAheadPointer,
'vs__dropdown-option--kb-focus': hasKeyboardFocusBorder(index),
'vs__dropdown-option--disabled': !selectable(option),
}"
:aria-selected="optionAriaSelected(option)"
@mouseover="selectable(option) ? (typeAheadPointer = index) : null"
@mousemove="onMouseMove(option, index)"
@click.prevent.stop="selectable(option) ? select(option) : null"
>
<slot name="option" v-bind="normalizeOptionForSlot(option)">
Expand Down Expand Up @@ -661,6 +662,15 @@ export default {
},
},

/**
* Display a visible border around dropdown options
* which have keyboard focus.
*/
keyboardFocusBorder: {
type: Boolean,
default: false,
},

/**
* A unique identifier used to generate IDs in HTML.
* Must be unique for every instance of the component.
Expand All @@ -676,6 +686,7 @@ export default {
search: '',
open: false,
isComposing: false,
isKeyboardNavigation: false,
pushedTags: [],
// eslint-disable-next-line vue/no-reserved-keys
_value: [], // Internal value managed by Vue Select if no `value` prop is passed
Expand Down Expand Up @@ -1135,6 +1146,19 @@ export default {
return this.isOptionSelected(option) && this.deselectFromDropdown
},

/**
* Check if the option at the given index should display a
* keyboard focus border.
* @param {Number} index
* @return {Boolean}
*/
hasKeyboardFocusBorder(index) {
if (this.keyboardFocusBorder && this.isKeyboardNavigation) {
return index === this.typeAheadPointer
}
return false
},

/**
* Determine if two option objects are matching.
*
Expand Down Expand Up @@ -1324,6 +1348,20 @@ export default {
this.mousedown = false
},

/**
* Event-Handler for option mousemove
* @param {Object|String} option
* @param {Number} index
* @return {void}
*/
onMouseMove(option, index) {
this.isKeyboardNavigation = false
if (!this.selectable(option)) {
return
}
this.typeAheadPointer = index
},

/**
* Search <input> KeyBoardEvent handler.
* @param {KeyboardEvent} e
Expand All @@ -1349,6 +1387,7 @@ export default {
// up.prevent
38: (e) => {
e.preventDefault()
this.isKeyboardNavigation = true
if (!this.open) {
this.open = true
return
Expand All @@ -1358,6 +1397,7 @@ export default {
// down.prevent
40: (e) => {
e.preventDefault()
this.isKeyboardNavigation = true
if (!this.open) {
this.open = true
return
Expand Down
5 changes: 4 additions & 1 deletion src/css/global/variables.css
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,12 @@
--vs-dropdown-option-padding: 3px 20px;

/* Active State */
--vs-dropdown-option--active-bg: #5897fb;
--vs-dropdown-option--active-bg: #136cfb;
--vs-dropdown-option--active-color: #fff;

/* Keyboard Focus State */
--vs-dropdown-option--kb-focus-box-shadow: inset 0px 0px 0px 2px #949494;

/* Deselect State */
--vs-dropdown-option--deselect-bg: #fb5858;
--vs-dropdown-option--deselect-color: #fff;
Expand Down
4 changes: 4 additions & 0 deletions src/css/modules/dropdown-option.css
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@
color: var(--vs-dropdown-option--active-color);
}

.vs__dropdown-option--kb-focus {
box-shadow: var(--vs-dropdown-option--kb-focus-box-shadow);
}

.vs__dropdown-option--deselect {
background: var(--vs-dropdown-option--deselect-bg);
color: var(--vs-dropdown-option--deselect-color);
Expand Down