sp-dev-fx-webparts/samples/react-kanban-board/README.md

91 lines
3.2 KiB
Markdown
Raw Normal View History

# React Kanban Board Webpart
## Summary
2020-06-27 17:04:23 -04:00
This solution contains an SPFx webpart which shows a Kanban board using Fluent UI components ([FluentUI](https://developer.microsoft.com/fluentui/)).
The webpart uses the default columns of the SharePoint Tasks list for showing the board's columns and the tasks.
![picture of the web part in action](assets/kanban-board.gif)
## Used SharePoint Framework Version
![drop](https://img.shields.io/badge/version-1.8.2-green.svg)
## Applies to
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
## Prerequisites
This webpart reads the information from a Tasks list and uses the following OOB columns
* Task Name
* Assigned To
* % Complete
* Description
* Priority
* Task Status
2020-06-27 17:04:23 -04:00
The Task list can be chosen using the webpart properties (BaseTemplate 171 or 107)
## Solution
Solution|Author(s)
--------|---------
react-kanban-board | [Ram](https://twitter.com/ram_meenavalli)
react-kanban-board | Daniel Westerdale ([Westerdale Solutions Ltd.](https://westerdale.blog), [@westerdaled](https://twitter.com/westerdaled?s=20))
2020-06-27 17:04:23 -04:00
react-kanban-board | Peter Paul Kirschner ([@petkir_at](https://twitter.com/))
## Version history
Version|Date|Comments
-------|----|--------
1.0.0.0|July 17, 2019|Initial release
1.0.1.0|April 21, 2020|Added support for Teams hosts
2020-06-27 17:04:23 -04:00
2.0.0.0|July 10, 2020| jqwidgets replaced with a custom FluentUI Component and IE11 Support
[Read More about the implementation of this Board](./src/kanban/Readme.md)
## Usage
* PNP Placeholder Control if not Configured
* PNP WebpartTitle Control (Toggle Show/Hide in PropertyPane)
* PNP Order PropertyPane Control (Change Position of Buckets)
* PNP List Selection PropertyPane Control (including Filter on BaseTemplateId)
* Usage of BucketEdit in Pane (Use an Component in PropertyPane (Custom Field))
* Fluent UI
* PNP JS DataConnection to SharePoint
Thanks form @petkir to:
Daniel Westerdale for Testing and inspiration (everytime again)
Hugo Bernier for Inspiration to use Office UI Fabric
Jean-Philippe CIVADE for Bug Report IE11 (initiator of rewrite of this Sample)
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
2020-06-27 17:04:23 -04:00
### only For Version 1
**THIS WEBPART USES jQWidgets FOR SHOWING THE KANBAN BOARD. jQWidgets IS FREE TO USE UNDER THE CREATIVE COMMONS ATTRIBUTION-NONCOMMERCIAL 3.0 LICENSE. FOR COMMERCIAL USE, PLEASE CHECK THE [LICENSING TERMS](https://www.jqwidgets.com/license/) FOR jQWidgets**
---
## Minimal Path to Awesome
* Clone this repository
* in the command line run:
* `npm install`
* `gulp serve`
## Features
This sample highlights the following concepts
2020-06-27 17:04:23 -04:00
* Binding SharePoint list data to an custom Kanban-Control
* Updating SharePoint List Items based on events from the custom Kanban-Control
When a task is moved to different columns in the Kanban Board, the status of the respective SharePoint list item is updated using PnP JS
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-kanban-board" />