Skip to content

Commit

Permalink
Merge pull request #80 from dkniffin/patch-1
Browse files Browse the repository at this point in the history 
Fix table formatting
  • Loading branch information
@rcdexta
rcdexta authored Mar 20, 2018
2 parents cf19f63 + da4c289 commit 9d8e461
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,28 +70,28 @@ Also please refer to this sample project that uses react-trello for usage: https

This is the container component that encapsulates the lanes and cards

| Name | Type | Description |
| --------------------- | -------- | ---------------------------------------- |
| draggable | boolean | Makes all cards in the lanes draggable. Default: false |
| editable | boolean | Makes the entire board editable. Allow cards to be added or deleted Default: false |
| handleDragStart | function | Callback function triggered when card drag is started: `handleDragStart(cardId, laneId)` |
| handleDragEnd | function | Callback function triggered when card drag ends: `handleDragEnd(cardId, sourceLaneId, targetLaneId, position)` |
| onLaneScroll | function | Called when a lane is scrolled to the end: `onLaneScroll(requestedPage, laneId)` |
| onCardClick | function | Called when a card is clicked: `onCardClick(cardId, metadata, laneId) ` |
| onCardAdd | function | Called when a new card is added: `onCardAdd(card, laneId) ` |
| addCardLink | node | Pass custom element to replace the `Add Card` link at the end of the lane (when board is editable) |
| newCardTemplate | node | Pass a custom new card template to add new cards to a lane (when board is editable) |
| hideCardDeleteIcon | boolean | Disable showing the delete icon to the top right corner of the card (when board is editable) |
| onCardDelete | function | Called when a card is deleted: `onCardDelete(cardId, laneId) ` |
| onLaneClick | function | Called when a lane is clicked: `onLaneClick(laneId) `. Card clicks are not propagated to lane click event |
| laneSortFunction | function | Used to specify the logic to sort cards on a lane: `laneSortFunction(card1, card2)` |
| eventBusHandle | function | This is a special function that providers a publishHook to pass new events to the board. See details in Publish Events section |
| onDataChange | function | Called everytime the data changes due to user interaction or event bus: `onDataChange(newData)` |
| style | object | Pass css style props to board container |
| customCardLayout | function | Boolean to indicate a custom card template will be specified. Add the card component as child to Board |
| customLaneHeader | element | Pass custom lane header as react component to modify appearance |
| data | object | Actual board data in the form of json |
| tagStyle | object | If cards have tags, use this prop to modify their style |
| Name | Type | Description |
| --------------------- | -------- | ---------------------------------------- |
| draggable | boolean | Makes all cards in the lanes draggable. Default: false |
| editable | boolean | Makes the entire board editable. Allow cards to be added or deleted Default: false |
| handleDragStart | function | Callback function triggered when card drag is started: `handleDragStart(cardId, laneId)` |
| handleDragEnd | function | Callback function triggered when card drag ends: `handleDragEnd(cardId, sourceLaneId, targetLaneId, position)` |
| onLaneScroll | function | Called when a lane is scrolled to the end: `onLaneScroll(requestedPage, laneId)` |
| onCardClick | function | Called when a card is clicked: `onCardClick(cardId, metadata, laneId) ` |
| onCardAdd | function | Called when a new card is added: `onCardAdd(card, laneId) ` |
| addCardLink | node | Pass custom element to replace the `Add Card` link at the end of the lane (when board is editable) |
| newCardTemplate | node | Pass a custom new card template to add new cards to a lane (when board is editable) |
| hideCardDeleteIcon | boolean | Disable showing the delete icon to the top right corner of the card (when board is editable) |
| onCardDelete | function | Called when a card is deleted: `onCardDelete(cardId, laneId) ` |
| onLaneClick | function | Called when a lane is clicked: `onLaneClick(laneId) `. Card clicks are not propagated to lane click event |
| laneSortFunction | function | Used to specify the logic to sort cards on a lane: `laneSortFunction(card1, card2)` |
| eventBusHandle | function | This is a special function that providers a publishHook to pass new events to the board. See details in Publish Events section |
| onDataChange | function | Called everytime the data changes due to user interaction or event bus: `onDataChange(newData)` |
| style | object | Pass css style props to board container |
| customCardLayout | function | Boolean to indicate a custom card template will be specified. Add the card component as child to Board |
| customLaneHeader | element | Pass custom lane header as react component to modify appearance |
| data | object | Actual board data in the form of json |
| tagStyle | object | If cards have tags, use this prop to modify their style |

Refer to `stories` folder for examples on many more options for customization.

Expand Down

0 comments on commit 9d8e461

Please sign in to comment.