@ruc-lib/timeline 3.2.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,126 +0,0 @@
1
- /**
2
- *Interface for defining the Timeline Data
3
- */
4
- export interface RucTimelineItemData {
5
- /**
6
- * A unique identifier for the timeline item.
7
- */
8
- id: number;
9
- /**
10
- * The main title text for the timeline item.
11
- */
12
- title: string;
13
- /**
14
- * The subtitle text displayed below the title.
15
- */
16
- subtitle?: string;
17
- /**
18
- * The main content or description for the timeline item.
19
- */
20
- content?: string;
21
- /**
22
- * The name of the Material icon to be displayed for this item.
23
- */
24
- icon?: string;
25
- /**
26
- * ARIA label for the icon, providing accessibility information.
27
- */
28
- iconAriaLabel?: string;
29
- /**
30
- * URL of an image to be displayed within the timeline item's content.
31
- */
32
- imageUrl?: string;
33
- /**
34
- * Alt text for the image, used for accessibility.
35
- */
36
- imageAltText?: string;
37
- /**
38
- * Additional information text related to the title.
39
- */
40
- titleInfo?: string;
41
- /**
42
- * Additional information text related to the subtitle.
43
- */
44
- subTitleInfo?: string;
45
- /**
46
- * The name of the Material icon to be displayed next to the title info text.
47
- */
48
- iconTitle?: string;
49
- /**
50
- * The name of the Material icon to be displayed next to the subtitle info text.
51
- */
52
- iconSubTitle?: string;
53
- /**
54
- * The name of the Material icon for the title's info section, often used for a tooltip or popover.
55
- */
56
- titleInfoIcon?: string;
57
- /**
58
- * The name of the Material icon for the subtitle's info section, often used for a tooltip or popover.
59
- */
60
- subTitleInfoIcon?: string;
61
- }
62
- /**
63
- *Interface for defining the Timeline Property
64
- */
65
- export interface RucTimelineInput {
66
- /**
67
- * Specifies the layout orientation of the timeline.
68
- */
69
- layout?: 'vertical' | 'horizontal' | undefined;
70
- /**
71
- * Specifies the alignment of the timeline items relative to the line.
72
- */
73
- position?: 'left' | 'right' | 'top' | 'bottom' | 'alternate' | 'opposite';
74
- /**
75
- * The font color for the timeline item titles.
76
- */
77
- titleFontColor?: string | undefined;
78
- /**
79
- * The font color for the timeline item subtitles.
80
- */
81
- subTitleFontColor?: string | undefined;
82
- /**
83
- * The font size for the timeline item titles (e.g., '16px', '1.2em').
84
- */
85
- titleFontSize?: string | undefined;
86
- /**
87
- * The font size for the timeline item subtitles (e.g., '14px', '1em').
88
- */
89
- subTitleFontSize?: string | undefined;
90
- /**
91
- * The background color for the title area of a timeline item.
92
- */
93
- titleBackgroundColor?: string | undefined;
94
- /**
95
- * The background color for the subtitle area of a timeline item.
96
- */
97
- subTitleBackgroundColor?: string | undefined;
98
- /**
99
- * The color used to highlight an active or selected timeline item.
100
- */
101
- highlightColor?: string | undefined;
102
- /**
103
- * The theme color for the timeline item icons.
104
- */
105
- iconColor?: 'primary' | 'accent' | 'warn';
106
- /**
107
- * Maximum number of characters to display for the title before truncating.
108
- */
109
- maxTitleLength?: number;
110
- /**
111
- * Maximum number of characters to display for the subtitle before truncating.
112
- */
113
- maxSubTitleLength?: number;
114
- /**
115
- * A flag to determine if the additional info sections for title and subtitle should be displayed.
116
- */
117
- isInfo?: boolean | undefined;
118
- /**
119
- * A flag to indicate whether a custom template is being used for the timeline items instead of the default structure.
120
- */
121
- isTemplate?: boolean | undefined;
122
- /**
123
- * The array of data objects that represent the items in the timeline.
124
- */
125
- data?: RucTimelineItemData[];
126
- }