sp-dev-fx-webparts/samples/react-advanced-page-properties/README.md

6.0 KiB

Advanced Page Properties

Summary

Attempts to replicate the functionality of Page Properties with the following improvements:

  • Support for theme variants
  • Updated to standard capsule look for list options
  • Support for image fields
  • Support for hyperlink fields
  • Support for currency
  • Improved support for dates
  • Support for Multiline text fields

see the difference

Compatibility

⚠️ 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:

SPFx 1.16.1 Node.js v16 | 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

Get your own free development tenant by subscribing to Microsoft 365 developer program

Prerequisites

None

Contributors

Version history

Version Date Comments
1.0.0 March 30, 2021 Initial release
1.0.1 September 22, 2021 Added support for multi-language sites
1.0.2 December 24, 2021 Fix retrieving fields from SitePages
1.0.3 January 12, 2022 Fix formatting of date, number and currency values
1.0.5 June 05, 2023 Support for Multiline text fields

Minimal Path to Awesome

  • Clone this repository
  • Ensure that you are at the solution folder
  • in the command-line run:
    • npm install
    • gulp serve

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

Features

Add the part

Once the solution is installed in the app catalog and the app has been added to the site, you should see it available to a page.

add the part

Familiarity is key

This web part tries to mimic the original Page Properties web part as much as possible. You should recognize the functionality of the property setup.

Basically add and remove properties until you are satisfied and you're good to go!

configure the part

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.