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

69 lines
1.6 KiB
JavaScript

const AvatarProps = [
{
name: 'label',
type: 'string',
default: 'null',
description: 'Defines the text to display.'
},
{
name: 'icon',
type: 'string',
default: 'null',
description: 'Defines the icon to display.'
},
{
name: 'image',
type: 'string',
default: 'null',
description: 'Defines the image to display.'
},
{
name: 'size',
type: 'string',
default: 'null',
description: 'Size of the element, valid options are "large" and "xlarge".'
},
{
name: 'shape',
type: 'string',
default: 'square',
description: 'Shape of the element, valid options are "square" and "circle".'
},
{
name: 'pt',
type: 'any',
default: 'null',
description: 'Uses to pass attributes to DOM elements inside the component.'
},
{
name: 'unstyled',
type: 'boolean',
default: 'false',
description: 'When enabled, it removes component related styles in the core.'
}
];
const AvatarSlots = [
{
name: 'icon',
description: 'Custom icon template.'
}
];
const AvatarEvents = [
{
name: 'error',
description: 'Triggered when an error occurs while loading an image file.'
}
];
module.exports = {
avatar: {
name: 'Avatar',
description: 'Avatar represents people using icons, labels and images.',
props: AvatarProps,
slots: AvatarSlots,
events: AvatarEvents
}
};