Skip to main content
Version: 1.x

Available methods

TimelineCalendar methods

goToDate

Example
const calendarRef = useRef<TimelineCalendarHandle>(null);

//...
<TimelineCalendar ref={calendarRef} viewMode="week" />;

//...
<TouchableOpacity onPress={() => {
//Optional
const optionalProps = {
date: "2022-11-09" //Default: today
hourScroll: true,
animatedHour: true
animatedDate: false
}
calendarRef.current?.goToDate(optionalProps)
}}>
<Text>Go to date</Text>
</TouchableOpacity>;

goToNextPage

Example
const calendarRef = useRef<TimelineCalendarHandle>(null);

//...
<TimelineCalendar ref={calendarRef} viewMode="week" />;

//...
<TouchableOpacity
onPress={() => {
calendarRef.current?.goToNextPage();
}}
>
<Text>Next week</Text>
</TouchableOpacity>;

goToPrevPage

Example
const calendarRef = useRef<TimelineCalendarHandle>(null);

//...
<TimelineCalendar ref={calendarRef} viewMode="week" />;

//...
<TouchableOpacity
onPress={() => {
calendarRef.current?.goToPrevPage();
}}
>
<Text>Previous week</Text>
</TouchableOpacity>;

getZones

Get Supported Time Zone List

Example
const calendarRef = useRef<TimelineCalendarHandle>(null);

//...
<TimelineCalendar ref={calendarRef} viewMode="week" />;

//...
<TouchableOpacity
onPress={() => {
calendarRef.current?.getZones();
}}
>
<Text>Get Supported Time Zone List</Text>
</TouchableOpacity>;

getZone

Get zone info by zone name

Example
const calendarRef = useRef<TimelineCalendarHandle>(null);

//...
<TimelineCalendar ref={calendarRef} viewMode="week" />;

//...
<TouchableOpacity
onPress={() => {
calendarRef.current?.getZone('Asia/Ho_Chi_Minh');
}}
>
<Text>Get zone info</Text>
</TouchableOpacity>;

goToHour

Scroll timeline to the custom hour

Example
const calendarRef = useRef<TimelineCalendarHandle>(null);

//...
<TimelineCalendar ref={calendarRef} viewMode="week" />;

//...
<TouchableOpacity
onPress={() => {
calendarRef.current?.goToHour(7.5);
}}
>
<Text>Go to 07:30</Text>
</TouchableOpacity>;

zoom

Change timeIntervalHeight

Example
const calendarRef = useRef<TimelineCalendarHandle>(null);

//...
<TimelineCalendar ref={calendarRef} viewMode="week" />;

//...
<TouchableOpacity
onPress={() => {
calendarRef.current?.zoom({ scale: 1.2 }); // Change `timeIntervalHeight` by scale value
// calendarRef.current?.zoom({ height: 100 }); // Change `timeIntervalHeight` to height value
// calendarRef.current?.zoom(); // Change `timeIntervalHeight` to initialTimeIntervalHeight
}}
>
<Text>Zoom In</Text>
</TouchableOpacity>;

<TouchableOpacity
onPress={() => {
calendarRef.current?.zoom({ scale: 0.8 }); // Change `timeIntervalHeight` by scale value
// calendarRef.current?.zoom({ height: 40 }); // Change `timeIntervalHeight` to height value
// calendarRef.current?.zoom(); // Change `timeIntervalHeight` to initialTimeIntervalHeight
}}
>
<Text>Zoom Out</Text>
</TouchableOpacity>;