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

Offcanvas.js: If scroll is allowed, should allow focus on other elements #33677

Merged
merged 2 commits into from Apr 20, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion js/src/offcanvas.js
Expand Up @@ -112,6 +112,7 @@ class Offcanvas extends BaseComponent {

if (!this._config.scroll) {
scrollBarHide()
this._enforceFocusOnElement(this._element)
}

this._element.removeAttribute('aria-hidden')
Expand All @@ -121,7 +122,6 @@ class Offcanvas extends BaseComponent {

const completeCallBack = () => {
EventHandler.trigger(this._element, EVENT_SHOWN, { relatedTarget })
this._enforceFocusOnElement(this._element)
}

const transitionDuration = getTransitionDurationFromElement(this._element)
Expand Down
34 changes: 34 additions & 0 deletions js/tests/unit/offcanvas.spec.js
Expand Up @@ -220,6 +220,24 @@ describe('Offcanvas', () => {

offCanvas.show()
})

it('should not enforce focus if focus scroll is allowed', done => {
fixtureEl.innerHTML = '<div class="offcanvas"></div>'

const offCanvasEl = fixtureEl.querySelector('.offcanvas')
const offCanvas = new Offcanvas(offCanvasEl, {
scroll: true
})

spyOn(offCanvas, '_enforceFocusOnElement')

offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
expect(offCanvas._enforceFocusOnElement).not.toHaveBeenCalled()
done()
})

offCanvas.show()
})
})

describe('toggle', () => {
Expand Down Expand Up @@ -328,6 +346,22 @@ describe('Offcanvas', () => {
expect(instance).not.toBeNull()
expect(Offcanvas.prototype.show).toHaveBeenCalled()
})

it('should enforce focus', done => {
fixtureEl.innerHTML = '<div class="offcanvas"></div>'

const offCanvasEl = fixtureEl.querySelector('.offcanvas')
const offCanvas = new Offcanvas(offCanvasEl)

spyOn(offCanvas, '_enforceFocusOnElement')

offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
expect(offCanvas._enforceFocusOnElement).toHaveBeenCalled()
done()
})

offCanvas.show()
})
})

describe('hide', () => {
Expand Down