tiny-vue/examples/sites/demos/apis/fullscreen.js

128 lines
3.9 KiB
JavaScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

export default {
mode: ['pc'],
apis: [
{
name: 'fullscreen',
type: 'component',
props: [
{
name: 'exit-on-click-wrapper',
type: 'boolean',
defaultValue: '',
desc: {
'zh-CN': '组件式使用时,点击组件 wrapper 是否关闭全屏显示。默认为 true',
'en-US':
'When the component is used in component mode, click the component wrapper to determine whether to disable full-screen display. The default value is true.'
},
mode: ['pc'],
pcDemo: ''
},
{
name: 'fullscreen',
type: 'boolean',
defaultValue: '',
desc: {
'zh-CN': '组件式使用时,控制组件是否全屏显示。默认为 false',
'en-US': 'Whether to display a component in full screen mode. The default value is false'
},
mode: ['pc'],
pcDemo: 'example-component'
},
{
name: 'fullscreen-class',
type: 'string',
defaultValue: '',
desc: {
'zh-CN': '自定义组件 wrapper 的样式类名',
'en-US': 'Style class name of the custom component wrapper'
},
mode: ['pc'],
pcDemo: ''
},
{
name: 'page-only',
type: 'boolean',
defaultValue: '',
desc: {
'zh-CN': '显示模式。true 为网页全屏false 为浏览器全屏。默认值为 false',
'en-US':
'Display mode. The value true indicates that the web page is displayed in full screen mode, and the value false indicates that the browser is displayed in full screen mode. The default value is false'
},
mode: ['pc'],
pcDemo: 'example-component'
},
{
name: 'teleport',
type: 'boolean',
defaultValue: '',
desc: {
'zh-CN': '是否将目标元素移动到 body 下。true 为移动false 为不移动。默认值为 false',
'en-US':
'Indicates whether to move the target element to the body. true: move; false: do not move. The default value is false'
},
mode: ['pc'],
pcDemo: 'example-component'
},
{
name: 'z-index',
type: 'number',
defaultValue: '',
desc: {
'zh-CN': '在全屏显示时,目标元素的 zIndex',
'en-US': 'ZIndex of the target element in full-screen display'
},
mode: ['pc'],
pcDemo: 'example-component'
}
],
events: [
{
name: 'before-change',
type: '(done: () => void) => void',
defaultValue: '',
desc: {
'zh-CN': '拦截事件',
'en-US': 'Intercept Events.'
},
mode: ['pc'],
pcDemo: 'before-change'
},
{
name: 'update:fullscreen',
defaultValue: '',
desc: {
'zh-CN': '组件式使用时,更新 fullscreen 属性',
'en-US': 'Update the fullscreen attribute in component mode.'
},
mode: ['pc'],
pcDemo: 'example-component'
}
],
methods: [
{
name: 'toggle',
defaultValue: '',
desc: {
'zh-CN': '函数式使用时,切换全屏模式',
'en-US': 'Switch the full-screen mode when the function mode is used.'
},
mode: ['pc'],
pcDemo: 'example-api'
}
],
slots: [
{
name: 'default',
defaultValue: '',
desc: {
'zh-CN': '自定义内容,需要在 layout 中列出 slot',
'en-US': 'User-defined content. Slots must be listed in the layout.'
},
mode: ['pc'],
pcDemo: 'example-component'
}
]
}
]
}