171 lines
3.9 KiB
TypeScript
171 lines
3.9 KiB
TypeScript
/**
|
|
*
|
|
* Timeline visualizes a series of chained events.
|
|
*
|
|
* [Live Demo](https://primevue.org/timeline)
|
|
*
|
|
* @module timeline
|
|
*/
|
|
import { VNode } from 'vue';
|
|
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
|
|
|
export declare type TimelinePassThroughOptionType = TimelinePassThroughAttributes | null | undefined;
|
|
|
|
/**
|
|
* Custom passthrough(pt) options.
|
|
* @see {@link TimelineProps.pt}
|
|
*/
|
|
export interface TimelinePassThroughOptions {
|
|
/**
|
|
* Uses to pass attributes to the root's DOM element.
|
|
*/
|
|
root?: TimelinePassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the event's DOM element.
|
|
*/
|
|
event?: TimelinePassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the opposite's DOM element.
|
|
*/
|
|
opposite?: TimelinePassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the separator's DOM element.
|
|
*/
|
|
separator?: TimelinePassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the marker's DOM element.
|
|
*/
|
|
marker?: TimelinePassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the connector's DOM element.
|
|
*/
|
|
connector?: TimelinePassThroughOptionType;
|
|
/**
|
|
* Uses to pass attributes to the content's DOM element.
|
|
*/
|
|
content?: TimelinePassThroughOptionType;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough attributes for each DOM elements
|
|
*/
|
|
export interface TimelinePassThroughAttributes {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in Timeline component.
|
|
*/
|
|
export interface TimelineProps {
|
|
/**
|
|
* An array of events to display.
|
|
*/
|
|
value?: any[] | undefined;
|
|
/**
|
|
* Position of the timeline bar relative to the content.
|
|
* @defaultValue left
|
|
*/
|
|
align?: 'left' | 'right' | 'alternate' | 'top' | 'bottom' | undefined;
|
|
/**
|
|
* Orientation of the timeline.
|
|
* @defaultValue horizontal
|
|
*/
|
|
layout?: 'vertical' | 'horizontal' | undefined;
|
|
/**
|
|
* Name of the field that uniquely identifies the a record in the data.
|
|
*/
|
|
dataKey?: string | undefined;
|
|
/**
|
|
* Uses to pass attributes to DOM elements inside the component.
|
|
* @type {TimelinePassThroughOptions}
|
|
*/
|
|
pt?: TimelinePassThroughOptions;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in Timeline component.
|
|
*/
|
|
export interface TimelineSlots {
|
|
/**
|
|
* Custom content template
|
|
* @param {Object} scope - content slot's params.
|
|
*/
|
|
content(scope: {
|
|
/**
|
|
* Item data
|
|
*/
|
|
item: any;
|
|
/**
|
|
* Index of item
|
|
*/
|
|
index: number;
|
|
}): VNode[];
|
|
/**
|
|
* Custom opposite template.
|
|
* @param {Object} scope - opposite slot's params.
|
|
*/
|
|
opposite(scope: {
|
|
/**
|
|
* Item data
|
|
*/
|
|
item: any;
|
|
/**
|
|
* Index of item
|
|
*/
|
|
index: number;
|
|
}): VNode[];
|
|
/**
|
|
* Custom marker template.
|
|
* @param {Object} scope - marker slot's params.
|
|
*/
|
|
marker(scope: {
|
|
/**
|
|
* Item data
|
|
*/
|
|
item: any;
|
|
/**
|
|
* Index of item
|
|
*/
|
|
index: number;
|
|
}): VNode[];
|
|
/**
|
|
* Custom connector template.
|
|
*/
|
|
connector(scope: {
|
|
/**
|
|
* Item data
|
|
*/
|
|
item: any;
|
|
/**
|
|
* Index of item
|
|
*/
|
|
index: number;
|
|
}): VNode[];
|
|
}
|
|
|
|
/**
|
|
* Defines valid emits in Timeline component.
|
|
*/
|
|
export interface TimelineEmits {}
|
|
|
|
/**
|
|
* **PrimeVue - Timeline**
|
|
*
|
|
* _Timeline visualizes a series of chained events._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/timeline/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*/
|
|
declare class Timeline extends ClassComponent<TimelineProps, TimelineSlots, TimelineEmits> {}
|
|
|
|
declare module '@vue/runtime-core' {
|
|
interface GlobalComponents {
|
|
Timeline: GlobalComponentConstructor<Timeline>;
|
|
}
|
|
}
|
|
|
|
export default Timeline;
|