Skip to content

Commit a68ca10

Browse files
committed
Explain better the date prop
1 parent c3ca628 commit a68ca10

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/timeline/Timeline.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const {width: dimensionWidth} = Dimensions.get('window');
1414

1515
export interface TimelineProps {
1616
/**
17-
* The date of this timeline instance
17+
* The date of this timeline instance in ISO format (e.g. 2011-10-25)
1818
*/
1919
date?: string;
2020
/**
@@ -40,10 +40,12 @@ export interface TimelineProps {
4040
onEventPress?: (event: Event) => void;
4141
/**
4242
* Pass to handle creation of a new event by long press on the timeline background
43+
* NOTE: If passed, the date prop will be included in the returned time string (e.g. 2017-09-06 01:30:00)
4344
*/
4445
onBackgroundLongPress?: TimelineHoursProps['onBackgroundLongPress'];
4546
/**
4647
* Pass to handle creation of a new event by long press out on the timeline background
48+
* NOTE: If passed, the date prop will be included in the returned time string (e.g. 2017-09-06 01:30:00)
4749
*/
4850
onBackgroundLongPressOut?: TimelineHoursProps['onBackgroundLongPressOut'];
4951
styles?: Theme; //TODO: deprecate (prop renamed 'theme', as in the other components).

0 commit comments

Comments
 (0)