honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update readme (#828)

This commit is contained in:
Joel Rodrigues 2019-04-08 10:38:57 +01:00 committed by Vesa Juvonen
parent 84d573def0
commit 553ecbfeeb
1 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
samples/react-visio/README.md
View File

@ -4,8 +4,6 @@
This sample shows how the [Visio JavaScript APIs](https://dev.office.com/reference/add-ins/visio/visio-javascript-reference-overview) can be used within a web part. For sample purposes, this web part will display the name and the hyperlinks of a Visio shape when the user selects it.
To test the web part, upload the sample file provided to a SharePoint document library. Then open the file on the Visio web client and copy the Url from the browser. Add that url on the web part properties field and the EmbeddedSession will start and display the diagram.
![Demo](./assets/Preview.PNG)
## Used SharePoint Framework Version
@ -14,44 +12,49 @@ To test the web part, upload the sample file provided to a SharePoint document l
## Applies to
* [SharePoint Framework](https:/dev.office.com/sharepoint)
* [Visio JavaScript APIs](https://dev.office.com/reference/add-ins/visio/visio-javascript-reference-overview)
- [SharePoint Framework](https:/dev.office.com/sharepoint)
- [Visio JavaScript APIs](https://dev.office.com/reference/add-ins/visio/visio-javascript-reference-overview)
## Prerequisites
* Office 365 subscription with SharePoint Online licence
* SharePoint Framework [development environment](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment) already set up.
- Office 365 subscription with SharePoint Online licence
- SharePoint Framework [development environment](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment) already set up.
## Solution
Solution|Author(s)
--------|---------
react-visio|Joel Rodrigues
| Solution | Author(s) |
| ----------- | -------------- |
| react-visio | Joel Rodrigues |
## Version history
Version|Date|Comments
-------|----|--------
1.2|January 4, 2019|Update to SPFx 1.7.1
1.1|October 3, 2018|Update to SPFx 1.6.0
1.0|August 23, 2018|Initial release
| Version | Date | Comments |
| ------- | --------------- | -------------------- |
| 1.3 | April 4, 2019 | Update readme |
| 1.2 | January 4, 2019 | Update to SPFx 1.7.1 |
| 1.1 | October 3, 2018 | Update to SPFx 1.6.0 |
| 1.0 | August 23, 2018 | 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.**
**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`
* `gulp serve`
- clone this repository
- in the command line run:
- `npm install`
- `gulp serve --nobrowser`
- upload a sample Visio file to a SharePoint document library
- open the file on the Visio web client and copy the Url from the browser
- navigate to the hosted version of SharePoint workbench, eg. https://contoso.sharepoint.com/sites/test/_layouts/15/workbench.aspx
- add the url on the web part properties field and the EmbeddedSession will start and display the diagram
## Features
This Web Part illustrates the following concepts on top of the SharePoint Framework:
* Using the Visio JavaScript APIs to embed a diagram on a page
* Using the Visio JavaScript APIs to interact with the Visio diagram and data available
- Using the Visio JavaScript APIs to embed a diagram on a page
- Using the Visio JavaScript APIs to interact with the Visio diagram and data available