nly-adminlte-vue
Version:
nly adminlte3 components
145 lines (144 loc) • 5.33 kB
JSON
{
"name": "@nly-adminlte-vue/overlay",
"version": "0.6.5",
"meta": {
"title": "Overlay",
"version": "0.5.6",
"subtitle": "罩层",
"new": true,
"description": "nly-overlay 用来在视觉上挡住和遮住组件或元素,用来展示组件或者元素的一种状态,比如创建,更新,加载,警告等等",
"components": [
{
"component": "NlyOverlay",
"version": "0.6.5",
"props": [
{
"prop": "sidebar",
"description": "设置为true,作为左侧菜单的罩层,会自动添加一个 id=sidebar-overlay 属性,当绑定指令 v-nly-sidebar-collapse之后,点击罩层会关闭左侧导航"
},
{
"prop": "custom",
"description": "作为其他组件的自带背景罩层"
},
{
"prop": "dark",
"description": "作为其他组件的自带背景罩层时罩层颜色"
},
{
"prop": "show",
"description": "设置 true 显示罩层"
},
{
"prop": "variant",
"description": "罩层背景颜色, 可以是 `bg-*` 类和 `bg-gradient-*` 类,比如 variant='pink', varaint='gradient-pink' 。可选primary, secondary, success, info, warning, danger, light, dark, lightblue, navy, olive, lime, fuchsia, maroon, blue, indigo, purple, pink, red, orange, yellow, green, teal, cyan, white, gray, graydark"
},
{
"prop": "bgColor",
"description": "罩层背景色, css 属性,会覆盖 `variant` prop"
},
{
"prop": "opacity",
"description": "透明度,可以设置 `0` 到 `1`"
},
{
"prop": "blur",
"description": "背景模糊度值"
},
{
"prop": "noFade",
"description": "禁用罩层动画"
},
{
"prop": "rounded",
"description": "是的罩层自适应包裹元素的形状,大小.可选 `true`, `'sm'`, `lg`, `circle`, `pill`, `top`, `right`, `bottom`, `left`"
},
{
"prop": "noCenter",
"description": "设置true, 使罩层中 spinner 等元素不居中显示"
},
{
"prop": "overlayTag",
"description": "罩层标签"
},
{
"prop": "noWrap",
"description": "不渲染成 wrapper 容器元素,即罩层不会包裹其他元素和组件,也就是不会渲染默认插槽中的元素和组件 , `<nly-overlay>` 会渲染成 position relative 元素"
},
{
"prop": "fixed",
"description": "如果设置了 `no-wrap` prop 为 true, 设置 `fixed` 为 true, 会渲染成 fixed positioning 元素"
},
{
"prop": "wrapTag",
"description": "渲染成 wrapper 容器元素,即罩层会包裹其他元素和组件,也就是会渲染默认插槽中的元素和组件, 如果设置了 `no-wrap` prop 为 true 会失效"
},
{
"prop": "zIndex",
"description": "Z-index 属性"
},
{
"prop": "spinnerType",
"description": "spinner 类型, 可选 'border' and 'grow'"
},
{
"prop": "spinnerVariant",
"description": "spinner 主题颜色. 详情请查看 `nly-spinner` 组件"
},
{
"prop": "spinnerSmall",
"description": "设置 true, spinner 会渲染成小型 spinner"
}
],
"events": [
{
"event": "click",
"version": "0.6.7",
"description": "Emitted when overlay is clicked",
"args": [
{
"arg": "event",
"type": "MouseEvent",
"description": "Native click event object"
}
]
},
{
"event": "shown",
"description": "Emitted when the overlay has been shown"
},
{
"event": "hidden",
"description": "Emitted when the overlay has been hidden"
}
],
"slots": [
{
"name": "overlay",
"description": "Custom content to replace the default overlay spinner",
"scope": [
{
"prop": "spinnerType",
"type": "String",
"description": ""
},
{
"prop": "spinnerVariant",
"type": "String",
"description": ""
},
{
"prop": "spinnerSmall",
"type": "Boolean",
"description": ""
}
]
},
{
"name": "default",
"description": "The content to be overlayed. The default slot is ignored if the prop `no-wrap` is set"
}
]
}
]
}
}