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

67 lines
1.7 KiB
JavaScript
Raw Normal View History

const TimelineProps = [
{
2022-09-14 14:26:41 +00:00
name: 'value',
type: 'array',
default: 'null',
description: 'An array of events to display.'
},
{
2022-09-14 14:26:41 +00:00
name: 'align',
type: 'string',
default: 'left',
description: 'Position of the timeline bar relative to the content. Valid values are "left", "right" and "alternate" for vertical layout and "top", "bottom" for horizontal layout.'
},
{
2022-09-14 14:26:41 +00:00
name: 'layout',
type: 'string',
default: 'vertical',
description: 'Orientation of the timeline, valid values are "vertical" and "horizontal".'
},
{
2022-09-14 14:26:41 +00:00
name: 'dataKey',
type: 'string',
default: 'null',
description: 'Name of the field that uniquely identifies the a record in the data.'
2023-05-10 07:28:34 +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 TimelineSlots = [
{
2022-09-14 14:26:41 +00:00
name: 'opposite',
description: 'Custom content for the content to be placed at the other side of the bar'
},
{
2022-09-14 14:26:41 +00:00
name: 'marker',
description: 'Custom content for the marker'
},
{
2022-09-14 14:26:41 +00:00
name: 'content',
description: 'Custom content'
},
{
2022-09-14 14:26:41 +00:00
name: 'connector',
description: 'Connector element'
}
];
module.exports = {
timeline: {
2022-09-14 14:26:41 +00:00
name: 'Timeline',
description: 'Timeline visualizes a series of chained events.',
props: TimelineProps,
slots: TimelineSlots
}
};