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

95 lines
5.2 KiB
Markdown
Raw Normal View History

2023-09-23 19:27:04 -04:00
# Enhanced Page Properties
2023-07-28 11:30:51 -04:00
## Summary
2023-09-23 19:27:04 -04:00
This is a web part that goes beyond the standard SharePoint Page Properties web part, offering expanded support for various metadata types and configurations. Effortlessly display key page details based on metadata files, providing a comprehensive view of your content. Streamline information management and enhance user interaction with this versatile and customizable web part.
2023-07-28 11:30:51 -04:00
2023-10-10 11:31:14 -04:00
Currently support following types:
2023-10-10 11:31:14 -04:00
- Single line text
- Multiple line text
- Choice
- Date
2023-09-23 19:27:04 -04:00
### Configuration
2023-09-26 23:06:18 -04:00
- **Title**: Allow to set the displayed title. The built in SharePoint Page Properties web part doesn't allow user to change the displayed title. It will always be **Properties**
2023-09-23 19:27:04 -04:00
- **Fields**: Allow to display multiple fields separated by comma (this will be improved in the future). It's already support multiple line type. The built in SharePoint Page Properties web part doesn't support it.
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
### Plan for next version
2023-09-26 23:06:18 -04:00
2023-10-10 11:31:14 -04:00
- Support taxonomy field view
2023-09-23 19:27:04 -04:00
- Support people field view
2023-10-10 11:31:14 -04:00
- Support lookup field view
- Support currency field view
- Support hyperlink field view
- Support image field view
2023-09-23 19:27:04 -04:00
- Improve web part configuration
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
![Web part](assets/app.png)
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
## Compatibility
2023-07-28 11:30:51 -04:00
2023-10-28 22:37:46 -04:00
![SPFx 1.18.0](https://img.shields.io/badge/SPFx-1.18.0-green.svg)
![Node.js v18](https://img.shields.io/badge/Node.js-v18-green.svg)
2023-09-23 19:27:04 -04:00
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
## Applies to
2023-07-28 11:30:51 -04:00
2023-09-26 23:06:18 -04:00
- [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
- [Microsoft 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
2023-07-28 11:30:51 -04:00
2023-10-23 13:00:06 -04:00
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](https://aka.ms/m365devprogram)
2023-07-28 11:30:51 -04:00
2023-09-26 23:06:18 -04:00
## Contributors
2023-07-28 11:30:51 -04:00
2023-09-26 23:06:18 -04:00
- [Ari Gunawan](https://github.com/AriGunawan)
2023-07-28 11:30:51 -04:00
## Version history
2023-09-23 19:27:04 -04:00
Version|Date|Comments
-------|----|--------
2023-10-28 22:37:46 -04:00
1.2|October 29, 2023|Upgrade SPFx version to 1.18
2023-10-10 11:31:14 -04:00
1.1|October 23, 2023|Add support for choice and date fields
2023-09-23 19:27:04 -04:00
1.0|September 23, 2023|Initial release
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
## Minimal path to awesome
2023-07-28 11:30:51 -04:00
2023-09-26 23:06:18 -04:00
- 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-enhanced-page-properties) then unzip it)
- From your command line, change your current directory to the directory containing this sample (`react-enhanced-page-properties`, located under `samples`)
- in the command line run:
- `npm install`
- `gulp serve`
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
> 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.
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
## Features
2023-07-28 11:30:51 -04:00
2023-09-26 23:06:18 -04:00
- Show page metadata
- Set displayed title
- Set displayed fields
- Show warning message if the fields is not exist
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
## Help
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
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.
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
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-enhanced-page-properties%22) to see if anybody else is having the same issues.
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-enhanced-page-properties) and see what the community is saying.
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
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-enhanced-page-properties&template=bug-report.yml&sample=react-enhanced-page-properties&authors=@AriGunawan&title=react-enhanced-page-properties%20-%20).
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
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-enhanced-page-properties&template=question.yml&sample=react-enhanced-page-properties&authors=@AriGunawan&title=react-enhanced-page-properties%20-%20).
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
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-enhanced-page-properties&template=suggestion.yml&sample=react-enhanced-page-properties&authors=@AriGunawan&title=react-enhanced-page-properties%20-%20).
## Disclaimer
2023-07-28 11:30:51 -04:00
2023-09-23 19:27:04 -04:00
**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.**
2023-07-28 11:30:51 -04:00
2023-09-26 23:06:18 -04:00
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-enhanced-page-properties" />