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

91 lines
2.2 KiB
JavaScript
Raw Normal View History

const MenuProps = [
{
2022-09-14 14:26:41 +00:00
name: 'modelValue',
type: 'array',
default: 'null',
description: 'An array of menuitems.'
},
{
2022-09-14 14:26:41 +00:00
name: 'popup',
type: 'boolean',
default: 'false',
description: 'Defines if menu would displayed as a popup.'
},
{
2022-09-14 14:26:41 +00:00
name: 'appendTo',
type: 'string',
default: 'body',
description: 'A valid query selector or an HTMLElement to specify where the overlay gets attached.'
},
{
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: 'exact',
type: 'boolean',
default: 'true',
description: "Whether to apply 'router-link-active-exact' class if route exactly matches the item path."
2023-04-26 09:58:05 +00:00
},
{
name: 'pt',
type: 'any',
default: 'null',
description: 'Uses to pass attributes to DOM elements inside the component.'
2023-07-06 13:20:37 +00:00
},
{
name: 'unstyled',
type: 'boolean',
default: 'false',
description: 'When enabled, it removes component related styles in the core.'
}
];
const MenuEvents = [
{
2022-09-14 14:26:41 +00:00
name: 'show',
description: 'Callback to invoke when the overlay is shown.'
},
{
2022-09-14 14:26:41 +00:00
name: 'hide',
description: 'Callback to invoke when the overlay is hidden.'
}
];
const MenuSlots = [
{
name: 'start',
description: 'Custom content before the content'
},
{
name: 'end',
description: 'Custom content after the content'
},
{
2022-09-14 14:26:41 +00:00
name: 'item',
description: 'Template of a menuitem.'
},
{
name: 'itemicon',
description: 'Custom item icon template.'
}
];
module.exports = {
menu: {
2022-09-14 14:26:41 +00:00
name: 'Menu',
description: 'Menu is a navigation / command component that supports dynamic and static positioning.',
props: MenuProps,
events: MenuEvents,
slots: MenuSlots
}
};