@ruc-lib/timeline 3.1.0 → 3.2.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.
package/index.d.ts CHANGED
@@ -1,239 +1,2 @@
1
- import * as i0 from '@angular/core';
2
-
3
- /**
4
- *Interface for defining the Timeline Data
5
- */
6
- interface RucTimelineItemData {
7
- /**
8
- * A unique identifier for the timeline item.
9
- */
10
- id: number;
11
- /**
12
- * The main title text for the timeline item.
13
- */
14
- title: string;
15
- /**
16
- * The subtitle text displayed below the title.
17
- */
18
- subtitle?: string;
19
- /**
20
- * The main content or description for the timeline item.
21
- */
22
- content?: string;
23
- /**
24
- * The name of the Material icon to be displayed for this item.
25
- */
26
- icon?: string;
27
- /**
28
- * ARIA label for the icon, providing accessibility information.
29
- */
30
- iconAriaLabel?: string;
31
- /**
32
- * URL of an image to be displayed within the timeline item's content.
33
- */
34
- imageUrl?: string;
35
- /**
36
- * Alt text for the image, used for accessibility.
37
- */
38
- imageAltText?: string;
39
- /**
40
- * Additional information text related to the title.
41
- */
42
- titleInfo?: string;
43
- /**
44
- * Additional information text related to the subtitle.
45
- */
46
- subTitleInfo?: string;
47
- /**
48
- * The name of the Material icon to be displayed next to the title info text.
49
- */
50
- iconTitle?: string;
51
- /**
52
- * The name of the Material icon to be displayed next to the subtitle info text.
53
- */
54
- iconSubTitle?: string;
55
- /**
56
- * The name of the Material icon for the title's info section, often used for a tooltip or popover.
57
- */
58
- titleInfoIcon?: string;
59
- /**
60
- * The name of the Material icon for the subtitle's info section, often used for a tooltip or popover.
61
- */
62
- subTitleInfoIcon?: string;
63
- }
64
- /**
65
- *Interface for defining the Timeline Property
66
- */
67
- interface RucTimelineInput {
68
- /**
69
- * Specifies the layout orientation of the timeline.
70
- */
71
- layout?: 'vertical' | 'horizontal' | undefined;
72
- /**
73
- * Specifies the alignment of the timeline items relative to the line.
74
- */
75
- position?: 'left' | 'right' | 'top' | 'bottom' | 'alternate' | 'opposite';
76
- /**
77
- * The font color for the timeline item titles.
78
- */
79
- titleFontColor?: string | undefined;
80
- /**
81
- * The font color for the timeline item subtitles.
82
- */
83
- subTitleFontColor?: string | undefined;
84
- /**
85
- * The font size for the timeline item titles (e.g., '16px', '1.2em').
86
- */
87
- titleFontSize?: string | undefined;
88
- /**
89
- * The font size for the timeline item subtitles (e.g., '14px', '1em').
90
- */
91
- subTitleFontSize?: string | undefined;
92
- /**
93
- * The background color for the title area of a timeline item.
94
- */
95
- titleBackgroundColor?: string | undefined;
96
- /**
97
- * The background color for the subtitle area of a timeline item.
98
- */
99
- subTitleBackgroundColor?: string | undefined;
100
- /**
101
- * The color used to highlight an active or selected timeline item.
102
- */
103
- highlightColor?: string | undefined;
104
- /**
105
- * The theme color for the timeline item icons.
106
- */
107
- iconColor?: 'primary' | 'accent' | 'warn';
108
- /**
109
- * Maximum number of characters to display for the title before truncating.
110
- */
111
- maxTitleLength?: number;
112
- /**
113
- * Maximum number of characters to display for the subtitle before truncating.
114
- */
115
- maxSubTitleLength?: number;
116
- /**
117
- * A flag to determine if the additional info sections for title and subtitle should be displayed.
118
- */
119
- isInfo?: boolean | undefined;
120
- /**
121
- * A flag to indicate whether a custom template is being used for the timeline items instead of the default structure.
122
- */
123
- isTemplate?: boolean | undefined;
124
- /**
125
- * The array of data objects that represent the items in the timeline.
126
- */
127
- data?: RucTimelineItemData[];
128
- }
129
-
130
- declare class RuclibTimelineComponent {
131
- customTheme: string;
132
- rucInputData?: RucTimelineInput;
133
- data: RucTimelineItemData[] | undefined;
134
- /**
135
- * To get position of the timeline
136
- * @param position
137
- * @param index
138
- * @returns default: left
139
- */
140
- private getItemPosition;
141
- /**
142
- * To get layout of the timeline
143
- * @param layout
144
- * @returns default: vertical
145
- */
146
- private getItemLayout;
147
- /**
148
- * To get data from the input
149
- */
150
- getData(): RucTimelineItemData[] | any;
151
- /**
152
- * To get position of the timeline
153
- * @returns default: left
154
- */
155
- getPosition(index?: number): string | undefined;
156
- /**
157
- * To get layout of the timeline
158
- * @returns default: vertical
159
- */
160
- getLayout(): string;
161
- /**
162
- * To get highlight color of the timeline
163
- * @returns default: undefined
164
- */
165
- getHighlightColor(): string | undefined;
166
- /**
167
- * To get title font color of the timeline
168
- * @returns default: undefined
169
- */
170
- getTitleColor(): string | undefined;
171
- /**
172
- * To get sub title font color of the timeline
173
- * @returns default: undefined
174
- */
175
- getSubTitleColor(): string | undefined;
176
- /**
177
- * To get title font size of the timeline
178
- * @returns default: undefined
179
- */
180
- getTitleFontSize(): string | undefined;
181
- /**
182
- * To get subtitle font size of the timeline
183
- * @returns default: undefined
184
- */
185
- getSubTitleFontSize(): string | undefined;
186
- /**
187
- * To get title background color of the timeline
188
- * @returns default: undefined
189
- */
190
- getTitleBackgroundColor(): string | undefined;
191
- /**
192
- * To get subtitle background color of the timeline
193
- * @returns default: undefined
194
- */
195
- getSubTitleBackgroundColor(): string | undefined;
196
- /**
197
- * To get max title length of the timeline
198
- * @returns default: undefined
199
- */
200
- getMaxTitleLength(): number | any;
201
- /**
202
- * To get max sub title length of the timeline
203
- * @returns default: undefined
204
- */
205
- getMaxSubtitleLength(): number | any;
206
- /**
207
- * To check if the isInfo variable is defined and value is true|false in timeline
208
- * @returns default: undefined
209
- */
210
- isInfo(): boolean | undefined;
211
- /**
212
- * To get title in timeline
213
- * @param title
214
- * @param key
215
- * @returns default: title
216
- */
217
- getTitle(title?: string, key?: 'title' | 'subtitle' | ''): string;
218
- /**
219
- * To check if the length is defined
220
- * @param title
221
- * @param checkLength
222
- * @returns default: title
223
- */
224
- isLengthDefined(title: string | undefined, checkLength: number | undefined): string;
225
- /**
226
- * To check if the template variable is defined and value is true|false in timeline
227
- * @returns default: false
228
- */
229
- isCard(): boolean;
230
- /**
231
- * To get the color of icon
232
- * @returns default: false
233
- */
234
- getIconColor(): string;
235
- static ɵfac: i0.ɵɵFactoryDeclaration<RuclibTimelineComponent, never>;
236
- static ɵcmp: i0.ɵɵComponentDeclaration<RuclibTimelineComponent, "uxp-ruclib-timeline", never, { "customTheme": { "alias": "customTheme"; "required": false; }; "rucInputData": { "alias": "rucInputData"; "required": false; }; }, {}, never, never, true, never>;
237
- }
238
-
239
- export { RuclibTimelineComponent };
1
+ export * from './lib/ruclib-timeline.module';
2
+ export * from './lib/ruclib-timeline/ruclib-timeline.component';
@@ -0,0 +1,111 @@
1
+ import { RucTimelineInput, RucTimelineItemData } from '../../model/ruclib-timeline.model';
2
+ import * as i0 from "@angular/core";
3
+ export declare class RuclibTimelineComponent {
4
+ customTheme: string;
5
+ rucInputData?: RucTimelineInput;
6
+ data: RucTimelineItemData[] | undefined;
7
+ constructor();
8
+ /**
9
+ * To get position of the timeline
10
+ * @param position
11
+ * @param index
12
+ * @returns default: left
13
+ */
14
+ private getItemPosition;
15
+ /**
16
+ * To get layout of the timeline
17
+ * @param layout
18
+ * @returns default: vertical
19
+ */
20
+ private getItemLayout;
21
+ /**
22
+ * To get data from the input
23
+ */
24
+ getData(): RucTimelineItemData[] | any;
25
+ /**
26
+ * To get position of the timeline
27
+ * @returns default: left
28
+ */
29
+ getPosition(index?: number): string | undefined;
30
+ /**
31
+ * To get layout of the timeline
32
+ * @returns default: vertical
33
+ */
34
+ getLayout(): string;
35
+ /**
36
+ * To get highlight color of the timeline
37
+ * @returns default: undefined
38
+ */
39
+ getHighlightColor(): string | undefined;
40
+ /**
41
+ * To get title font color of the timeline
42
+ * @returns default: undefined
43
+ */
44
+ getTitleColor(): string | undefined;
45
+ /**
46
+ * To get sub title font color of the timeline
47
+ * @returns default: undefined
48
+ */
49
+ getSubTitleColor(): string | undefined;
50
+ /**
51
+ * To get title font size of the timeline
52
+ * @returns default: undefined
53
+ */
54
+ getTitleFontSize(): string | undefined;
55
+ /**
56
+ * To get subtitle font size of the timeline
57
+ * @returns default: undefined
58
+ */
59
+ getSubTitleFontSize(): string | undefined;
60
+ /**
61
+ * To get title background color of the timeline
62
+ * @returns default: undefined
63
+ */
64
+ getTitleBackgroundColor(): string | undefined;
65
+ /**
66
+ * To get subtitle background color of the timeline
67
+ * @returns default: undefined
68
+ */
69
+ getSubTitleBackgroundColor(): string | undefined;
70
+ /**
71
+ * To get max title length of the timeline
72
+ * @returns default: undefined
73
+ */
74
+ getMaxTitleLength(): number | any;
75
+ /**
76
+ * To get max sub title length of the timeline
77
+ * @returns default: undefined
78
+ */
79
+ getMaxSubtitleLength(): number | any;
80
+ /**
81
+ * To check if the isInfo variable is defined and value is true|false in timeline
82
+ * @returns default: undefined
83
+ */
84
+ isInfo(): boolean | undefined;
85
+ /**
86
+ * To get title in timeline
87
+ * @param title
88
+ * @param key
89
+ * @returns default: title
90
+ */
91
+ getTitle(title?: string, key?: 'title' | 'subtitle' | ''): string;
92
+ /**
93
+ * To check if the length is defined
94
+ * @param title
95
+ * @param checkLength
96
+ * @returns default: title
97
+ */
98
+ isLengthDefined(title: string | undefined, checkLength: number | undefined): string;
99
+ /**
100
+ * To check if the template variable is defined and value is true|false in timeline
101
+ * @returns default: false
102
+ */
103
+ isCard(): boolean;
104
+ /**
105
+ * To get the color of icon
106
+ * @returns default: false
107
+ */
108
+ getIconColor(): string;
109
+ static ɵfac: i0.ɵɵFactoryDeclaration<RuclibTimelineComponent, never>;
110
+ static ɵcmp: i0.ɵɵComponentDeclaration<RuclibTimelineComponent, "uxp-ruclib-timeline", never, { "customTheme": "customTheme"; "rucInputData": "rucInputData"; }, {}, never, never, false, never>;
111
+ }
@@ -0,0 +1,11 @@
1
+ import * as i0 from "@angular/core";
2
+ import * as i1 from "./ruclib-timeline/ruclib-timeline.component";
3
+ import * as i2 from "@angular/common";
4
+ import * as i3 from "@angular/material/icon";
5
+ import * as i4 from "@angular/material/tooltip";
6
+ import * as i5 from "@angular/material/card";
7
+ export declare class RuclibTimelineModule {
8
+ static ɵfac: i0.ɵɵFactoryDeclaration<RuclibTimelineModule, never>;
9
+ static ɵmod: i0.ɵɵNgModuleDeclaration<RuclibTimelineModule, [typeof i1.RuclibTimelineComponent], [typeof i2.CommonModule, typeof i3.MatIconModule, typeof i4.MatTooltipModule, typeof i5.MatCardModule], [typeof i1.RuclibTimelineComponent]>;
10
+ static ɵinj: i0.ɵɵInjectorDeclaration<RuclibTimelineModule>;
11
+ }
@@ -0,0 +1,126 @@
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
+ }
package/package.json CHANGED
@@ -1,16 +1,24 @@
1
1
  {
2
2
  "name": "@ruc-lib/timeline",
3
- "version": "3.1.0",
3
+ "version": "3.2.0",
4
+ "license": "MIT",
4
5
  "peerDependencies": {
5
- "@angular/common": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0",
6
- "@angular/core": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0",
7
- "@angular/material": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0"
6
+ "@angular/common": "^17.0.0 || ^16.0.0 || ^15.0.0",
7
+ "@angular/core": "^17.0.0 || ^16.0.0 || ^15.0.0",
8
+ "@angular/material": "^15.2.9 || ^14.0.0 || ^13.0.0"
8
9
  },
9
10
  "dependencies": {
10
11
  "tslib": "^2.3.0"
11
12
  },
13
+ "publishConfig": {
14
+ "access": "public"
15
+ },
12
16
  "sideEffects": false,
13
- "module": "fesm2022/ruc-lib-timeline.mjs",
17
+ "module": "fesm2015/ruc-lib-timeline.mjs",
18
+ "es2020": "fesm2020/ruc-lib-timeline.mjs",
19
+ "esm2020": "esm2020/ruc-lib-timeline.mjs",
20
+ "fesm2020": "fesm2020/ruc-lib-timeline.mjs",
21
+ "fesm2015": "fesm2015/ruc-lib-timeline.mjs",
14
22
  "typings": "index.d.ts",
15
23
  "exports": {
16
24
  "./package.json": {
@@ -18,7 +26,11 @@
18
26
  },
19
27
  ".": {
20
28
  "types": "./index.d.ts",
21
- "default": "./fesm2022/ruc-lib-timeline.mjs"
29
+ "esm2020": "./esm2020/ruc-lib-timeline.mjs",
30
+ "es2020": "./fesm2020/ruc-lib-timeline.mjs",
31
+ "es2015": "./fesm2015/ruc-lib-timeline.mjs",
32
+ "node": "./fesm2015/ruc-lib-timeline.mjs",
33
+ "default": "./fesm2020/ruc-lib-timeline.mjs"
22
34
  }
23
35
  }
24
36
  }