element-plus/packages/components/dialog/__tests__/dialog.test.tsx

346 lines
9.6 KiB
TypeScript
Raw Normal View History

import { markRaw, nextTick } from 'vue'
import { mount } from '@vue/test-utils'
import { describe, expect, test, vi } from 'vitest'
import { rAF } from '@element-plus/test-utils/tick'
import triggerCompositeClick from '@element-plus/test-utils/composite-click'
import { Delete } from '@element-plus/icons-vue'
import Dialog from '../src/dialog.vue'
const AXIOM = 'Rem is the best girl'
describe('Dialog.vue', () => {
test('render test', async () => {
const wrapper = mount(<Dialog modelValue={true}>{AXIOM}</Dialog>)
await nextTick()
await rAF()
await nextTick()
expect(wrapper.find('.el-dialog__body').text()).toEqual(AXIOM)
})
test('dialog should have a title and header when it has been given', async () => {
const HEADER = 'I am header'
const wrapper = mount(
<Dialog
modelValue={true}
v-slots={{
header: () => HEADER,
}}
>
{AXIOM}
</Dialog>
)
await nextTick()
expect(wrapper.find('.el-dialog__header').text()).toBe(HEADER)
mount(
<Dialog modelValue={true} title={HEADER}>
{AXIOM}
</Dialog>
)
await nextTick()
expect(wrapper.find('.el-dialog__header').text()).toBe(HEADER)
})
test('dialog header should have slot props', async () => {
const wrapper = mount(
<Dialog
modelValue={true}
v-slots={{
header: ({
titleId,
titleClass,
close,
}: {
titleId: string
titleClass: string
close: () => void
}) => (
<button
data-title-id={titleId}
data-title-class={titleClass}
onClick={close}
/>
),
}}
>
{AXIOM}
</Dialog>
)
await nextTick()
const headerButton = wrapper.find('button')
expect(headerButton.attributes()['data-title-id']).toBeTruthy()
expect(headerButton.attributes()['data-title-class']).toBe(
'el-dialog__title'
)
expect(wrapper.emitted().close).toBeFalsy()
headerButton.trigger('click')
await nextTick()
expect(wrapper.emitted()).toHaveProperty('close')
})
test('dialog should have a footer when footer has been given', async () => {
const wrapper = mount(
<Dialog modelValue={true} v-slots={{ footer: () => AXIOM }}>
{AXIOM}
</Dialog>
)
await nextTick()
expect(wrapper.find('.el-dialog__footer').exists()).toBe(true)
expect(wrapper.find('.el-dialog__footer').text()).toBe(AXIOM)
})
test('should append dialog to body when appendToBody is true', async () => {
const wrapper = mount(
<Dialog modelValue={true} appendToBody={true}>
{AXIOM}
</Dialog>
)
await nextTick()
expect(
document.body.firstElementChild!.classList.contains('el-overlay')
).toBe(true)
wrapper.unmount()
})
test('should center dialog', async () => {
const wrapper = mount(
<Dialog modelValue={true} center={true}>
{AXIOM}
</Dialog>
)
await nextTick()
expect(wrapper.find('.el-dialog--center').exists()).toBe(true)
})
test('should show close button', async () => {
const wrapper = mount(<Dialog modelValue={true}>{AXIOM}</Dialog>)
await nextTick()
expect(wrapper.find('.el-dialog__close').exists()).toBe(true)
})
test('should hide close button when showClose = false', async () => {
const wrapper = mount(
<Dialog modelValue={true} showClose={false}>
{AXIOM}
</Dialog>
)
await nextTick()
expect(wrapper.find('.el-dialog__headerbtn').exists()).toBe(false)
})
test('should close dialog when click on close button', async () => {
const wrapper = mount(<Dialog modelValue={true}>{AXIOM}</Dialog>)
await nextTick()
await wrapper.find('.el-dialog__headerbtn').trigger('click')
expect(wrapper.vm.visible).toBe(false)
})
describe('mask related', () => {
test('should not have overlay mask when mask is false', async () => {
const wrapper = mount(
<Dialog modal={false} modelValue={true}>
{AXIOM}
</Dialog>
)
await nextTick()
expect(wrapper.find('.el-overlay').exists()).toBe(false)
})
test('should close the modal when clicking on mask when `closeOnClickModal` is true', async () => {
const wrapper = mount(<Dialog modelValue={true}>{AXIOM}</Dialog>)
await nextTick()
expect(wrapper.find('.el-overlay').exists()).toBe(true)
expect(wrapper.find('.el-overlay-dialog').exists()).toBe(true)
await triggerCompositeClick(wrapper.find('.el-overlay-dialog'))
expect(wrapper.vm.visible).toBe(false)
})
})
describe('life cycles', () => {
test('should call before close', async () => {
const beforeClose = vi.fn()
const wrapper = mount(
<Dialog modelValue={true} beforeClose={beforeClose}>
{AXIOM}
</Dialog>
)
await nextTick()
await wrapper.find('.el-dialog__headerbtn').trigger('click')
expect(beforeClose).toHaveBeenCalled()
})
test('should not close dialog when user cancelled', async () => {
const beforeClose = vi
.fn()
.mockImplementation((hide: (cancel: boolean) => void) => hide(true))
const wrapper = mount(
<Dialog modelValue={true} beforeClose={beforeClose}>
{AXIOM}
</Dialog>
)
await nextTick()
await wrapper.find('.el-dialog__headerbtn').trigger('click')
expect(beforeClose).toHaveBeenCalled()
expect(wrapper.vm.visible).toBe(true)
})
test('should open and close with delay', async () => {
const wrapper = mount(
<Dialog openDelay={200} closeDelay={200} modelValue={false}>
{AXIOM}
</Dialog>
)
expect(wrapper.vm.visible).toBe(false)
await wrapper.setProps({
modelValue: true,
})
})
test('should destroy on close', async () => {
const wrapper = mount(
<Dialog modelValue={true} destroyOnClose={true}>
{AXIOM}
</Dialog>
)
expect(wrapper.vm.visible).toBe(true)
await nextTick()
await rAF()
await nextTick()
await wrapper.find('.el-dialog__headerbtn').trigger('click')
await wrapper.setProps({
// manually setting this prop because that Transition is not available in testing,
// updating model value event was emitted via transition hooks.
modelValue: false,
})
await nextTick()
await rAF()
await nextTick()
expect(wrapper.find('.el-dialog__body').exists()).toBe(false)
})
test('should emit close event', async () => {
let visible = true
const onClose = vi.fn()
const onClosed = vi.fn()
const wrapper = mount(
<Dialog
modelValue={true}
onUpdate:modelValue={(val: boolean) => (visible = val)}
onClose={onClose}
onClosed={onClosed}
>
{AXIOM}
</Dialog>
)
expect(wrapper.vm.visible).toBe(true)
await nextTick()
await rAF()
await nextTick()
await triggerCompositeClick(wrapper.find('.el-overlay-dialog'))
await nextTick()
await rAF()
await nextTick()
expect(onClose).toHaveBeenCalled()
expect(onClosed).toHaveBeenCalled()
expect(visible).toBe(false)
})
test('closeIcon', async () => {
const wrapper = mount(
<Dialog modelValue={true} closeIcon={markRaw(Delete)}>
{AXIOM}
</Dialog>
)
await nextTick()
await rAF()
const closeIcon = wrapper.find('svg')
expect(closeIcon.exists()).toBe(true)
const svg = mount(Delete).find('svg').element
expect(closeIcon.element.innerHTML).toBe(svg.innerHTML)
})
test('should render draggable prop', async () => {
const wrapper = mount(
<Dialog modelValue={true} draggable={true}>
{AXIOM}
</Dialog>
)
await nextTick()
await rAF()
await nextTick()
expect(wrapper.find('.is-draggable').exists()).toBe(true)
})
})
describe('accessibility', () => {
test('title attribute should set aria-label', async () => {
const title = 'Hello World'
const wrapper = mount(
<Dialog modelValue={true} title={title}>
{AXIOM}
</Dialog>
)
await nextTick()
const dialog = wrapper.find('[role="dialog"]')
expect(dialog.attributes()['aria-label']).toBe(title)
expect(dialog.attributes()['aria-labelledby']).toBeFalsy()
})
test('missing title attribute should point to header slot content', async () => {
const wrapper = mount(
<Dialog
modelValue={true}
v-slots={{
header: ({
titleId,
titleClass,
}: {
titleId: string
titleClass: string
}) => <h5 id={titleId} class={titleClass} />,
}}
>
{AXIOM}
</Dialog>
)
await nextTick()
const dialog = wrapper.find('[role="dialog"]')
const dialogTitle = wrapper.find('.el-dialog__title')
expect(dialog.attributes()['aria-label']).toBeFalsy()
expect(dialog.attributes()['aria-labelledby']).toBe(
dialogTitle.attributes().id
)
})
test('aria-describedby should point to modal body', async () => {
const wrapper = mount(<Dialog modelValue={true}>{AXIOM}</Dialog>)
await nextTick()
const dialog = wrapper.find('[role="dialog"]')
const dialogBody = wrapper.find('.el-dialog__body')
expect(dialog.attributes()['aria-describedby']).toBe(
dialogBody.attributes().id
)
})
})
})