npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@appleple/react-trello

v1.0.11

Published

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

Downloads

47

Readme

react-trello

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

Feature Showcase

Storybook

Features

alt tag

  • responsive and extensible
  • easily pluggable into existing application
  • supports pagination when scrolling individual lanes
  • drag-and-drop cards and lanes (compatible with touch devices)
  • event bus for triggering events externally (e.g.: adding or removing cards based on events coming from backend)
  • edit functionality to add/delete cards
  • Parameterised templates to customize lane and card appearance

Getting Started

Install using npm or yarn

$ npm install --save react-trello

or

$ yarn add 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 passed 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://appleple.github.io/react-trello/

Documentation

Board

This is the container component that encapsulates the lanes and cards

| Name | Type | Description | | ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | | draggable | boolean | Makes all cards and lanes draggable. Default: false | | laneDraggable | boolean | Set to false to disable lane dragging. Default: true | | cardDraggable | boolean | Set to false to disable card dragging. Default: true | | collapsibleLanes | boolean | Make the lanes with cards collapsible. Default: false | | editable | boolean | Makes the entire board editable. Allow cards to be added or deleted Default: false | | canAddLanes | boolean | Allows new lanes to be added to the board. Default: false | | addLaneTitle | string | Changes add lane button description. 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, cardDetails) | | handleLaneDragStart | function | Callback function triggered when lane drag is started: handleLaneDragStart(laneId) | | handleLaneDragEnd | function | Callback function triggered when lane drag ends: handleLaneDragEnd(laneId, newPosition, payload) | | cardDragClass | string | CSS class to be applied to Card when being dragged | | laneDragClass | string | CSS class to be applied to Lane when being dragged | | 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 | boolean | 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

const 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"})

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

//To update the lanes
eventBus.publish({type: 'UPDATE_LANES', lanes: newLaneData})

<Board data={data} eventBusHandle={setEventBus}/>

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.

Styling

There are two ways to apply styles to the library components including Board, Lane or Card:

  • Use the predefined css classnames attached to these elements that go by .react-trello-lane, .react-trello-card, .react-trello-board
  • You can also pass custom style attributes as part of data. Refer to the storybook for examples

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}
        }
      ]
    }
  ]
}

Editable Board

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.

Check out the editable board story and its corresponding source code for more details.

Development

cd react-trello/
npm ci
npm run storybook

License

MIT