sp-dev-fx-webparts/samples/jquery-photopile/README.md

86 lines
2.8 KiB
Markdown
Raw Normal View History

2020-02-14 18:28:03 -05:00
---
page_type: sample
products:
- office-sp
- office-365
languages:
- javascript
- typescript
extensions:
contentType: samples
technologies:
- SharePoint Framework
- Office UI Fabric
platforms:
- JQuery
createdDate: 1/1/2016 12:00:00 AM
---
React Content Query : Added configurable external scripts and external block helpers (#285) * Added the files to the new repository * Modified the .gitignore * Added the generated sppkg file * Added animated gifs for the read me. * Added another animated gif * Added a first temporary version of the readme.md * Update README.md * Update README.md * Updated the readme.md file by removing spaces between brackets in the handlebars templates examples. * Updated the WebPart with inline template editing Added inline template editing within the toolpane, automatic template generation and fixed a bug related to the "Me" checkbox while filtering user fields. * Removed the debug folder from sources * Updated the toolpart animated gif * Removed toolpart animated gif * Updated the README.md file with the latest changes. * Update README.md * Update README.md * Update README.md * Adding AceEditor as Code Editor * Removing old Monato Artefacts * Finalized the code editor update Added documentation for the code editor, fixed the npm-shrinkwrap to support the code editor dependencies, updated images for the new documentation, regenerated the .sppkg file and updated the sources on the public CDN for version 1.0.1 * Added a .gif for the new code editor documentation * Updated the WebPart with the latest spfx packages. Multiple bottle-neck bugs have been fixed in SPFX which allows to update the WebPart with the latest SPFX packages. Overall performance should now be better and other minor bugs have been fixed. * ... * Updated the readme * Updated the readme with the solution author * Added the External Scripts property to the toolpart The new External Scripts property allows the user to add external JavaScript files to the WebPart that can run precisely before or after the rendering of the template. * Fixed the readme.md imaged broke in the previous commit * Added the ExternalScripts.png picture to readme.md * Updated readme.md * Update the externalScripts image.
2017-08-14 02:49:21 -04:00
# JQuery, Photopile.JS & Office UI Fabric Client-Side Web Part
## Summary
This is a sample web part that illustrated the use of JQuery and [Photopile.Js](https://github.com/bigbhowell/Photopile-JS)
with the SharePoint Framework.
With this web part you can display the photos contained in a SharePoint pictures library and it
simulates a pile of photos scattered about on a surface. Thumbnail clicks remove photos from the pile,
(enlarging them as if being picked up by the user) and once in view a second click returns the photo to the pile.
![Photopile Web Part displayed in SharePoint Workbench](./assets/photopileoverview.gif)
## Used SharePoint Framework Version
![drop](https://img.shields.io/badge/drop-drop1-red.svg)
## Applies to
* [SharePoint Framework Developer Preview](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)
React Content Query : Added configurable external scripts and external block helpers (#285) * Added the files to the new repository * Modified the .gitignore * Added the generated sppkg file * Added animated gifs for the read me. * Added another animated gif * Added a first temporary version of the readme.md * Update README.md * Update README.md * Updated the readme.md file by removing spaces between brackets in the handlebars templates examples. * Updated the WebPart with inline template editing Added inline template editing within the toolpane, automatic template generation and fixed a bug related to the "Me" checkbox while filtering user fields. * Removed the debug folder from sources * Updated the toolpart animated gif * Removed toolpart animated gif * Updated the README.md file with the latest changes. * Update README.md * Update README.md * Update README.md * Adding AceEditor as Code Editor * Removing old Monato Artefacts * Finalized the code editor update Added documentation for the code editor, fixed the npm-shrinkwrap to support the code editor dependencies, updated images for the new documentation, regenerated the .sppkg file and updated the sources on the public CDN for version 1.0.1 * Added a .gif for the new code editor documentation * Updated the WebPart with the latest spfx packages. Multiple bottle-neck bugs have been fixed in SPFX which allows to update the WebPart with the latest SPFX packages. Overall performance should now be better and other minor bugs have been fixed. * ... * Updated the readme * Updated the readme with the solution author * Added the External Scripts property to the toolpart The new External Scripts property allows the user to add external JavaScript files to the WebPart that can run precisely before or after the rendering of the template. * Fixed the readme.md imaged broke in the previous commit * Added the ExternalScripts.png picture to readme.md * Updated readme.md * Update the externalScripts image.
2017-08-14 02:49:21 -04:00
## Solution
Solution|Author(s)
--------|---------
jquery-photopile|Olivier Carpentier (@olivierc)
## Version history
Version|Date|Comments
-------|----|--------
1.0|September 9, 2016|Initial release
## 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 repo
- in the command line run:
- `npm install`
- `tsd install`
- `gulp serve`
## Features
This web part uses React, Office UI Fabric, JQuery, JQuery UI and Photopile.js. This web part is available in English (en-us)
and French (fr-fr).
It is able to:
* List picture libraries contained in the current SharePoint web site
* List all the pictures in the selected List
* Render the pictures as a cool photopile
* Personalize the layout thanks to editable settings
This web part illustrates the following concepts on top of the SharePoint Framework:
* Include JQuery and external framework in your solution
* Implement rich web part properties panel with controls like DropDown, Sliders, Toggle, etc.
* Load dynamic data from SharePoint as web part properties
* Load dynamic data from SharePoint REST Services, as lists or items
* Implement mock system to test your solution in the local workbench or on a SharePoint site
* Include Office UI Fabric controls in your project
* Render content with React
* Etc.
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/jquery-photopile" />