react-image-timeline
Advanced tools
Comparing version 0.1.9 to 0.2.0
{ | ||
"name": "react-image-timeline", | ||
"version": "0.1.9", | ||
"version": "0.2.0", | ||
"description": "react-image-timeline", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -17,2 +17,6 @@ #React Image Timeline | ||
####Screenshot | ||
![screenshot](https://github.com/aaron9000/react-image-timeline/blob/master/assets/screenshot.png) | ||
####Add to Existing Project | ||
@@ -38,18 +42,25 @@ - `npm install moment --save` if needed | ||
####Props | ||
- `events`: **array** (required) | ||
- `date`: **date** (required) | ||
- `title`: **string** (required) | ||
- `imageUrl`: **string** (required) | ||
- `text`: **string** (required) | ||
- `onClick`: **function** | ||
- `buttonText`: **string** | ||
- `extras`: **object** | ||
- `reverseOrder`: **boolean** | ||
- `customStartLabel`: **component** | ||
- `customEndLabel`: **component** | ||
- `customHeader`: **component** | ||
- `customImageBody`: **component** | ||
- `customTextBody`: **component** | ||
- `customFooter`: **component** | ||
Key | Type | Required | ||
--------------------------|--------------------------|-------------------------- | ||
` events` | ` array<Event>` | ` required` | ||
` reverseOrder` | ` boolean` | | ||
` customStartLabel` | ` component` | | ||
` customEndLabel` | ` component` | | ||
` customHeader` | ` component` | | ||
` customImageBody` | ` component` | | ||
` customTextBody` | ` component` | | ||
` customFooter` | ` component` | | ||
####Event | ||
Key | Type | Required | ||
--------------------------|--------------------------|-------------------------- | ||
` date` | ` date` | ` required` | ||
` title` | ` string` | ` required` | ||
` imageUrl` | ` string` | ` required` | ||
` text` | ` string` | ` required` | ||
` onClick` | ` function` | | ||
` buttonText` | ` string` | | ||
` extras` | ` object` | | ||
####Custom Event Data | ||
@@ -99,3 +110,1 @@ To pass extra data into custom components, use the `extras` field on the `event` model. | ||
####Screenshot | ||
![screenshot](https://github.com/aaron9000/react-image-timeline/blob/master/assets/screenshot.png) |
31855
108