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

79 lines
1.9 KiB
JavaScript
Raw Normal View History

const SidebarProps = [
{
2022-09-14 14:26:41 +00:00
name: 'visible',
type: 'boolean',
default: 'false',
description: 'Specifies the visibility of the dialog.'
},
{
2022-09-14 14:26:41 +00:00
name: 'position',
type: 'string',
default: 'left',
description: 'Specifies the position of the sidebar, valid values are "left", "right", "top", "bottom" and "full".'
},
{
2022-09-14 14:26:41 +00:00
name: 'baseZIndex',
type: 'number',
default: '0',
description: 'Base zIndex value to use in layering.'
},
{
2022-09-14 14:26:41 +00:00
name: 'autoZIndex',
type: 'boolean',
default: 'true',
description: 'Whether to automatically manage layering.'
},
{
2022-09-14 14:26:41 +00:00
name: 'dismissable',
type: 'boolean',
default: 'true',
description: 'Whether clicking outside closes the panel.'
},
{
2022-09-14 14:26:41 +00:00
name: 'showCloseIcon',
type: 'boolean',
default: 'true',
description: 'Whether to display a close icon inside the panel.'
},
{
2022-09-14 14:26:41 +00:00
name: 'modal',
type: 'boolean',
default: 'true',
description: 'Whether to a modal layer behind the sidebar.'
},
{
2022-09-14 14:26:41 +00:00
name: 'ariaCloseLabel',
type: 'string',
default: 'close',
description: 'Aria label of the close icon.'
}
];
const SidebarEvents = [
{
2022-09-14 14:26:41 +00:00
name: 'hide',
description: 'Callback to invoke when sidebar gets hidden.'
},
{
2022-09-14 14:26:41 +00:00
name: 'show',
description: 'Callback to invoke when sidebar gets shown.'
}
];
const SidebarSlots = [
{
2022-09-14 14:26:41 +00:00
name: 'header',
description: 'Custom content for the component header.'
}
];
module.exports = {
sidebar: {
2022-09-14 14:26:41 +00:00
name: 'Sidebar',
description: 'Sidebar is a panel component displayed as an overlay at the edges of the screen.',
props: SidebarProps,
events: SidebarEvents,
slots: SidebarSlots
}
};