sp-dev-fx-webparts/tutorials/tutorial-migrate-datatables/README.md

3.9 KiB

Tutorial: Migrate jQuery and DataTables solution built using Script Editor Web Part to SharePoint Framework

Sample jQuery DataTables solution migrated from a Script Editor Web Part to the SharePoint Framework.

jQuery DataTables solution built using Script Editor Web Part

Sub folders represent the different stages of the migration process. Each folder contains the complete solution that you can run in browser. More information about the solution is available at https://docs.microsoft.com/sharepoint/dev/spfx/web-parts/guidance/migrate-jquery-datatables-script-to-spfx.

Folder Stage More information
01-migrated-sewp-to-spfx Original solution migrated to SPFx. As much as possible of the original code left unaltered details
02-added-configuration Extended the code with support for configuring the web part through the property pane details
03-transformed-js-to-typescript Transformed plain JavaScript to TypeScript details

Used SharePoint Framework Version

v1.10.0

Applies to

Solution

Solution Author(s)
tutorial-migrate-datatables Waldek Mastykarz (MVP, Rencore, @waldekm) & Andrew Connell (MVP, Voitanos, @andrewconnell)

Version history

Version Date Comments
1.0.0 June 27, 2017 Initial commit
1.1.0 June 28, 2017 Updated tutorial code for SPFx v1.10

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.


Build and run the tutorials

To build and run this client-side project, you will need to clone and build the tutorials project. Because the solution retrieves its data from SharePoint, you will also need a custom list named IT Requests with some data in it. To preview the web part use the hosted version of the SharePoint Workbench loaded in the context of the site where the Tasks list is located.

Clone this repo by executing the following command in your console:

git clone https://github.com/pnp/sp-dev-fx-webparts.git

Navigate to the cloned repo folder which should be the same as the repo name:

cd sp-dev-fx-webparts

Navigate to the tutorials-migrate-datatables folder:

cd tutorials

Navigate to the specific web part folder:

cd 'subfolder'

Now run the following command to install the npm packages:

npm install

This will install the required npm packages and dependencies to build and run the SharePoint Framework project.

Once the npm packages are installed, run the command to preview your web parts in SharePoint Workbench:

gulp serve --nobrowser