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

81 lines
2.5 KiB
Markdown
Raw Normal View History

---
page_type: sample
products:
- office-sp
languages:
- javascript
- typescript
extensions:
contentType: samples
technologies:
- SharePoint Framework
createdDate: 5/15/2017 12:00:00 AM
---
# Display List JavaScript Client-Side Web Part
2016-10-07 10:08:38 -04:00
## Summary
2020-08-29 16:46:33 -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.
![Screenshot of the Display List web part](./assets/display-list-preview.png).
2016-10-07 10:08:38 -04:00
> Does only show data when hosted in SharePoint. No mock data at this point for local testing the rendering.
## Used SharePoint Framework Version
2020-08-29 16:46:33 -04:00
![SPFx 1.11.0](https://img.shields.io/badge/drop-1.11.0-green.svg)
2016-10-07 10:08:38 -04:00
## Applies to
* [SharePoint Framework Developer](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 developer tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
2016-10-07 10:08:38 -04:00
## Solution
Solution|Author(s)
--------|---------
2020-08-29 16:46:33 -04:00
js-display-list| Naamat Al-Aswad, P.Eng.
js-display-list| Velin Georgiev ([@VelinGeorgiev](https://twitter.com/velingeorgiev)) (Updated to GA Version)
js-display-list| Ryan Schouten ([@ShrPntKnight](https://twitter.com/ShrPntKnight)) (Upgraded to SPFx 1.11.0)
2016-10-07 10:08:38 -04:00
## Version history
Version|Date|Comments
-------|----|--------
1.0|September 22, 2016|Initial release
1.1|May 15, 2017|Updated to GA Version
2020-08-29 16:46:33 -04:00
2.0|August 29, 2020|Upgraded to SPFx 1.11.0
2016-10-07 10:08:38 -04:00
## Disclaimer
2020-08-29 16:46:33 -04:00
2016-10-07 10:08:38 -04:00
**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
2016-10-07 10:08:38 -04:00
## Features
2020-08-29 16:46:33 -04:00
The js-display-list web part displays the content of the list specified in the web part properties pane.
2016-10-07 10:08:38 -04:00
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
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" />