Overlay Panel
Beta
OverlayPanel is a container component positioned as connected to its target.
#Setup
You can import a component and register it as a local and global vue component as follows:
// import the component
import LvOverlayPanel from 'lightvue/overlay-panel';
// Register the component locally
export default {
components: {
LvOverlayPanel
}
}// Register the component globally (Vue 2.x)
Vue.component('LvOverlayPanel', LvOverlayPanel);
// Register the component globally (Vue 3.x)
const app = Vue.createApp({
// ...
});
app.component('LvOverlayPanel', LvOverlayPanel);
app.mount('#app')
#APIs
All of the props, events and slots of the component are mentioned below:
Props
Type
Default
Description
dismissable
Boolean
true
Configures if the overplay panel is dismissible or not.
showCloseIcon
Boolean
false
Configures if the close icon needs to be displayed or not.
appendTo
String
Configures where to what overplay panel needs to be appended.
baseZIndex
Number
0
Configures the base Z index of overlay panel.
autoZindex
Boolean
true
Configures if the Z index should be auto or not.
ariaCloseLabel
String
close
Configures the close label.
alignRight
Boolean
false
Configures if the overlay panel should be aligned to right or not.
closeOnResize
Boolean
false
Configures if the overlay panel should be closed when resized.