Skip to content

Commit 2cc34cb

Browse files
feat: calendar
2 parents 86ce9ff + 00186b8 commit 2cc34cb

2 files changed

Lines changed: 36 additions & 0 deletions

File tree

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
id: useCalendar
3+
title: useCalendar
4+
---
5+
6+
# Function: useCalendar()
7+
8+
```ts
9+
function useCalendar<TResource, TEvent>(options): CalendarApi<TResource, TEvent> & object;
10+
```
11+
12+
Defined in: [useCalendar.ts:11](https://github.com/TanStack/time/blob/main/packages/react-time/src/useCalendar/useCalendar.ts#L11)
13+
14+
## Type Parameters
15+
16+
### TResource
17+
18+
`TResource` *extends* `Resource`
19+
20+
### TEvent
21+
22+
`TEvent` *extends* `Event`\<`TResource`\> = `Event`\<`TResource`\>
23+
24+
## Parameters
25+
26+
### options
27+
28+
`CalendarCoreOptions`\<`TResource`, `TEvent`\>
29+
30+
## Returns
31+
32+
`CalendarApi`\<`TResource`, `TEvent`\> & `object`

docs/framework/react/reference/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ title: "@tanstack/react-time"
44
---
55

66
# @tanstack/react-time
7+
8+
## Functions
9+
10+
- [useCalendar](functions/useCalendar.md)

0 commit comments

Comments
 (0)