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
sp-dev-fx-webparts/samples/react-page-sections-navigation/README.md

5.7 KiB
Raw Blame History

Page Sections Navigation

Sample web parts allowing to add sections navigation to the SharePoint page.

Navigation configuration

Compatibility

SPFx 1.14 Node.js v14 | v12 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Solution

Solution Author(s)
page-sections-navigation Alex Terentiev (MVP, Sharepointalist Inc., @alexaterentiev)

Version history

Version Date Comments
1.0 February 27, 2019 Initial release
1.1 March 22, 2019 Update to SPFx 1.8, additional theme, comments
1.2 April 25, 2022 Update to SPFx 1.14.0

Minimal Path to Awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)
  • From your command line, change your current directory to the directory containing this sample (react-page-sections-navigation, located under samples)
  • in the command line run:
    • npm install
    • gulp bundle --ship
    • gulp package-solution --ship
  • from the sharepoint/solution folder, deploy the .sppkg file to the App catalog in your tenant
  • in the site where you want to test this solution
    • add the app named page-sections-navigation-client-side-solution
    • edit a page
    • add Page Sections Navigation web part
    • add as much Page Sections Navigation Anchor web parts as you want - each anchor adds an item to the navigation
    • configure web parts

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

This sample illustrates how to use SharePoint Framework Dynamic Data features to connect web parts on the page. It also can be used as ready-to-go solution to add page sections navigation to SharePoint pages.

Custom CSS

The web parts in the sample allow to use custom CSS to override the styles. You can set Custom CSS URL property of Page Sections Navigation web part and include css classes for both Navigation and Anchor in referenced file. Please, refer custom css sample for the CSS sample.

Help

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 from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.