Skip to content

Commit c12fc20

Browse files
ci: apply automated fixes
1 parent dbd7770 commit c12fc20

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+2100
-128
lines changed

docs/framework/react/reference/functions/useCalendar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: useCalendar
99
function useCalendar<TResource, TEvent>(options): CalendarApi<TResource, TEvent> & object;
1010
```
1111

12-
Defined in: [useCalendar.ts:11](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L11)
12+
Defined in: [useCalendar.ts:69](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L69)
1313

1414
## Type Parameters
1515

@@ -25,7 +25,7 @@ Defined in: [useCalendar.ts:11](https://github.com/TanStack/time/blob/main/packa
2525

2626
### options
2727

28-
`CalendarCoreOptions`\<`TResource`, `TEvent`\>
28+
[`UseCalendarOptions`](../interfaces/UseCalendarOptions.md)\<`TResource`, `TEvent`\>
2929

3030
## Returns
3131

docs/framework/react/reference/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ title: "@tanstack/react-time"
55

66
# @tanstack/react-time
77

8+
## Interfaces
9+
10+
- [ResizeOptions](interfaces/ResizeOptions.md)
11+
- [ResizeState](interfaces/ResizeState.md)
12+
- [UseCalendarOptions](interfaces/UseCalendarOptions.md)
13+
814
## Functions
915

1016
- [useCalendar](functions/useCalendar.md)
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
id: ResizeOptions
3+
title: ResizeOptions
4+
---
5+
6+
# Interface: ResizeOptions
7+
8+
Defined in: [useCalendar.ts:36](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L36)
9+
10+
## Properties
11+
12+
### constraints?
13+
14+
```ts
15+
optional constraints: ResizeConstraints;
16+
```
17+
18+
Defined in: [useCalendar.ts:39](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L39)
19+
20+
***
21+
22+
### containerHeight?
23+
24+
```ts
25+
optional containerHeight: number;
26+
```
27+
28+
Defined in: [useCalendar.ts:38](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L38)
29+
30+
***
31+
32+
### enabled?
33+
34+
```ts
35+
optional enabled: boolean;
36+
```
37+
38+
Defined in: [useCalendar.ts:37](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L37)
39+
40+
***
41+
42+
### onResizeEnd()?
43+
44+
```ts
45+
optional onResizeEnd: (eventId, newStart, newEnd) => void;
46+
```
47+
48+
Defined in: [useCalendar.ts:41](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L41)
49+
50+
#### Parameters
51+
52+
##### eventId
53+
54+
`string`
55+
56+
##### newStart
57+
58+
`string`
59+
60+
##### newEnd
61+
62+
`string`
63+
64+
#### Returns
65+
66+
`void`
67+
68+
***
69+
70+
### onResizeError()?
71+
72+
```ts
73+
optional onResizeError: (error) => void;
74+
```
75+
76+
Defined in: [useCalendar.ts:42](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L42)
77+
78+
#### Parameters
79+
80+
##### error
81+
82+
`ResizeError`
83+
84+
#### Returns
85+
86+
`void`
87+
88+
***
89+
90+
### onResizeStart()?
91+
92+
```ts
93+
optional onResizeStart: (eventId, edge) => void;
94+
```
95+
96+
Defined in: [useCalendar.ts:40](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L40)
97+
98+
#### Parameters
99+
100+
##### eventId
101+
102+
`string`
103+
104+
##### edge
105+
106+
`ResizeEdge`
107+
108+
#### Returns
109+
110+
`void`
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
id: ResizeState
3+
title: ResizeState
4+
---
5+
6+
# Interface: ResizeState
7+
8+
Defined in: [useCalendar.ts:27](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L27)
9+
10+
## Properties
11+
12+
### edge
13+
14+
```ts
15+
edge: ResizeEdge | null;
16+
```
17+
18+
Defined in: [useCalendar.ts:30](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L30)
19+
20+
***
21+
22+
### eventId
23+
24+
```ts
25+
eventId: string | null;
26+
```
27+
28+
Defined in: [useCalendar.ts:29](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L29)
29+
30+
***
31+
32+
### isResizing
33+
34+
```ts
35+
isResizing: boolean;
36+
```
37+
38+
Defined in: [useCalendar.ts:28](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L28)
39+
40+
***
41+
42+
### previewEnd
43+
44+
```ts
45+
previewEnd: string | null;
46+
```
47+
48+
Defined in: [useCalendar.ts:32](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L32)
49+
50+
***
51+
52+
### previewStart
53+
54+
```ts
55+
previewStart: string | null;
56+
```
57+
58+
Defined in: [useCalendar.ts:31](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L31)
59+
60+
***
61+
62+
### targetDayDate
63+
64+
```ts
65+
targetDayDate: string | null;
66+
```
67+
68+
Defined in: [useCalendar.ts:33](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L33)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
id: UseCalendarOptions
3+
title: UseCalendarOptions
4+
---
5+
6+
# Interface: UseCalendarOptions\<TResource, TEvent\>
7+
8+
Defined in: [useCalendar.ts:53](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L53)
9+
10+
## Extends
11+
12+
- `CalendarCoreOptions`\<`TResource`, `TEvent`\>
13+
14+
## Type Parameters
15+
16+
### TResource
17+
18+
`TResource` *extends* `Resource`
19+
20+
### TEvent
21+
22+
`TEvent` *extends* `Event`\<`TResource`\>
23+
24+
## Properties
25+
26+
### resize?
27+
28+
```ts
29+
optional resize: ResizeOptions;
30+
```
31+
32+
Defined in: [useCalendar.ts:57](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L57)

0 commit comments

Comments
 (0)