sp-dev-fx-webparts/samples/js-display-list/README.md

# Display List JavaScript Client-Side Web Part

## Summary
This simplistic sample Web Part demonstrates the use of JavaScript in a SharePoint Framework web part. The properties pane for this web part display a drop down list of lists in the current web. Once the user selects one of the lists, the web part display the contents of the list.


![Screeshot of the Display List web part](./assets/display-list-preview.png).

> Does only show data when hosted in SharePoint. No mock data at this point for local testing the rendering.

## Used SharePoint Framework Version
![drop](https://img.shields.io/badge/drop-GA-green.svg)

## Applies to

* [SharePoint Framework Developer](http://dev.office.com/sharepoint/docs/spfx/sharepoint-framework-overview)
* [Office 365 developer tenant](http://dev.office.com/sharepoint/docs/spfx/set-up-your-developer-tenant)


## Solution

Solution|Author(s)
--------|---------
js-display-list|Naamat Al-Aswad, P.Eng.
Updated to GA Version| Velin Georgiev ([@VelinGeorgiev](https://twitter.com/velingeorgiev))


## Version history

Version|Date|Comments
-------|----|--------
1.0|September 22, 2016|Initial release
1.1|May 15, 2017|Updated to GA Version


## 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.**

---

## Minimal Path to Awesome

- Clone this repository
- in the command line run:
  - `npm install`
  - `tsd install`
  - `gulp serve`
  - `Open the *workbench* on your Office 365 Developer tenant`
      - Basic functionality can be tested locally, data is only shown when used in context of SharePoint

## Features
The js-display-list web part displays the content of the list specified in the web part properties pane.

This Web Part illustrates the following concepts on top of the SharePoint Framework:

* Using a dynamic drop down box in the web part properties pane to display the titles of the lists in the current web
* The use of a Loading Indicator
* Logging
* Rendering error messages.

<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/js-display-list" />
Fixed typos in sample README files. (#265) * Fixed typos in sample README files. * Added missing semicolons 2017-08-11 10:37:53 -04:00			`# Display List JavaScript Client-Side Web Part`
Added the js-display-webpart sample 2016-10-07 10:08:38 -04:00
			`## Summary`
Fixed typos in sample README files. (#265) * Fixed typos in sample README files. * Added missing semicolons 2017-08-11 10:37:53 -04:00			`This simplistic sample Web Part demonstrates the use of JavaScript in a SharePoint Framework web part. The properties pane for this web part display a drop down list of lists in the current web. Once the user selects one of the lists, the web part display the contents of the list.`
Small adjustments on the code and improvements on the readme. 2016-11-04 04:43:11 -04:00
Added the js-display-webpart sample 2016-10-07 10:08:38 -04:00
			`![Screeshot of the Display List web part](./assets/display-list-preview.png).`

Small adjustments on the code and improvements on the readme. 2016-11-04 04:43:11 -04:00			`> Does only show data when hosted in SharePoint. No mock data at this point for local testing the rendering.`

js-display-list sample update from drop3 to GA (#208) * Sample update from drop3 to GA. Packages updated. Unnecessary typings removed. * small fixes on the html and list checks * The loader is removed since causing "Cannot read property 'replaceChild' of null" error. * Return empty array instead of undefined if list not found. The list not found error will be catched. 2017-06-12 06:13:22 -04:00			`## Used SharePoint Framework Version`
			`![drop](https://img.shields.io/badge/drop-GA-green.svg)`
Added SPFx version indicator to readme files for all samples. 2016-12-13 04:26:45 -05:00
Added the js-display-webpart sample 2016-10-07 10:08:38 -04:00			`## Applies to`

js-display-list sample update from drop3 to GA (#208) * Sample update from drop3 to GA. Packages updated. Unnecessary typings removed. * small fixes on the html and list checks * The loader is removed since causing "Cannot read property 'replaceChild' of null" error. * Return empty array instead of undefined if list not found. The list not found error will be catched. 2017-06-12 06:13:22 -04:00			`* [SharePoint Framework Developer](http://dev.office.com/sharepoint/docs/spfx/sharepoint-framework-overview)`
Added the js-display-webpart sample 2016-10-07 10:08:38 -04:00			`* [Office 365 developer tenant](http://dev.office.com/sharepoint/docs/spfx/set-up-your-developer-tenant)`


			`## Solution`

			`Solution\|Author(s)`
			`--------\|---------`
			`js-display-list\|Naamat Al-Aswad, P.Eng.`
js-display-list sample update from drop3 to GA (#208) * Sample update from drop3 to GA. Packages updated. Unnecessary typings removed. * small fixes on the html and list checks * The loader is removed since causing "Cannot read property 'replaceChild' of null" error. * Return empty array instead of undefined if list not found. The list not found error will be catched. 2017-06-12 06:13:22 -04:00			`Updated to GA Version\| Velin Georgiev ([@VelinGeorgiev](https://twitter.com/velingeorgiev))`
Added the js-display-webpart sample 2016-10-07 10:08:38 -04:00

			`## Version history`

			`Version\|Date\|Comments`
			`-------\|----\|--------`
			`1.0\|September 22, 2016\|Initial release`
js-display-list sample update from drop3 to GA (#208) * Sample update from drop3 to GA. Packages updated. Unnecessary typings removed. * small fixes on the html and list checks * The loader is removed since causing "Cannot read property 'replaceChild' of null" error. * Return empty array instead of undefined if list not found. The list not found error will be catched. 2017-06-12 06:13:22 -04:00			`1.1\|May 15, 2017\|Updated to GA Version`
Added the js-display-webpart sample 2016-10-07 10:08:38 -04:00

			`## 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.**`

			`---`

			`## Minimal Path to Awesome`

			`- Clone this repository`
			`- in the command line run:`
			- `npm install`
			- `tsd install`
			- `gulp serve`
			- `Open the workbench on your Office 365 Developer tenant`
Small adjustments on the code and improvements on the readme. 2016-11-04 04:43:11 -04:00			`- Basic functionality can be tested locally, data is only shown when used in context of SharePoint`
Added the js-display-webpart sample 2016-10-07 10:08:38 -04:00
			`## Features`
Small adjustments on the code and improvements on the readme. 2016-11-04 04:43:11 -04:00			`The js-display-list web part displays the content of the list specified in the web part properties pane.`
Added the js-display-webpart sample 2016-10-07 10:08:38 -04:00
			`This Web Part illustrates the following concepts on top of the SharePoint Framework:`

Small adjustments on the code and improvements on the readme. 2016-11-04 04:43:11 -04:00			`* Using a dynamic drop down box in the web part properties pane to display the titles of the lists in the current web`
Added the js-display-webpart sample 2016-10-07 10:08:38 -04:00			`* The use of a Loading Indicator`
			`* Logging`
			`* Rendering error messages.`

			`<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/js-display-list" />`