primevue-mirror/apps/showcase/api-generator/components/message.js

94 lines
2.3 KiB
JavaScript
Raw Normal View History

const MessageProps = [
{
2022-09-14 14:26:41 +00:00
name: 'severity',
type: 'string',
default: 'info',
description: 'Severity level of the message. Valid severities are "success", "info", "warn", "error", "secondary" and "contrast".'
},
{
2022-09-14 14:26:41 +00:00
name: 'closable',
type: 'boolean',
default: 'true',
description: 'Whether the message can be closed manually using the close icon.'
},
{
2022-09-14 14:26:41 +00:00
name: 'sticky',
type: 'boolean',
default: 'null',
description: 'When enabled, message is not removed automatically.'
},
{
2022-09-14 14:26:41 +00:00
name: 'life',
type: 'number',
default: '300',
description: 'Delay in milliseconds to close the message automatically.'
},
{
2022-09-14 14:26:41 +00:00
name: 'icon',
type: 'string',
default: 'undefined',
2022-09-14 14:26:41 +00:00
description: 'Display a custom icon for the message.'
},
{
name: 'closeIcon',
type: 'string',
default: 'undefined',
description: 'Display a custom close icon for the message.'
2023-04-28 11:56:49 +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 MessageSlots = [
{
name: 'messageicon',
description: 'Custom message icon template.'
},
{
name: 'closeicon',
description: 'Custom close icon template.'
2023-09-19 11:22:25 +00:00
},
{
name: 'container',
description: 'Custom container template.'
}
];
const MessageEvents = [
{
2022-09-14 14:26:41 +00:00
name: 'close',
description: 'Callback to invoke when a message is closed.',
arguments: [
{
2022-09-14 14:26:41 +00:00
name: 'event',
type: 'object',
description: 'Browser event'
}
]
2024-01-18 06:44:22 +00:00
},
{
name: 'life-end',
description: "Callback to invoke when the message's timeout is over."
}
];
module.exports = {
message: {
2022-09-14 14:26:41 +00:00
name: 'Message',
description: 'Messages is used to display inline messages with various severities.',
props: MessageProps,
slots: MessageSlots,
events: MessageEvents
}
};