Updated README
This commit is contained in:
guidozam
parent
e076a65aba
commit
74baf37cb6
|
|
@ -6,35 +6,128 @@ This sample showcase how to handle the navigation between property pane pages.
|
|||
|
||||
|
||||
|
||||
## Used SharePoint Framework Version
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Compatibility
|
||||
|
||||
| :warning: Important |
|
||||
|:---------------------------|
|
||||
| Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to build this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|
||||
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
|
||||
|
||||
This sample is optimally compatible with the following environment configuration:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
||||
|
||||
|
||||
|
||||
|
||||
<!--
|
||||
If using SPFx 1.17.4
|
||||
|
||||
|
||||
|
||||
If using SPFx 1.16
|
||||
|
||||
|
||||
|
||||
If using SPFX 1.14, update the SPFx and Node.js tags as per below:
|
||||
|
||||
|
||||
|
||||
If using SPFx 1.13.1, update the SPFx and Node.js tags accordingly:
|
||||
|
||||
|
||||
If using SPFx 1.12.1, update the SPFx and Node.js tags accordingly:
|
||||
|
||||
|
||||
|
||||
If using an older version of SPFx, update the SPFx and Node.js compatibility tag accordingly:
|
||||
|
||||
SPFx 1.11
|
||||
|
||||
|
||||
|
||||
SPFx 1.10
|
||||
|
||||
|
||||
|
||||
SPFx 1.4.1
|
||||
|
||||
|
||||
|
||||
If you built this sample specifically for SharePoint 2016, or SharePoint 2019 support, update the SharePoint compatibility tag accordingly:
|
||||
|
||||
-Compatible-green.svg)
|
||||
|
||||
If you know your web part only works on the hosted workbench, you can use this for the workbench compatibility tag:
|
||||
|
||||
|
||||
Otherwise:
|
||||
|
||||
|
||||
If your web part needs permissions before working in the hosted workbench, let people know;
|
||||
-yellow.svg "Requires permissions to be granted before this solution can work on the hosted workbench")
|
||||
|
||||
or:
|
||||
|
||||
|
||||
Otherwise:
|
||||
|
||||
|
||||
If you specifically built and tested this web part to work with Teams, use this for the Teams compatibility tag:
|
||||
|
||||
And if you know for sure that it is NOT compatible with Teams, use this:
|
||||
|
||||
|
||||
Don't worry if you're unsure about the compatibility matrix above. We'll verify it when we approve the PR.
|
||||
-->
|
||||
|
||||
## Applies to
|
||||
|
||||
- [SharePoint Framework](https://aka.ms/spfx)
|
||||
- [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
|
||||
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
|
||||
* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
|
||||
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](https://aka.ms/m365/devprogram)
|
||||
|
||||
## Solution
|
||||
## Contributors
|
||||
<!--
|
||||
We use this section to recognize and promote your contributions. Please provide one author per line -- even if you worked together on it.
|
||||
|
||||
| Solution | Author(s) |
|
||||
| ----------- | ------------------------------------------------------- |
|
||||
| react-property-pane-navigation | Guido Zambarda - [PiaSys.com](https://www.piasys.com/) - [@iamguidozam](https://twitter.com/iamguidozam) |
|
||||
We'll only use the info you provided here. Make sure to include your full name, not just your GitHub username.
|
||||
|
||||
Provide a link to your GitHub profile to help others find more cool things you have done. The only link we'll accept is a link to your GitHub profile.
|
||||
|
||||
If you want to provide links to your social media, blog, and employer name, make sure to update your GitHub profile.
|
||||
-->
|
||||
|
||||
* [Guido Zambarda](https://github.com/guidozam)
|
||||
|
||||
## Version history
|
||||
|
||||
| Version | Date | Comments |
|
||||
| ------- | ---------------- | --------------- |
|
||||
| 1.0 | February 27, 2024 | Initial release |
|
||||
Version|Date|Comments
|
||||
-------|----|--------
|
||||
|1.0|February 27, 2024|Initial release|
|
||||
|
||||
## Prerequisites
|
||||
|
||||
---
|
||||
<!--
|
||||
Any special pre-requisites? Include any lists, permissions, offerings to the demo gods, or whatever else needs to be done for this web part to work.
|
||||
|
||||
Please describe the steps to configure the pre-requisites. Feel free to add screen shots, but make sure that there is a text description of the steps to perform.
|
||||
|
||||
-->
|
||||
|
||||
## Minimal path to awesome
|
||||
|
||||
|
||||
* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-property-pane-navigation) then unzip it)
|
||||
* From your command line, change your current directory to the directory containing this sample (`react-property-pane-navigation`, located under `samples`)
|
||||
* in the command line run:
|
||||
|
|
@ -43,7 +136,6 @@ This sample showcase how to handle the navigation between property pane pages.
|
|||
|
||||
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit <https://aka.ms/spfx-devcontainer> for further instructions.
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
This sample showcase how to handle the navigation between property pane pages using the web part `getPropertyPaneConfiguration` method like the following:
|
||||
|
|
@ -69,12 +161,6 @@ protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
|
|||
|
||||
Each element in the `pages` array represents a property pane page, the SharePoint Framework will enable navigation and will render the pages in the order they are defined in the array. The first page in the array will be the first page to be rendered, and so on.
|
||||
|
||||
## References
|
||||
|
||||
- [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
|
||||
- [Integrate web part properties with SharePoint](https://learn.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/integrate-web-part-properties-with-sharepoint)
|
||||
- [Make your SharePoint client-side web part configurable](https://learn.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/basics/integrate-with-property-pane)
|
||||
- [Validate web part property values](https://learn.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/validate-web-part-property-values)
|
||||
|
||||
<!--
|
||||
RESERVED FOR REPO MAINTAINERS
|
||||
|
|
@ -86,8 +172,44 @@ We'll add the video from the community call recording here
|
|||
[](https://www.youtube.com/watch?v=XXXXX "YouTube video title")
|
||||
-->
|
||||
|
||||
## Help
|
||||
|
||||
<!--
|
||||
You can just search and replace this page with the following values:
|
||||
|
||||
Search for:
|
||||
react-property-pane-navigation
|
||||
|
||||
Replace with your sample folder name. E.g.: react-my-cool-sample
|
||||
|
||||
Search for:
|
||||
@YOURGITHUBUSERNAME
|
||||
|
||||
Replace with your GitHub username, prefixed with an "@". If you have more than one author, use %20 to separate them, making sure to prefix everyone's username individually with an "@".
|
||||
|
||||
Example:
|
||||
@hugoabernier
|
||||
|
||||
Or:
|
||||
@hugoabernier%20@VesaJuvonen%20@PopWarner
|
||||
-->
|
||||
|
||||
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
|
||||
|
||||
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
|
||||
|
||||
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-property-pane-navigation%22) to see if anybody else is having the same issues.
|
||||
|
||||
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-property-pane-navigation) and see what the community is saying.
|
||||
|
||||
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-property-pane-navigation&template=bug-report.yml&sample=react-property-pane-navigation&authors=@guidozam&title=react-property-pane-navigation%20-%20).
|
||||
|
||||
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-property-pane-navigation&template=question.yml&sample=react-property-pane-navigation&authors=@guidozam&title=react-property-pane-navigation%20-%20).
|
||||
|
||||
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-property-pane-navigation&template=suggestion.yml&sample=react-property-pane-navigation&authors=@guidozam&title=react-property-pane-navigation%20-%20).
|
||||
|
||||
## 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.**
|
||||
|
||||
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-property-pane-navigation" />
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 486 KiB After Width: | Height: | Size: 243 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 243 KiB |
Loading…
Reference in New Issue