@tlmgo/tui-calendar 2.2.0 → 2.2.1

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,7 +1,7 @@
1
- import { h } from 'preact';
2
- import CalendarCore from "./calendarCore";
3
- import type { Options } from "../types/options";
4
- export default class Day extends CalendarCore {
5
- constructor(container: Element, options?: Options);
6
- protected getComponent(): h.JSX.Element;
7
- }
1
+ import { h } from 'preact';
2
+ import CalendarCore from "./calendarCore";
3
+ import type { Options } from "../types/options";
4
+ export default class Day extends CalendarCore {
5
+ constructor(container: Element, options?: Options);
6
+ protected getComponent(): h.JSX.Element;
7
+ }
@@ -1,11 +1,11 @@
1
- import { h } from 'preact';
2
- import CalendarCore from "./calendarCore";
3
- import type { Options } from "../types/options";
4
- export default class Month extends CalendarCore {
5
- constructor(container: Element, options?: Options);
6
- protected getComponent(): h.JSX.Element;
7
- /**
8
- * Hide the more view
9
- */
10
- hideMoreView(): void;
11
- }
1
+ import { h } from 'preact';
2
+ import CalendarCore from "./calendarCore";
3
+ import type { Options } from "../types/options";
4
+ export default class Month extends CalendarCore {
5
+ constructor(container: Element, options?: Options);
6
+ protected getComponent(): h.JSX.Element;
7
+ /**
8
+ * Hide the more view
9
+ */
10
+ hideMoreView(): void;
11
+ }
@@ -1,7 +1,7 @@
1
- import { h } from 'preact';
2
- import CalendarCore from "./calendarCore";
3
- import type { Options } from "../types/options";
4
- export default class Week extends CalendarCore {
5
- constructor(container: Element, options?: Options);
6
- protected getComponent(): h.JSX.Element;
7
- }
1
+ import { h } from 'preact';
2
+ import CalendarCore from "./calendarCore";
3
+ import type { Options } from "../types/options";
4
+ export default class Week extends CalendarCore {
5
+ constructor(container: Element, options?: Options);
6
+ protected getComponent(): h.JSX.Element;
7
+ }
package/types/index.d.ts CHANGED
@@ -1,11 +1,11 @@
1
- import Calendar from "./factory/calendar";
2
- import Day from "./factory/day";
3
- import Month from "./factory/month";
4
- import Week from "./factory/week";
5
- import TZDate from "./time/date";
6
- import type { ExternalEventTypes } from "./types/eventBus";
7
- import type { EventObjectWithDefaultValues } from "./types/events";
8
- import type { Options } from "./types/options";
9
- export default Calendar;
10
- export { Day, Month, TZDate, Week };
11
- export type { EventObjectWithDefaultValues as EventObject, ExternalEventTypes, Options };
1
+ import Calendar from "./factory/calendar";
2
+ import Day from "./factory/day";
3
+ import Month from "./factory/month";
4
+ import Week from "./factory/week";
5
+ import TZDate from "./time/date";
6
+ import type { ExternalEventTypes } from "./types/eventBus";
7
+ import type { EventObjectWithDefaultValues } from "./types/events";
8
+ import type { Options } from "./types/options";
9
+ export default Calendar;
10
+ export { Day, Month, TZDate, Week };
11
+ export type { EventObjectWithDefaultValues as EventObject, ExternalEventTypes, Options };
@@ -1,206 +1,206 @@
1
- /**
2
- * Custom Date Class to handle timezone offset.
3
- *
4
- * For more information, see {@link https://github.com/nhn/tui.calendar/blob/main/docs/en/apis/tzdate.md|TZDate} in guide.
5
- *
6
- * @class TZDate
7
- * @param {number|TZDate|Date|string} date - date value to be converted. If date is number or string, it should be eligible to parse by Date constructor.
8
- */
9
- export default class TZDate {
10
- private tzOffset;
11
- private d;
12
- constructor(...args: any[]);
13
- /**
14
- * Get the string representation of the date.
15
- * @returns {string} string representation of the date.
16
- */
17
- toString(): string;
18
- /**
19
- * Add years to the instance.
20
- * @param {number} y - number of years to be added.
21
- * @returns {TZDate} - returns the instance itself.
22
- */
23
- addFullYear(y: number): TZDate;
24
- /**
25
- * Add months to the instance.
26
- * @param {number} m - number of months to be added.
27
- * @returns {TZDate} - returns the instance itself.
28
- */
29
- addMonth(m: number): TZDate;
30
- /**
31
- * Add dates to the instance.
32
- * @param {number} d - number of days to be added.
33
- * @returns {TZDate} - returns the instance itself.
34
- */
35
- addDate(d: number): TZDate;
36
- /**
37
- * Add hours to the instance.
38
- * @param {number} h - number of hours to be added.
39
- * @returns {TZDate} - returns the instance itself.
40
- */
41
- addHours(h: number): TZDate;
42
- /**
43
- * Add minutes to the instance.
44
- * @param {number} M - number of minutes to be added.
45
- * @returns {TZDate} - returns the instance itself.
46
- */
47
- addMinutes(M: number): TZDate;
48
- /**
49
- * Add seconds to the instance.
50
- * @param {number} s - number of seconds to be added.
51
- * @returns {TZDate} - returns the instance itself.
52
- */
53
- addSeconds(s: number): TZDate;
54
- /**
55
- * Add milliseconds to the instance.
56
- * @param {number} ms - number of milliseconds to be added.
57
- * @returns {TZDate} - returns the instance itself.
58
- */
59
- addMilliseconds(ms: number): TZDate;
60
- /**
61
- * Set the date and time all at once.
62
- * @param {number} y - year
63
- * @param {number} m - month
64
- * @param {number} d - date
65
- * @param {number} h - hours
66
- * @param {number} M - minutes
67
- * @param {number} s - seconds
68
- * @param {number} ms - milliseconds
69
- * @returns {TZDate} - returns the instance itself.
70
- */
71
- setWithRaw(y: number, m: number, d: number, h: number, M: number, s: number, ms: number): TZDate;
72
- /**
73
- * Convert the instance to the native `Date` object.
74
- * @returns {Date} - The native `Date` object.
75
- */
76
- toDate(): Date;
77
- /**
78
- * Get the value of the date. (milliseconds since 1970-01-01 00:00:00 (UTC+0))
79
- * @returns {number} - value of the date.
80
- */
81
- valueOf(): number;
82
- /**
83
- * Get the timezone offset from UTC in minutes.
84
- * @returns {number} - timezone offset in minutes.
85
- */
86
- getTimezoneOffset(): number;
87
- /**
88
- * Get milliseconds which is converted by timezone
89
- * @returns {number} milliseconds
90
- */
91
- getTime(): number;
92
- /**
93
- * Get the year of the instance.
94
- * @returns {number} - full year
95
- */
96
- getFullYear(): number;
97
- /**
98
- * Get the month of the instance. (zero-based)
99
- * @returns {number} - month
100
- */
101
- getMonth(): number;
102
- /**
103
- * Get the date of the instance.
104
- * @returns {number} - date
105
- */
106
- getDate(): number;
107
- /**
108
- * Get the hours of the instance.
109
- * @returns {number} - hours
110
- */
111
- getHours(): number;
112
- /**
113
- * Get the minutes of the instance.
114
- * @returns {number} - minutes
115
- */
116
- getMinutes(): number;
117
- /**
118
- * Get the seconds of the instance.
119
- * @returns {number} - seconds
120
- */
121
- getSeconds(): number;
122
- /**
123
- * Get the milliseconds of the instance.
124
- * @returns {number} - milliseconds
125
- */
126
- getMilliseconds(): number;
127
- /**
128
- * Get the day of the week of the instance.
129
- * @returns {number} - day of the week
130
- */
131
- getDay(): number;
132
- /**
133
- * Sets the instance to the time represented by a number of milliseconds since 1970-01-01 00:00:00 (UTC+0).
134
- * @param {number} t - number of milliseconds
135
- * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
136
- */
137
- setTime(t: number): number;
138
- /**
139
- * Sets the year-month-date of the instance. Equivalent to calling `setFullYear` of `Date` object.
140
- * @param {number} y - year
141
- * @param {number} m - month (zero-based)
142
- * @param {number} d - date
143
- * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
144
- */
145
- setFullYear(y: number, m?: number, d?: number): number;
146
- /**
147
- * Sets the month of the instance. Equivalent to calling `setMonth` of `Date` object.
148
- * @param {number} m - month (zero-based)
149
- * @param {number} d - date
150
- * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
151
- */
152
- setMonth(m: number, d?: number): number;
153
- /**
154
- * Sets the date of the instance. Equivalent to calling `setDate` of `Date` object.
155
- * @param {number} d - date
156
- * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
157
- */
158
- setDate(d: number): number;
159
- /**
160
- * Sets the hours of the instance. Equivalent to calling `setHours` of `Date` object.
161
- * @param {number} h - hours
162
- * @param {number} M - minutes
163
- * @param {number} s - seconds
164
- * @param {number} ms - milliseconds
165
- * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
166
- */
167
- setHours(h: number, M?: number, s?: number, ms?: number): number;
168
- /**
169
- * Sets the minutes of the instance. Equivalent to calling `setMinutes` of `Date` object.
170
- * @param {number} M - minutes
171
- * @param {number} s - seconds
172
- * @param {number} ms - milliseconds
173
- * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
174
- */
175
- setMinutes(M: number, s?: number, ms?: number): number;
176
- /**
177
- * Sets the seconds of the instance. Equivalent to calling `setSeconds` of `Date` object.
178
- * @param {number} s - seconds
179
- * @param {number} ms - milliseconds
180
- * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
181
- */
182
- setSeconds(s: number, ms?: number): number;
183
- /**
184
- * Sets the milliseconds of the instance. Equivalent to calling `setMilliseconds` of `Date` object.
185
- * @param {number} ms - milliseconds
186
- * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
187
- */
188
- setMilliseconds(ms: number): number;
189
- /**
190
- * Set the timezone offset of the instance.
191
- * @param {string|number} tzValue - The name of timezone(IANA name) or timezone offset(in minutes).
192
- * @returns {TZDate} - New instance with the timezone offset.
193
- */
194
- tz(tzValue: string | 'Local' | number): TZDate;
195
- /**
196
- * Get the new instance following the system's timezone.
197
- * If the system timezone is different from the timezone of the instance,
198
- * the instance is converted to the system timezone.
199
- *
200
- * Instance's `tzOffset` property will be ignored if there is a `tzValue` parameter.
201
- *
202
- * @param {string|number} tzValue - The name of timezone(IANA name) or timezone offset(in minutes).
203
- * @returns {TZDate} - New instance with the system timezone.
204
- */
205
- local(tzValue?: string | number): TZDate;
206
- }
1
+ /**
2
+ * Custom Date Class to handle timezone offset.
3
+ *
4
+ * For more information, see {@link https://github.com/nhn/tui.calendar/blob/main/docs/en/apis/tzdate.md|TZDate} in guide.
5
+ *
6
+ * @class TZDate
7
+ * @param {number|TZDate|Date|string} date - date value to be converted. If date is number or string, it should be eligible to parse by Date constructor.
8
+ */
9
+ export default class TZDate {
10
+ private tzOffset;
11
+ private d;
12
+ constructor(...args: any[]);
13
+ /**
14
+ * Get the string representation of the date.
15
+ * @returns {string} string representation of the date.
16
+ */
17
+ toString(): string;
18
+ /**
19
+ * Add years to the instance.
20
+ * @param {number} y - number of years to be added.
21
+ * @returns {TZDate} - returns the instance itself.
22
+ */
23
+ addFullYear(y: number): TZDate;
24
+ /**
25
+ * Add months to the instance.
26
+ * @param {number} m - number of months to be added.
27
+ * @returns {TZDate} - returns the instance itself.
28
+ */
29
+ addMonth(m: number): TZDate;
30
+ /**
31
+ * Add dates to the instance.
32
+ * @param {number} d - number of days to be added.
33
+ * @returns {TZDate} - returns the instance itself.
34
+ */
35
+ addDate(d: number): TZDate;
36
+ /**
37
+ * Add hours to the instance.
38
+ * @param {number} h - number of hours to be added.
39
+ * @returns {TZDate} - returns the instance itself.
40
+ */
41
+ addHours(h: number): TZDate;
42
+ /**
43
+ * Add minutes to the instance.
44
+ * @param {number} M - number of minutes to be added.
45
+ * @returns {TZDate} - returns the instance itself.
46
+ */
47
+ addMinutes(M: number): TZDate;
48
+ /**
49
+ * Add seconds to the instance.
50
+ * @param {number} s - number of seconds to be added.
51
+ * @returns {TZDate} - returns the instance itself.
52
+ */
53
+ addSeconds(s: number): TZDate;
54
+ /**
55
+ * Add milliseconds to the instance.
56
+ * @param {number} ms - number of milliseconds to be added.
57
+ * @returns {TZDate} - returns the instance itself.
58
+ */
59
+ addMilliseconds(ms: number): TZDate;
60
+ /**
61
+ * Set the date and time all at once.
62
+ * @param {number} y - year
63
+ * @param {number} m - month
64
+ * @param {number} d - date
65
+ * @param {number} h - hours
66
+ * @param {number} M - minutes
67
+ * @param {number} s - seconds
68
+ * @param {number} ms - milliseconds
69
+ * @returns {TZDate} - returns the instance itself.
70
+ */
71
+ setWithRaw(y: number, m: number, d: number, h: number, M: number, s: number, ms: number): TZDate;
72
+ /**
73
+ * Convert the instance to the native `Date` object.
74
+ * @returns {Date} - The native `Date` object.
75
+ */
76
+ toDate(): Date;
77
+ /**
78
+ * Get the value of the date. (milliseconds since 1970-01-01 00:00:00 (UTC+0))
79
+ * @returns {number} - value of the date.
80
+ */
81
+ valueOf(): number;
82
+ /**
83
+ * Get the timezone offset from UTC in minutes.
84
+ * @returns {number} - timezone offset in minutes.
85
+ */
86
+ getTimezoneOffset(): number;
87
+ /**
88
+ * Get milliseconds which is converted by timezone
89
+ * @returns {number} milliseconds
90
+ */
91
+ getTime(): number;
92
+ /**
93
+ * Get the year of the instance.
94
+ * @returns {number} - full year
95
+ */
96
+ getFullYear(): number;
97
+ /**
98
+ * Get the month of the instance. (zero-based)
99
+ * @returns {number} - month
100
+ */
101
+ getMonth(): number;
102
+ /**
103
+ * Get the date of the instance.
104
+ * @returns {number} - date
105
+ */
106
+ getDate(): number;
107
+ /**
108
+ * Get the hours of the instance.
109
+ * @returns {number} - hours
110
+ */
111
+ getHours(): number;
112
+ /**
113
+ * Get the minutes of the instance.
114
+ * @returns {number} - minutes
115
+ */
116
+ getMinutes(): number;
117
+ /**
118
+ * Get the seconds of the instance.
119
+ * @returns {number} - seconds
120
+ */
121
+ getSeconds(): number;
122
+ /**
123
+ * Get the milliseconds of the instance.
124
+ * @returns {number} - milliseconds
125
+ */
126
+ getMilliseconds(): number;
127
+ /**
128
+ * Get the day of the week of the instance.
129
+ * @returns {number} - day of the week
130
+ */
131
+ getDay(): number;
132
+ /**
133
+ * Sets the instance to the time represented by a number of milliseconds since 1970-01-01 00:00:00 (UTC+0).
134
+ * @param {number} t - number of milliseconds
135
+ * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
136
+ */
137
+ setTime(t: number): number;
138
+ /**
139
+ * Sets the year-month-date of the instance. Equivalent to calling `setFullYear` of `Date` object.
140
+ * @param {number} y - year
141
+ * @param {number} m - month (zero-based)
142
+ * @param {number} d - date
143
+ * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
144
+ */
145
+ setFullYear(y: number, m?: number, d?: number): number;
146
+ /**
147
+ * Sets the month of the instance. Equivalent to calling `setMonth` of `Date` object.
148
+ * @param {number} m - month (zero-based)
149
+ * @param {number} d - date
150
+ * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
151
+ */
152
+ setMonth(m: number, d?: number): number;
153
+ /**
154
+ * Sets the date of the instance. Equivalent to calling `setDate` of `Date` object.
155
+ * @param {number} d - date
156
+ * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
157
+ */
158
+ setDate(d: number): number;
159
+ /**
160
+ * Sets the hours of the instance. Equivalent to calling `setHours` of `Date` object.
161
+ * @param {number} h - hours
162
+ * @param {number} M - minutes
163
+ * @param {number} s - seconds
164
+ * @param {number} ms - milliseconds
165
+ * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
166
+ */
167
+ setHours(h: number, M?: number, s?: number, ms?: number): number;
168
+ /**
169
+ * Sets the minutes of the instance. Equivalent to calling `setMinutes` of `Date` object.
170
+ * @param {number} M - minutes
171
+ * @param {number} s - seconds
172
+ * @param {number} ms - milliseconds
173
+ * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
174
+ */
175
+ setMinutes(M: number, s?: number, ms?: number): number;
176
+ /**
177
+ * Sets the seconds of the instance. Equivalent to calling `setSeconds` of `Date` object.
178
+ * @param {number} s - seconds
179
+ * @param {number} ms - milliseconds
180
+ * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
181
+ */
182
+ setSeconds(s: number, ms?: number): number;
183
+ /**
184
+ * Sets the milliseconds of the instance. Equivalent to calling `setMilliseconds` of `Date` object.
185
+ * @param {number} ms - milliseconds
186
+ * @returns {number} - Passed milliseconds of the instance since 1970-01-01 00:00:00 (UTC+0).
187
+ */
188
+ setMilliseconds(ms: number): number;
189
+ /**
190
+ * Set the timezone offset of the instance.
191
+ * @param {string|number} tzValue - The name of timezone(IANA name) or timezone offset(in minutes).
192
+ * @returns {TZDate} - New instance with the timezone offset.
193
+ */
194
+ tz(tzValue: string | 'Local' | number): TZDate;
195
+ /**
196
+ * Get the new instance following the system's timezone.
197
+ * If the system timezone is different from the timezone of the instance,
198
+ * the instance is converted to the system timezone.
199
+ *
200
+ * Instance's `tzOffset` property will be ignored if there is a `tzValue` parameter.
201
+ *
202
+ * @param {string|number} tzValue - The name of timezone(IANA name) or timezone offset(in minutes).
203
+ * @returns {TZDate} - New instance with the system timezone.
204
+ */
205
+ local(tzValue?: string | number): TZDate;
206
+ }
@@ -1,40 +1,40 @@
1
- import type { EventObject, EventObjectWithDefaultValues } from "./events";
2
- export declare type AnyFunc = (...args: any[]) => any;
3
- export interface SelectDateTimeInfo {
4
- start: Date;
5
- end: Date;
6
- isAllday: boolean;
7
- nativeEvent?: MouseEvent;
8
- gridSelectionElements: Element[];
9
- }
10
- export interface UpdatedEventInfo {
11
- event: EventObjectWithDefaultValues;
12
- changes: EventObject;
13
- }
14
- export interface DayNameInfo {
15
- date: string;
16
- }
17
- export interface EventInfo {
18
- event: EventObjectWithDefaultValues;
19
- nativeEvent: MouseEvent;
20
- }
21
- export interface MoreEventsButton {
22
- date: Date;
23
- target: HTMLDivElement;
24
- }
25
- export declare type ScrollBehaviorOptions = ScrollToOptions['behavior'];
26
- export declare type ExternalEventTypes = {
27
- selectDateTime: (info: SelectDateTimeInfo) => void;
28
- beforeCreateEvent: (event: EventObject) => void;
29
- beforeUpdateEvent: (updatedEventInfo: UpdatedEventInfo) => void;
30
- beforeDeleteEvent: (event: EventObjectWithDefaultValues) => void;
31
- afterRenderEvent: (event: EventObjectWithDefaultValues) => void;
32
- clickDayName: (dayNameInfo: DayNameInfo) => void;
33
- clickEvent: (eventInfo: EventInfo) => void;
34
- clickMoreEventsBtn: (moreEventsBtnInfo: MoreEventsButton) => void;
35
- clickTimezonesCollapseBtn: (prevCollapsedState: boolean) => void;
36
- [eventName: string]: AnyFunc;
37
- };
38
- export declare type InternalEventTypes = {
39
- scrollToNow: (scrollBehavior?: ScrollBehaviorOptions) => void;
40
- };
1
+ import type { EventObject, EventObjectWithDefaultValues } from "./events";
2
+ export declare type AnyFunc = (...args: any[]) => any;
3
+ export interface SelectDateTimeInfo {
4
+ start: Date;
5
+ end: Date;
6
+ isAllday: boolean;
7
+ nativeEvent?: MouseEvent;
8
+ gridSelectionElements: Element[];
9
+ }
10
+ export interface UpdatedEventInfo {
11
+ event: EventObjectWithDefaultValues;
12
+ changes: EventObject;
13
+ }
14
+ export interface DayNameInfo {
15
+ date: string;
16
+ }
17
+ export interface EventInfo {
18
+ event: EventObjectWithDefaultValues;
19
+ nativeEvent: MouseEvent;
20
+ }
21
+ export interface MoreEventsButton {
22
+ date: Date;
23
+ target: HTMLDivElement;
24
+ }
25
+ export declare type ScrollBehaviorOptions = ScrollToOptions['behavior'];
26
+ export declare type ExternalEventTypes = {
27
+ selectDateTime: (info: SelectDateTimeInfo) => void;
28
+ beforeCreateEvent: (event: EventObject) => void;
29
+ beforeUpdateEvent: (updatedEventInfo: UpdatedEventInfo) => void;
30
+ beforeDeleteEvent: (event: EventObjectWithDefaultValues) => void;
31
+ afterRenderEvent: (event: EventObjectWithDefaultValues) => void;
32
+ clickDayName: (dayNameInfo: DayNameInfo) => void;
33
+ clickEvent: (eventInfo: EventInfo) => void;
34
+ clickMoreEventsBtn: (moreEventsBtnInfo: MoreEventsButton) => void;
35
+ clickTimezonesCollapseBtn: (prevCollapsedState: boolean) => void;
36
+ [eventName: string]: AnyFunc;
37
+ };
38
+ export declare type InternalEventTypes = {
39
+ scrollToNow: (scrollBehavior?: ScrollBehaviorOptions) => void;
40
+ };