primevue-mirror/api-generator/components/overlaypanel.js

65 lines
1.6 KiB
JavaScript
Raw Normal View History

const OverlayPanelProps = [
{
name: "dismissable",
type: "boolean",
default: "true",
description: "Enables to hide the overlay when outside is clicked."
},
{
name: "showCloseIcon",
type: "boolean",
default: "false",
description: "When enabled, displays a close icon at top right corner."
},
{
name: "appendTo",
type: "string",
default: "body",
description: "A valid query selector or an HTMLElement to specify where the overlay gets attached."
},
{
name: "baseZIndex",
type: "number",
default: "0",
description: "Base zIndex value to use in layering."
},
{
name: "autoZIndex",
type: "boolean",
default: "true",
description: "Whether to automatically manage layering."
},
{
name: "ariaCloseLabel",
type: "string",
default: "close",
description: "Aria label of the close icon."
},
{
name: "breakpoints",
type: "object",
default: "null",
description: "Object literal to define widths per screen size."
}
];
const OverlayPanelEvents = [
{
name: "show",
description: "Callback to invoke before the overlay is shown."
},
{
name: "hide",
description: "Callback to invoke before the overlay is hidden."
},
];
module.exports = {
overlaypanel: {
name: "OverlayPanel",
description: "OverlayPanel is a container component positioned as connected to its target.",
props: OverlayPanelProps,
events: OverlayPanelEvents
}
};