react-trello-fork

react-trello

Pluggable components to add a trello like kanban board to your application

Features

• responsive and extensible
• easily pluggable into existing application
• supports pagination when scrolling individual lanes
• drag-and-drop within and across lanes (compatible with touch devices)
• event bus for triggering events externally (e.g.: adding or removing cards based on events coming from backend)

Getting Started

npm install --save react-trello

Usage

The Board component takes a prop called data that contains all the details related to rendering the board. A sample data json is given here to illustrate the contract:

const data = {
  lanes: [
    {
      id: 'lane1',
      title: 'Planned Tasks',
      label: '2/2',
      cards: [
        {id: 'Card1', title: 'Write Blog', description: 'Can AI make memes', label: '30 mins'},
	    {id: 'Card2', title: 'Pay Rent', description: 'Transfer via NEFT', label: '5 mins', metadata: {sha: 'be312a1'}}
      ]
    },
    {
      id: 'lane2',
      title: 'Completed',
      label: '0/0',
      cards: []
    }
  ]
}

The data is fed to the board component and that's it.

import React from 'react'
import Board from 'react-trello'

export default class App extends React.Component {
	render() {
		return  <Board data={data} />
	}
}

Refer to storybook for detailed examples: https://rcdexta.github.io/react-trello/

Also please refer to this sample project that uses react-trello for usage: https://github.com/rcdexta/react-trello-example

Documentation

Board

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
droppable	boolean	Makes a lane draggable. Default: true
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)
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)
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.

Publish Events

When defining the board, it is possible to obtain a event hook to the component to publish new events later after the board has been rendered. Refer the example below:

let eventBus = undefined

let setEventBus = (handle) => {
  eventBus = handle
}
//To add a card
eventBus.publish({type: 'ADD_CARD', laneId: 'COMPLETED', card: {id: "M1", title: "Buy Milk", label: "15 mins", description: "Also set reminder"}})

//To remove a card
eventBus.publish({type: 'REMOVE_CARD', laneId: 'PLANNED', cardId: "M1"})
  
<Board data={data}
       eventBusHandle={setEventBus}/>

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.

Custom Card Styling

You can completely customize the look-and-feel of each card in any lane by passing in a custom component as child to the Board as seen below:

<Board data={data} customCardLayout>
      <CustomCard />
</Board>

customCardLayout prop must be set to true for the custom card to be rendered

The json content for the card and the card template must agree on the props:

const CustomCard = props => {
  return (
    <div>
      <header
        style={{borderBottom: '1px solid #eee', paddingBottom: 6, marginBottom: 10,
    		 display: 'flex', flexDirection: 'row', justifyContent: 'space-between',
			color: props.cardColor
        }}
      >
        <div style={{ fontSize: 14, fontWeight: 'bold' }}>{props.name}</div>
        <div style={{ fontSize: 11 }}>{props.dueOn}</div>
      </header>
      <div style={{ fontSize: 12, color: '#BD3B36' }}>
        <div style={{ color: '#4C4C4C', fontWeight: 'bold' }}>{props.subTitle}</div>
        <div style={{ padding: '5px 0px' }}><i>{props.body}</i></div>
        <div style={{ marginTop: 10, textAlign: 'center', color: props.cardColor, fontSize: 15, fontWeight: 'bold' }}>
          {props.escalationText}
        </div>
      </div>
    </div>
  )
}

const data = {
    lanes: [
      {
        id: 'lane1',
        title: 'Planned Tasks',
        cards: [
          {
            id: 'Card1',
            name: 'John Smith',
            dueOn: 'due in a day',
            subTitle: 'SMS received at 12:13pm today',
            body: 'Thanks. Please schedule me for an estimate on Monday.',
            escalationText: 'Escalated to OPS-ESCALATIONS!',
            cardColor: '#BD3B36',
            cardStyle: { borderRadius: 6, boxShadow: '0 0 6px 1px #BD3B36', marginBottom: 15 }
          },
          {
            id: 'Card2',
            name: 'Card Weathers',
            dueOn: 'due now',
            subTitle: 'Email received at 1:14pm',
            body: 'Is the estimate free, and can someone call me soon?',
            escalationText: 'Escalated to Admin',
            cardColor: '#E08521',
            cardStyle: { borderRadius: 6, boxShadow: '0 0 6px 1px #E08521', marginBottom: 15 }
          }
        ]
      }
    ]
  }

Development

cd react-trello/
yarn install
yarn run storybook

Scripts

• npm run lint : Lint all js files
• npm run lintfix : fix linting errors of all js files
• npm run semantic-release : make a release. Leave it for CI to do.
• npm run storybook: Start developing by using storybook
• npm run test : Run tests. tests file should be written as *.test.js and using ES2015
• npm run test:watch : Watch tests while writing
• npm run test:cover : Show coverage report of your tests
• npm run test:report : Report test coverage to codecov.io. Leave this for CI
• npm run build: transpile all ES6 component files into ES5(commonjs) and put it in dist directory
• npm run docs: create static build of storybook in docs directory that can be used for github pages

Learn how to write stories here

License

MIT