Skip to content

Commit 3fc1238

Browse files
authored
Add more documentation
1 parent 5479819 commit 3fc1238

1 file changed

Lines changed: 2 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ eventBus.publish({type: 'ADD_CARD', laneId: 'COMPLETED', card: {id: "M1", title:
111111
//To remove a card
112112
eventBus.publish({type: 'REMOVE_CARD', laneId: 'PLANNED', cardId: "M1"})
113113

114-
//To move a card from one lane to another
114+
//To move a card from one lane to another. index specifies the position to move the card to in the target lane
115115
eventBus.publish({type: 'MOVE_CARD', fromLaneId: 'PLANNED', toLaneId: 'WIP', cardId: 'Plan3', index: 0})
116116

117117
<Board data={data} eventBusHandle={setEventBus}/>
118118
```
119119

120-
The code will move the card `Buy Milk` from the planned lane to completed lane. We expect that this library can be wired to a backend push api that can alter the state of the board in realtime.
120+
The first event in the above example will move the card `Buy Milk` from the planned lane to completed lane. We expect that this library can be wired to a backend push api that can alter the state of the board in realtime.
121121

122122
### Custom Card Styling
123123

@@ -189,8 +189,6 @@ const data = {
189189
}
190190
```
191191

192-
193-
194192
## Editable Board
195193

196194
It is possible to make the entire board editable by setting the `editable` prop to true. This switch prop will enable existing cards to be deleted and show a `Add Card` link at the bottom of each lane, clicking which will show an inline editable new card.

0 commit comments

Comments
 (0)