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

87 lines
2.1 KiB
JavaScript
Raw Permalink Normal View History

const PanelProps = [
{
2022-09-14 14:26:41 +00:00
name: 'header',
type: 'string',
default: 'null',
description: 'Header text of the panel.'
},
{
2022-09-14 14:26:41 +00:00
name: 'toggleable',
type: 'boolean',
default: 'null',
description: 'Defines if content of panel can be expanded and collapsed.'
},
{
2022-09-14 14:26:41 +00:00
name: 'collapsed',
type: 'boolean',
default: 'null',
description: 'Defines the initial state of panel content.'
},
{
2022-09-14 14:26:41 +00:00
name: 'toggleButtonProps',
type: 'string',
default: 'null',
2023-08-01 14:01:12 +00:00
description: 'Used to pass the custom value to read for the anchor inside the component.'
2023-03-24 12:37:26 +00:00
},
{
name: 'pt',
type: 'any',
default: 'null',
2023-08-01 14:01:12 +00:00
description: 'Used 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 PanelEvents = [
{
2022-09-14 14:26:41 +00:00
name: 'toggle',
description: 'Callback to invoke when a tab toggle.',
arguments: [
{
2022-09-14 14:26:41 +00:00
name: 'event.originalEvent',
type: 'object',
description: 'Browser event'
},
{
2022-09-14 14:26:41 +00:00
name: 'event.value',
type: 'boolean',
description: 'collapsed state as a boolean'
}
]
}
];
const PanelSlots = [
{
2022-09-14 14:26:41 +00:00
name: 'header',
2023-03-31 13:42:19 +00:00
description: "Custom content for the component's header."
},
{
2022-09-14 14:26:41 +00:00
name: 'icons',
2023-03-31 13:42:19 +00:00
description: "Custom content for the header's icon."
2023-03-24 12:37:26 +00:00
},
{
2023-04-05 08:07:25 +00:00
name: 'togglericon',
description: "Custom content for the component's toggler icon."
2023-03-31 13:42:19 +00:00
},
{
2023-03-31 13:44:33 +00:00
name: 'footer',
2023-03-31 13:42:19 +00:00
description: "Custom content for the component's footer."
2023-03-31 13:43:48 +00:00
}
];
module.exports = {
panel: {
2022-09-14 14:26:41 +00:00
name: 'Panel',
description: 'Panel is a container with the optional content toggle feature.',
props: PanelProps,
events: PanelEvents,
slots: PanelSlots
}
};