Skip to content

feat(NcPopover): auto return focus to trigger button on close #7415

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(NcPopover): auto return focus to trigger button on close #7415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 19 additions & 1 deletion src/components/NcPopover/NcPopover.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ options.themes[theme] = structuredClone(options.themes.dropdown)
* @typedef {import('focus-trap').FocusTargetValueOrFalse} FocusTargetValueOrFalse
* @typedef {FocusTargetValueOrFalse|() => FocusTargetValueOrFalse} SetReturnFocus
*/

export default {
name: 'NcPopover',

Expand Down Expand Up @@ -361,6 +362,15 @@ export default {
type: [Array, Object],
default: () => ['click'],
},

/**
* When there is no setReturnFocus, NcPopover will try to return focus to the trigger button.
* Use this prop to disable this behavior.
*/
noAutoReturnFocus: {
type: Boolean,
default: false,
},
},

emits: [
Expand Down Expand Up @@ -496,6 +506,14 @@ export default {
return this.$refs.popover?.$refs.popper?.$refs.reference
},

/**
* @return {HTMLElement|undefined}
*/
getPopoverTriggerButtonElement() {
const triggerContainer = this.getPopoverTriggerElement()
return triggerContainer && tabbable(triggerContainer)[0]
},

/**
* Add focus trap for accessibility.
*/
Expand All @@ -519,7 +537,7 @@ export default {
// Focus will be release when popover be hide
escapeDeactivates: false,
allowOutsideClick: true,
setReturnFocus: this.setReturnFocus,
setReturnFocus: this.setReturnFocus || (!this.noAutoReturnFocus && this.getPopoverTriggerButtonElement()),
trapStack: getTrapStack(),
fallBackFocus: el,
})
Expand Down