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

Keep role="dialog" after closing modal/offcanvas if already in the markup #39941

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
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
14 changes: 12 additions & 2 deletions js/src/modal.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ class Modal extends BaseComponent {
constructor(element, config) {
super(element, config)

this._deleteDialogRoleWhenHiding = false
this._dialog = SelectorEngine.findOne(SELECTOR_DIALOG, this._element)
this._backdrop = this._initializeBackDrop()
this._focustrap = this._initializeFocusTrap()
Expand Down Expand Up @@ -177,7 +178,12 @@ class Modal extends BaseComponent {
this._element.style.display = 'block'
this._element.removeAttribute('aria-hidden')
this._element.setAttribute('aria-modal', true)
this._element.setAttribute('role', 'dialog')

if (this._element.getAttribute('role') !== 'dialog') {
this._deleteDialogRoleWhenHiding = true
this._element.setAttribute('role', 'dialog')
}

this._element.scrollTop = 0

const modalBody = SelectorEngine.findOne(SELECTOR_MODAL_BODY, this._dialog)
Expand Down Expand Up @@ -246,7 +252,11 @@ class Modal extends BaseComponent {
this._element.style.display = 'none'
this._element.setAttribute('aria-hidden', true)
this._element.removeAttribute('aria-modal')
this._element.removeAttribute('role')

if (this._deleteDialogRoleWhenHiding) {
this._element.removeAttribute('role')
}

this._isTransitioning = false

this._backdrop.hide(() => {
Expand Down
13 changes: 11 additions & 2 deletions js/src/offcanvas.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ class Offcanvas extends BaseComponent {
constructor(element, config) {
super(element, config)

this._deleteDialogRoleWhenHiding = false
this._isShown = false
this._backdrop = this._initializeBackDrop()
this._focustrap = this._initializeFocusTrap()
Expand Down Expand Up @@ -109,7 +110,12 @@ class Offcanvas extends BaseComponent {
}

this._element.setAttribute('aria-modal', true)
this._element.setAttribute('role', 'dialog')

if (this._element.getAttribute('role') !== 'dialog') {
this._deleteDialogRoleWhenHiding = true
this._element.setAttribute('role', 'dialog')
}

this._element.classList.add(CLASS_NAME_SHOWING)

const completeCallBack = () => {
Expand Down Expand Up @@ -145,7 +151,10 @@ class Offcanvas extends BaseComponent {
const completeCallback = () => {
this._element.classList.remove(CLASS_NAME_SHOW, CLASS_NAME_HIDING)
this._element.removeAttribute('aria-modal')
this._element.removeAttribute('role')

if (this._deleteDialogRoleWhenHiding) {
this._element.removeAttribute('role')
}

if (!this._config.scroll) {
new ScrollBarHelper().reset()
Expand Down
29 changes: 29 additions & 0 deletions js/tests/unit/modal.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -709,6 +709,35 @@ describe('Modal', () => {
})
})

it('should hide a modal and not remove role="dialog" if already present', () => {
return new Promise(resolve => {
fixtureEl.innerHTML = '<div class="modal" role="dialog"><div class="modal-dialog"></div></div>'

const modalEl = fixtureEl.querySelector('.modal')
const modal = new Modal(modalEl)
const backdropSpy = spyOn(modal._backdrop, 'hide').and.callThrough()

modalEl.addEventListener('shown.bs.modal', () => {
modal.hide()
})

modalEl.addEventListener('hide.bs.modal', event => {
expect(event).toBeDefined()
})

modalEl.addEventListener('hidden.bs.modal', () => {
expect(modalEl.getAttribute('aria-modal')).toBeNull()
expect(modalEl.getAttribute('role')).toEqual('dialog')
expect(modalEl.getAttribute('aria-hidden')).toEqual('true')
expect(modalEl.style.display).toEqual('none')
expect(backdropSpy).toHaveBeenCalled()
resolve()
})

modal.show()
})
})

it('should close modal when clicking outside of modal-content', () => {
return new Promise(resolve => {
fixtureEl.innerHTML = '<div class="modal"><div class="modal-dialog"></div></div>'
Expand Down
20 changes: 20 additions & 0 deletions js/tests/unit/offcanvas.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -551,6 +551,26 @@ describe('Offcanvas', () => {
})
})

it('should hide a shown element and not remove role="dialog" if already present', () => {
return new Promise(resolve => {
fixtureEl.innerHTML = '<div class="offcanvas" role="dialog"></div>'

const offCanvasEl = fixtureEl.querySelector('div')
const offCanvas = new Offcanvas(offCanvasEl)
const spy = spyOn(offCanvas._backdrop, 'hide').and.callThrough()
offCanvas.show()

offCanvasEl.addEventListener('hidden.bs.offcanvas', () => {
expect(offCanvasEl).not.toHaveClass('show')
expect(offCanvasEl.getAttribute('role')).toEqual('dialog')
expect(spy).toHaveBeenCalled()
resolve()
})

offCanvas.hide()
})
})

it('should not fire hidden when hide is prevented', () => {
return new Promise((resolve, reject) => {
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
Expand Down
Loading