import { describe, it, expect, beforeAll, afterEach, vi } from 'vitest'
import Tab from '../../src/bootstrap/tab'
import { clearFixture, createEvent, getFixture } from '../helpers/fixture'
describe('Tab', () => {
let fixtureEl: HTMLElement
beforeAll(() => {
fixtureEl = getFixture()
})
afterEach(() => {
clearFixture()
vi.restoreAllMocks()
})
describe('VERSION', () => {
it('should return plugin version', () => {
expect(typeof Tab.VERSION).toBe('string')
})
})
describe('constructor', () => {
it('should accept element as CSS selector or DOM element', () => {
fixtureEl.innerHTML = ['
', ''].join('')
const tabEl = fixtureEl.querySelector('[href="#home"]')!
const tabBySelector = new Tab('[href="#home"]')
const tabByElement = new Tab(tabEl)
expect(tabBySelector._element).toBe(tabEl)
expect(tabByElement._element).toBe(tabEl)
})
it('should not throw if no parent', () => {
fixtureEl.innerHTML = ''
const navEl = fixtureEl.querySelector('.nav-link')!
expect(() => {
new Tab(navEl)
}).not.toThrow()
})
})
describe('show', () => {
it('should activate element by tab id using buttons', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
' Home ',
' Profile ',
' ',
'',
].join('')
const profileTriggerEl = fixtureEl.querySelector('#triggerProfile')!
const tab = new Tab(profileTriggerEl)
profileTriggerEl.addEventListener('shown.bs.tab', () => {
expect(fixtureEl.querySelector('#profile')!.classList.contains('active')).toBe(true)
expect(profileTriggerEl.getAttribute('aria-selected')).toBe('true')
resolve()
})
tab.show()
})
})
it('should activate element by tab id using links', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = ['', ''].join('')
const profileTriggerEl = fixtureEl.querySelector('#triggerProfile')!
const tab = new Tab(profileTriggerEl)
profileTriggerEl.addEventListener('shown.bs.tab', () => {
expect(fixtureEl.querySelector('#profile')!.classList.contains('active')).toBe(true)
expect(profileTriggerEl.getAttribute('aria-selected')).toBe('true')
resolve()
})
tab.show()
})
})
it('should activate element in list group', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
' Home ',
' Profile ',
'
',
'',
].join('')
const profileTriggerEl = fixtureEl.querySelector('#triggerProfile')!
const tab = new Tab(profileTriggerEl)
profileTriggerEl.addEventListener('shown.bs.tab', () => {
expect(fixtureEl.querySelector('#profile')!.classList.contains('active')).toBe(true)
resolve()
})
tab.show()
})
})
it('should not fire shown when show is prevented', () => {
return new Promise((resolve, reject) => {
fixtureEl.innerHTML = ''
const navEl = fixtureEl.querySelector('.nav > div')!
const tab = new Tab(navEl)
navEl.addEventListener('show.bs.tab', (ev) => {
ev.preventDefault()
setTimeout(resolve, 30)
})
navEl.addEventListener('shown.bs.tab', () => {
reject(new Error('should not trigger shown'))
})
tab.show()
})
})
it('should not fire shown when already active', () => {
return new Promise((resolve, reject) => {
fixtureEl.innerHTML = [
'',
' Home ',
' Profile ',
' ',
'',
].join('')
const triggerActive = fixtureEl.querySelector('button.active')!
const tab = new Tab(triggerActive)
triggerActive.addEventListener('shown.bs.tab', () => {
reject(new Error('should not trigger shown'))
})
tab.show()
setTimeout(resolve, 30)
})
})
it('show and shown events should reference correct relatedTarget', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
' Home ',
' Profile ',
' ',
'',
].join('')
const secondTabTrigger = fixtureEl.querySelector('#triggerProfile')!
const secondTab = new Tab(secondTabTrigger)
secondTabTrigger.addEventListener('show.bs.tab', ((ev: CustomEvent) => {
expect(ev.relatedTarget!.getAttribute('data-bs-target')).toBe('#home')
}) as EventListener)
secondTabTrigger.addEventListener('shown.bs.tab', ((ev: CustomEvent) => {
expect(ev.relatedTarget!.getAttribute('data-bs-target')).toBe('#home')
expect(secondTabTrigger.getAttribute('aria-selected')).toBe('true')
resolve()
}) as EventListener)
secondTab.show()
})
})
it('should fire hide and hidden events', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = ['', ' Home ', ' Profile ', ' '].join('')
const triggerList = fixtureEl.querySelectorAll('button')
const firstTab = new Tab(triggerList[0])
const secondTab = new Tab(triggerList[1])
let hideCalled = false
triggerList[0].addEventListener('shown.bs.tab', () => {
secondTab.show()
})
triggerList[0].addEventListener('hide.bs.tab', ((ev: CustomEvent) => {
hideCalled = true
expect(ev.relatedTarget!.getAttribute('data-bs-target')).toBe('#profile')
}) as EventListener)
triggerList[0].addEventListener('hidden.bs.tab', ((ev: CustomEvent) => {
expect(hideCalled).toBe(true)
expect(ev.relatedTarget!.getAttribute('data-bs-target')).toBe('#profile')
resolve()
}) as EventListener)
firstTab.show()
})
})
it('should not fire hidden when hide is prevented', () => {
return new Promise((resolve, reject) => {
fixtureEl.innerHTML = ['', ' Home ', ' Profile ', ' '].join('')
const triggerList = fixtureEl.querySelectorAll('button')
const firstTab = new Tab(triggerList[0])
const secondTab = new Tab(triggerList[1])
triggerList[0].addEventListener('shown.bs.tab', () => {
secondTab.show()
})
triggerList[0].addEventListener('hide.bs.tab', (ev) => {
ev.preventDefault()
setTimeout(resolve, 30)
})
triggerList[0].addEventListener('hidden.bs.tab', () => {
reject(new Error('should not trigger hidden'))
})
firstTab.show()
})
})
})
describe('dispose', () => {
it('should dispose a tab', () => {
fixtureEl.innerHTML = ''
const el = fixtureEl.querySelector('.nav > div')!
const tab = new Tab(el)
expect(Tab.getInstance(el)).not.toBeNull()
tab.dispose()
expect(Tab.getInstance(el)).toBeNull()
})
})
describe('_activate', () => {
it('should not be called if element is null', () => {
fixtureEl.innerHTML = [''].join('')
const tabEl = fixtureEl.querySelector('.nav-link')!
const tab = new Tab(tabEl)
const spy = vi.spyOn(tab, '_queueCallback')
tab._activate(null)
expect(spy).not.toHaveBeenCalled()
})
})
describe('_setInitialAttributes', () => {
it('should set aria attributes', () => {
fixtureEl.innerHTML = ['', '
', '
'].join('')
const tabEl = fixtureEl.querySelector('.nav-link')!
const parent = fixtureEl.querySelector('.nav') as HTMLElement
const children = Array.from(fixtureEl.querySelectorAll('.nav-link')) as HTMLElement[]
const tabPanel = fixtureEl.querySelector('#panel')!
const tabPanel2 = fixtureEl.querySelector('#panel2')!
expect(parent.getAttribute('role')).toBeNull()
const tab = new Tab(tabEl)
tab._setInitialAttributes(parent, children)
expect(parent.getAttribute('role')).toBe('tablist')
expect(tabEl.getAttribute('role')).toBe('tab')
expect(tabPanel.getAttribute('role')).toBe('tabpanel')
expect(tabPanel2.getAttribute('role')).toBe('tabpanel')
expect(tabPanel.getAttribute('aria-labelledby')).toBe('foo')
expect(tabPanel2.hasAttribute('aria-labelledby')).toBe(false)
})
})
describe('_keydown', () => {
it('should ignore non-arrow keys', () => {
fixtureEl.innerHTML = [''].join('')
const tabEl = fixtureEl.querySelector('.nav-link')!
const tab = new Tab(tabEl)
const spyStop = vi.spyOn(Event.prototype, 'stopPropagation')
const spyPrevent = vi.spyOn(Event.prototype, 'preventDefault')
const keydown = createEvent('keydown') as any
keydown.key = 'Enter'
tabEl.dispatchEvent(keydown)
expect(spyStop).not.toHaveBeenCalled()
expect(spyPrevent).not.toHaveBeenCalled()
})
it('should handle right/down arrow', () => {
fixtureEl.innerHTML = ['', ' ', ' ', ' ', '
'].join('')
const tabEl1 = fixtureEl.querySelector('#tab1')!
const tabEl2 = fixtureEl.querySelector('#tab2')!
const tabEl3 = fixtureEl.querySelector('#tab3')!
new Tab(tabEl1)
new Tab(tabEl2)
new Tab(tabEl3)
const spyFocus2 = vi.spyOn(tabEl2, 'focus')
const spyFocus3 = vi.spyOn(tabEl3, 'focus')
const keydown = new KeyboardEvent('keydown', { key: 'ArrowRight', bubbles: true })
tabEl1.dispatchEvent(keydown)
expect(spyFocus2).toHaveBeenCalled()
})
it('should handle left/up arrow', () => {
fixtureEl.innerHTML = ['', ' ', ' ', '
'].join('')
const tabEl1 = fixtureEl.querySelector('#tab1')!
const tabEl2 = fixtureEl.querySelector('#tab2')!
new Tab(tabEl1)
new Tab(tabEl2)
const spyFocus1 = vi.spyOn(tabEl1, 'focus')
const keydown = new KeyboardEvent('keydown', { key: 'ArrowLeft', bubbles: true })
tabEl2.dispatchEvent(keydown)
expect(spyFocus1).toHaveBeenCalled()
})
it('should handle Home key', () => {
fixtureEl.innerHTML = ['', ' ', ' ', ' ', '
'].join('')
const tabEl1 = fixtureEl.querySelector('#tab1')!
const tabEl3 = fixtureEl.querySelector('#tab3')!
new Tab(tabEl1)
new Tab(tabEl3)
const spyFocus1 = vi.spyOn(tabEl1, 'focus')
const keydown = new KeyboardEvent('keydown', { key: 'Home', bubbles: true })
tabEl3.dispatchEvent(keydown)
expect(spyFocus1).toHaveBeenCalled()
})
it('should handle End key', () => {
fixtureEl.innerHTML = ['', ' ', ' ', ' ', '
'].join('')
const tabEl1 = fixtureEl.querySelector('#tab1')!
const tabEl3 = fixtureEl.querySelector('#tab3')!
new Tab(tabEl1)
new Tab(tabEl3)
const spyFocus3 = vi.spyOn(tabEl3, 'focus')
const keydown = new KeyboardEvent('keydown', { key: 'End', bubbles: true })
tabEl1.dispatchEvent(keydown)
expect(spyFocus3).toHaveBeenCalled()
})
it('should skip disabled elements', () => {
fixtureEl.innerHTML = [
'',
' ',
' ',
' ',
' ',
'
',
].join('')
const tabEl1 = fixtureEl.querySelector('#tab1')!
const tabEl4 = fixtureEl.querySelector('#tab4')!
new Tab(tabEl1)
new Tab(tabEl4)
const spyFocus4 = vi.spyOn(tabEl4, 'focus')
const keydown = new KeyboardEvent('keydown', { key: 'ArrowRight', bubbles: true })
tabEl1.dispatchEvent(keydown)
expect(spyFocus4).toHaveBeenCalled()
})
})
describe('getInstance', () => {
it('should return null if no instance', () => {
expect(Tab.getInstance(fixtureEl)).toBeNull()
})
it('should return this instance', () => {
fixtureEl.innerHTML = ''
const divEl = fixtureEl.querySelector('.nav > div')!
const tab = new Tab(divEl)
expect(Tab.getInstance(divEl)).toBe(tab)
expect(Tab.getInstance(divEl)).toBeInstanceOf(Tab)
})
})
describe('getOrCreateInstance', () => {
it('should return tab instance', () => {
fixtureEl.innerHTML = ''
const div = fixtureEl.querySelector('div')!
const tab = new Tab(div)
expect(Tab.getOrCreateInstance(div)).toBe(tab)
expect(Tab.getOrCreateInstance(div)).toBeInstanceOf(Tab)
})
it('should return new instance when there is no tab instance', () => {
fixtureEl.innerHTML = ''
const div = fixtureEl.querySelector('div')!
expect(Tab.getInstance(div)).toBeNull()
expect(Tab.getOrCreateInstance(div)).toBeInstanceOf(Tab)
})
})
describe('data-api', () => {
it('should create dynamically a tab', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
' Home ',
' Profile ',
' ',
'',
].join('')
const secondTabTrigger = fixtureEl.querySelector('#triggerProfile')!
secondTabTrigger.addEventListener('shown.bs.tab', () => {
expect(secondTabTrigger.classList.contains('active')).toBe(true)
expect(fixtureEl.querySelector('#profile')!.classList.contains('active')).toBe(true)
resolve()
})
;(secondTabTrigger as HTMLElement).click()
})
})
it('should prevent default when trigger is ', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [''].join('')
const tabEl = fixtureEl.querySelector('[href="#test2"]') as HTMLElement
const spy = vi.spyOn(Event.prototype, 'preventDefault')
tabEl.addEventListener('shown.bs.tab', () => {
expect(tabEl.classList.contains('active')).toBe(true)
expect(spy).toHaveBeenCalled()
resolve()
})
tabEl.click()
})
})
it('should not fire shown for disabled button', () => {
return new Promise((resolve, reject) => {
fixtureEl.innerHTML = [
'',
' Home ',
' Profile ',
' ',
].join('')
const triggerDisabled = fixtureEl.querySelector('button[disabled]')!
triggerDisabled.addEventListener('shown.bs.tab', () => {
reject(new Error('should not fire shown'))
})
;(triggerDisabled as HTMLElement).click()
setTimeout(resolve, 30)
})
})
it('should not fire shown for disabled link', () => {
return new Promise((resolve, reject) => {
fixtureEl.innerHTML = [
'',
].join('')
const triggerDisabled = fixtureEl.querySelector('a.disabled')!
triggerDisabled.addEventListener('shown.bs.tab', () => {
reject(new Error('should not fire shown'))
})
;(triggerDisabled as HTMLElement).click()
setTimeout(resolve, 30)
})
})
it('should handle nested tabs', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
' Tab 1 ',
' Tab 2 ',
' ',
'',
'
',
'
',
' Nested 1 ',
' Nested 2 ',
' ',
'
',
'
Nested 1
',
'
Nested 2
',
'
',
'
',
'
Tab2
',
'
',
].join('')
const tab1El = fixtureEl.querySelector('#tab1') as HTMLElement
const tabNested2El = fixtureEl.querySelector('#tabNested2') as HTMLElement
const xTab1El = fixtureEl.querySelector('#x-tab1')!
tabNested2El.addEventListener('shown.bs.tab', () => {
expect(xTab1El.classList.contains('active')).toBe(true)
resolve()
})
tab1El.addEventListener('shown.bs.tab', () => {
expect(xTab1El.classList.contains('active')).toBe(true)
tabNested2El.click()
})
tab1El.click()
})
})
it('selected tab should deactivate previous selected link in dropdown', () => {
fixtureEl.innerHTML = [
'',
].join('')
const firstLiLinkEl = fixtureEl.querySelector('li:first-child a') as HTMLElement
firstLiLinkEl.click()
expect(firstLiLinkEl.classList.contains('active')).toBe(true)
expect(fixtureEl.querySelector('li:last-child a')!.classList.contains('active')).toBe(false)
expect(fixtureEl.querySelector('li:last-child .dropdown-menu a:first-child')!.classList.contains('active')).toBe(false)
})
it('selecting dropdown tab does not activate another nav', () => {
fixtureEl.innerHTML = [
'',
'',
].join('')
const firstDropItem = fixtureEl.querySelector('#nav1 .dropdown-item') as HTMLElement
firstDropItem.click()
expect(firstDropItem.classList.contains('active')).toBe(true)
expect(fixtureEl.querySelector('#nav1 .dropdown-toggle')!.classList.contains('active')).toBe(true)
expect(fixtureEl.querySelector('#nav2 .dropdown-toggle')!.classList.contains('active')).toBe(false)
expect(fixtureEl.querySelector('#nav2 .dropdown-item')!.classList.contains('active')).toBe(false)
})
it('should support li > .dropdown-item', () => {
fixtureEl.innerHTML = [
'',
].join('')
const dropItems = fixtureEl.querySelectorAll('.dropdown-item')
;(dropItems[1] as HTMLElement).click()
expect(dropItems[0].classList.contains('active')).toBe(false)
expect(dropItems[1].classList.contains('active')).toBe(true)
expect(fixtureEl.querySelector('.nav-link')!.classList.contains('active')).toBe(false)
})
it('should add show class to pane without fade', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
' ',
' Home ',
' ',
' ',
' Profile ',
' ',
' ',
'',
'
test 1
',
'
test 2
',
'
',
].join('')
const secondNavEl = fixtureEl.querySelector('#secondNav') as HTMLElement
secondNavEl.addEventListener('shown.bs.tab', () => {
expect(fixtureEl.querySelectorAll('.tab-content .show')).toHaveLength(1)
resolve()
})
secondNavEl.click()
})
})
})
describe('data-tblr-toggle', () => {
it('should create tab via data-tblr-toggle="tab"', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
' Home ',
' Profile ',
' ',
'',
].join('')
const trigger = fixtureEl.querySelector('#triggerProfile') as HTMLElement
trigger.addEventListener('shown.bs.tab', () => {
expect(trigger.classList.contains('active')).toBe(true)
expect(fixtureEl.querySelector('#profile')!.classList.contains('active')).toBe(true)
resolve()
})
trigger.click()
})
})
it('should create tab via data-tblr-toggle="pill"', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
' Home ',
' Profile ',
' ',
'',
].join('')
const trigger = fixtureEl.querySelector('#triggerProfile') as HTMLElement
trigger.addEventListener('shown.bs.tab', () => {
expect(trigger.classList.contains('active')).toBe(true)
resolve()
})
trigger.click()
})
})
it('should initialize active tabs with data-tblr-toggle on load', () => {
fixtureEl.innerHTML = ['', '
'].join('')
const trigger = fixtureEl.querySelector('button') as HTMLElement
window.dispatchEvent(new Event('load'))
expect(trigger.classList.contains('active')).toBe(true)
})
it('should create tab via data-tblr-toggle="list"', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
'',
'
Home
',
'
Profile
',
'
',
].join('')
const trigger = fixtureEl.querySelector('#triggerProfile') as HTMLElement
trigger.addEventListener('shown.bs.tab', () => {
expect(trigger.classList.contains('active')).toBe(true)
resolve()
})
trigger.click()
})
})
it('should switch tabs via data-tblr-toggle with data-tblr-target', () => {
return new Promise((resolve) => {
fixtureEl.innerHTML = [
'',
' Home ',
' Profile ',
' ',
'',
'
Home
',
'
Profile
',
'
',
].join('')
const trigger = fixtureEl.querySelector('#triggerProfile') as HTMLElement
trigger.addEventListener('shown.bs.tab', () => {
expect(trigger.classList.contains('active')).toBe(true)
resolve()
})
trigger.click()
})
})
})
})