109 lines
6.0 KiB
Markdown
109 lines
6.0 KiB
Markdown
# JSON Form builder
|
|
|
|
## Summary
|
|
|
|
Let's the user build a form and receive responses in the form
|
|
|
|
|
|
|
|
## Compatibility
|
|
|
|
| :warning: Important |
|
|
|:---------------------------|
|
|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please 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")
|
|
|
|
|
|
|
|
|
|
For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix
|
|
|
|
## Applies to
|
|
|
|
* [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/m365devprogram)
|
|
|
|
## Contributors
|
|
|
|
* [Dan Toft](https://github.com/Tanddant)
|
|
|
|
## Version history
|
|
|
|
| Version | Date | Comments |
|
|
| ------- | ---------------- | --------------- |
|
|
| 1.0 | March 16, 2023 | Initial release |
|
|
|
|
|
|
## Prerequisites
|
|
|
|
You'll need a document library to store the responses
|
|
|
|
## 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-json-form) then unzip it)
|
|
* From your command line, change your current directory to the directory containing this sample (`react-json-form`, located under `samples`)
|
|
* in the command line run:
|
|
* `npm install`
|
|
* `gulp serve`
|
|
|
|
> 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
|
|
|
|
> PLEASE DON'T ACTUALLY USE THIS IN IT'S CURRENT STATE!
|
|
>
|
|
> The way this is setup to save it to save a .json file in a document library containing both the forms config and the values, this is a very unstructured method of storing data! - you really should implement another save method!
|
|
|
|
---
|
|
|
|
You have the option to edit the raw JSON in the property pane, from here you'll also set the document library where the JSON files are stored
|
|
|
|
|
|
|
|
---
|
|
|
|
Another feature is conditional fields (only for some of the field types)
|
|
|
|
It allows you to show/hide fields based on other fields, for instance a "fill in" choice option!
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
Lastly of the field types I'll call out here is the "Group" field this allows you to 'group' fields in either direction (is also a way to add several fields side a conditional field)
|
|
|
|
|
|
|
|
|
|
## 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](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-json-form%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-json-form) 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-json-form&template=bug-report.yml&sample=react-json-form&authors=@Tanddant&title=react-json-form%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-json-form&template=question.yml&sample=react-json-form&authors=@Tanddant&title=react-json-form%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-json-form&template=suggestion.yml&sample=react-json-form&authors=@Tanddant&title=react-json-form%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.**
|
|
|
|
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-json-form" /> |