forked from opentiny/tiny-vue
[drawer]: fixed docs bug of drawer. (#1201)
* fix(docs): fixed some bugs of demo * fix(steps): Optimized steps docs * fix(timeline): [time-line] Optimized timeline api docs * fix(tree-menu): [tree-menu] Optimized treeMenu docs * fix(tree-menu): [tree-menu] ellipse props did not work * fix(time-line): [time-line] fixed time-field props can't link to demo * docs(drawer): [drawer] Optimized drawer api and demo docs. * test(drawer): [drawer] fix e2e case
This commit is contained in:
parent
8de710fccf
commit
9fef12173e
|
@ -28,6 +28,6 @@ function fn() {
|
||||||
}
|
}
|
||||||
|
|
||||||
function confirm() {
|
function confirm() {
|
||||||
Modal.message('确认事件')
|
Modal.message({ message: '确认事件', status: 'info' })
|
||||||
}
|
}
|
||||||
</script>
|
</script>
|
||||||
|
|
|
@ -35,7 +35,7 @@ export default {
|
||||||
this.visible = true
|
this.visible = true
|
||||||
},
|
},
|
||||||
confirm() {
|
confirm() {
|
||||||
Modal.message('确认事件')
|
Modal.message({ message: '确认事件', status: 'info' })
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,4 +4,4 @@ title: Drawer 抽屉
|
||||||
|
|
||||||
# Drawer 抽屉
|
# Drawer 抽屉
|
||||||
|
|
||||||
<div></div>
|
<div>从页面侧边弹出的内容容器。</div>
|
||||||
|
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Drawer
|
||||||
|
---
|
||||||
|
|
||||||
|
# Drawer
|
||||||
|
|
||||||
|
<div>The content container that pops out from the side of the page.</div>
|
|
@ -5,15 +5,14 @@ export default {
|
||||||
{
|
{
|
||||||
'demoId': 'basic-usage',
|
'demoId': 'basic-usage',
|
||||||
'name': { 'zh-CN': '基本用法', 'en-US': '' },
|
'name': { 'zh-CN': '基本用法', 'en-US': '' },
|
||||||
'desc': { 'zh-CN': '<p>详细用法参考如下示例</p>', 'en-US': '' },
|
'desc': { 'zh-CN': '<p>详细用法参考如下示例。</p>', 'en-US': '' },
|
||||||
'codeFiles': ['basic-usage.vue']
|
'codeFiles': ['basic-usage.vue']
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'demoId': 'placement',
|
'demoId': 'placement',
|
||||||
'name': { 'zh-CN': '抽屉方向', 'en-US': '' },
|
'name': { 'zh-CN': '抽屉方向', 'en-US': '' },
|
||||||
'desc': {
|
'desc': {
|
||||||
'zh-CN':
|
'zh-CN': `<p>添加 <code>placement</code> 属性设置抽屉的方向,可选值有 <code>'left' | 'right' | 'top' | 'bottom'</code>,默认值为 <code>'right'</code>。</p>`,
|
||||||
'<p>添加 <code>placement</code> 属性设置抽屉的方向,可选值有 <code>left | right | top | bottom</code>,默认值为 <code>right</code>。</p>',
|
|
||||||
'en-US': ''
|
'en-US': ''
|
||||||
},
|
},
|
||||||
'codeFiles': ['placement.vue']
|
'codeFiles': ['placement.vue']
|
||||||
|
@ -21,7 +20,10 @@ export default {
|
||||||
{
|
{
|
||||||
'demoId': 'width',
|
'demoId': 'width',
|
||||||
'name': { 'zh-CN': '抽屉宽度', 'en-US': '' },
|
'name': { 'zh-CN': '抽屉宽度', 'en-US': '' },
|
||||||
'desc': { 'zh-CN': '<p>添加<code>width</code> 属性设置抽屉的宽度,默认值为 <code>500px</code></p>', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '<p>添加<code>width</code> 属性设置抽屉的宽度,默认值为 <code>500px</code>。</p>',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'codeFiles': ['width.vue']
|
'codeFiles': ['width.vue']
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
@ -83,7 +85,7 @@ export default {
|
||||||
{
|
{
|
||||||
'demoId': 'default-slot',
|
'demoId': 'default-slot',
|
||||||
'name': { 'zh-CN': '默认插槽', 'en-US': '' },
|
'name': { 'zh-CN': '默认插槽', 'en-US': '' },
|
||||||
'desc': { 'zh-CN': '<p>自定义抽屉主体内容</p>', 'en-US': '' },
|
'desc': { 'zh-CN': '<p>自定义抽屉主体内容。</p>', 'en-US': '' },
|
||||||
'codeFiles': ['default-slot.vue']
|
'codeFiles': ['default-slot.vue']
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
@ -128,39 +130,24 @@ export default {
|
||||||
'name': 'drawer',
|
'name': 'drawer',
|
||||||
'type': 'component',
|
'type': 'component',
|
||||||
'props': [
|
'props': [
|
||||||
{
|
|
||||||
'name': 'visible',
|
|
||||||
'type': 'boolean',
|
|
||||||
'defaultValue': '',
|
|
||||||
'desc': { 'zh-CN': '控制抽屉显示与关闭', 'en-US': '' },
|
|
||||||
'demoId': 'basic-usage'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
'name': 'placement',
|
|
||||||
'type': `'left' | 'right' | 'top' | 'bottom' `,
|
|
||||||
'defaultValue': 'right',
|
|
||||||
'desc': { 'zh-CN': '添加 placement 属性设置抽屉的方向', 'en-US': '' },
|
|
||||||
'demoId': 'placement'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
'name': 'width',
|
|
||||||
'type': 'string',
|
|
||||||
'defaultValue': '500px',
|
|
||||||
'desc': { 'zh-CN': '设置抽屉的宽度', 'en-US': '' },
|
|
||||||
'demoId': 'width'
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
'name': 'dragable',
|
'name': 'dragable',
|
||||||
'type': 'boolean',
|
'type': 'boolean',
|
||||||
'defaultValue': 'false',
|
'defaultValue': 'false',
|
||||||
'desc': { 'zh-CN': '控制抽屉开启或关闭宽度拖拽功能', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '控制抽屉开启或关闭宽度拖拽功能',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'dragable'
|
'demoId': 'dragable'
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'mask',
|
'name': 'mask',
|
||||||
'type': 'boolean',
|
'type': 'boolean',
|
||||||
'defaultValue': 'true',
|
'defaultValue': 'true',
|
||||||
'desc': { 'zh-CN': '控制遮罩层显示隐藏 ', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '控制遮罩层显示隐藏 ',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'mask'
|
'demoId': 'mask'
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
@ -173,32 +160,74 @@ export default {
|
||||||
},
|
},
|
||||||
'demoId': 'mask-closable'
|
'demoId': 'mask-closable'
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
'name': 'placement',
|
||||||
|
'type': "'left' | 'right' | 'top' | 'bottom' ",
|
||||||
|
'defaultValue': "'right'",
|
||||||
|
'desc': {
|
||||||
|
'zh-CN': '添加 placement 属性设置抽屉的方向',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
|
'demoId': 'placement'
|
||||||
|
},
|
||||||
{
|
{
|
||||||
'name': 'show-close',
|
'name': 'show-close',
|
||||||
'type': 'boolean',
|
'type': 'boolean',
|
||||||
'defaultValue': 'true',
|
'defaultValue': 'true',
|
||||||
'desc': { 'zh-CN': '控制关闭图标显示', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '控制关闭图标显示',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'show-close'
|
'demoId': 'show-close'
|
||||||
},
|
},
|
||||||
{
|
|
||||||
'name': 'show-header',
|
|
||||||
'type': 'boolean',
|
|
||||||
'defaultValue': 'true',
|
|
||||||
'desc': { 'zh-CN': '控制头部显示', 'en-US': '' },
|
|
||||||
'demoId': 'show-header'
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
'name': 'show-footer',
|
'name': 'show-footer',
|
||||||
'type': 'boolean',
|
'type': 'boolean',
|
||||||
'defaultValue': 'false',
|
'defaultValue': 'false',
|
||||||
'desc': { 'zh-CN': '控制底部显示', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '控制底部显示',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'show-footer'
|
'demoId': 'show-footer'
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
'name': 'show-header',
|
||||||
|
'type': 'boolean',
|
||||||
|
'defaultValue': 'true',
|
||||||
|
'desc': {
|
||||||
|
'zh-CN': '控制头部显示',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
|
'demoId': 'show-header'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'name': 'visible',
|
||||||
|
'type': 'boolean',
|
||||||
|
'defaultValue': '',
|
||||||
|
'desc': {
|
||||||
|
'zh-CN': '控制抽屉显示与关闭',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
|
'demoId': 'basic-usage'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'name': 'width',
|
||||||
|
'type': 'string',
|
||||||
|
'defaultValue': "'500px'",
|
||||||
|
'desc': {
|
||||||
|
'zh-CN': '设置抽屉的宽度',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
|
'demoId': 'width'
|
||||||
|
},
|
||||||
{
|
{
|
||||||
'name': 'z-index',
|
'name': 'z-index',
|
||||||
'type': 'number',
|
'type': 'number',
|
||||||
'defaultValue': '2000',
|
'defaultValue': '2000',
|
||||||
'desc': { 'zh-CN': '自定义堆叠顺序(对于某些特殊场景,比如被遮挡时可能会用到)', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '自定义堆叠顺序(对于某些特殊场景,比如被遮挡时可能会用到)',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'z-index'
|
'demoId': 'z-index'
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
@ -207,14 +236,20 @@ export default {
|
||||||
'name': 'close',
|
'name': 'close',
|
||||||
'type': '()=> void',
|
'type': '()=> void',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': { 'zh-CN': '关闭抽屉事件', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '关闭抽屉事件',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'close-event'
|
'demoId': 'close-event'
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'confirm',
|
'name': 'confirm',
|
||||||
'type': '()=> void',
|
'type': '()=> void',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': { 'zh-CN': '确认事件,设置 :show-footer="true" 时有效', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '确认事件,设置 :show-footer="true" 时有效',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'confirm-event'
|
'demoId': 'confirm-event'
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
@ -223,29 +258,41 @@ export default {
|
||||||
'name': 'default',
|
'name': 'default',
|
||||||
'type': '--',
|
'type': '--',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': { 'zh-CN': '默认插槽', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '默认插槽',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'default-slot'
|
'demoId': 'default-slot'
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
'name': 'footer',
|
||||||
|
'type': '--',
|
||||||
|
'defaultValue': '',
|
||||||
|
'desc': {
|
||||||
|
'zh-CN': '底部插槽',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
|
'demoId': 'footer-slot'
|
||||||
|
},
|
||||||
{
|
{
|
||||||
'name': 'header',
|
'name': 'header',
|
||||||
'type': '--',
|
'type': '--',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': { 'zh-CN': '头部插槽', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '头部插槽',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'header-slot'
|
'demoId': 'header-slot'
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
'name': 'header-right',
|
'name': 'header-right',
|
||||||
'type': '--',
|
'type': '--',
|
||||||
'defaultValue': '',
|
'defaultValue': '',
|
||||||
'desc': { 'zh-CN': '头部右侧插槽', 'en-US': '' },
|
'desc': {
|
||||||
|
'zh-CN': '头部右侧插槽',
|
||||||
|
'en-US': ''
|
||||||
|
},
|
||||||
'demoId': 'header-right-slot'
|
'demoId': 'header-right-slot'
|
||||||
},
|
|
||||||
{
|
|
||||||
'name': 'footer',
|
|
||||||
'type': '--',
|
|
||||||
'defaultValue': '',
|
|
||||||
'desc': { 'zh-CN': '底部插槽', 'en-US': '' },
|
|
||||||
'demoId': 'footer-slot'
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
<template>
|
<template>
|
||||||
<div>
|
<div>
|
||||||
<tiny-button @click="fn" type="primary"> 自定义z-index </tiny-button>
|
<tiny-button @click="fn" type="primary"> 自定义 z-index </tiny-button>
|
||||||
<tiny-drawer title="标题" :visible="visible" @update:visible="visible = $event" :z-index="zIndex">
|
<tiny-drawer title="标题" :visible="visible" @update:visible="visible = $event" :z-index="zIndex">
|
||||||
<div>
|
<div>
|
||||||
<br />
|
<br />
|
||||||
|
|
|
@ -5,6 +5,6 @@ test('自定义堆叠顺序', async ({ page }) => {
|
||||||
await page.goto('drawer#z-index')
|
await page.goto('drawer#z-index')
|
||||||
|
|
||||||
const drawer = page.locator('.tiny-drawer__main')
|
const drawer = page.locator('.tiny-drawer__main')
|
||||||
await page.getByRole('button', { name: '自定义z-index' }).click()
|
await page.getByRole('button', { name: '自定义 z-index' }).click()
|
||||||
await expect(drawer).toHaveCSS('z-index', '3000')
|
await expect(drawer).toHaveCSS('z-index', '3000')
|
||||||
})
|
})
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
<template>
|
<template>
|
||||||
<div>
|
<div>
|
||||||
<tiny-button @click="fn" type="primary"> 自定义z-index </tiny-button>
|
<tiny-button @click="fn" type="primary"> 自定义 z-index </tiny-button>
|
||||||
<tiny-drawer title="标题" :visible="visible" @update:visible="visible = $event" :z-index="zIndex">
|
<tiny-drawer title="标题" :visible="visible" @update:visible="visible = $event" :z-index="zIndex">
|
||||||
<div>
|
<div>
|
||||||
<br />
|
<br />
|
||||||
|
|
Loading…
Reference in New Issue