sp-dev-fx-webparts/samples/react-json-form
Hugo Bernier 3c9886276c
Merge pull request #3794 from Tanddant/main
2023-08-09 21:02:39 -04:00
..
.devcontainer Fixed linting issues, added container 2023-05-16 17:56:00 -04:00
.tours 🎉 - Initial commit for community call 2023-07-19 22:41:11 +02:00
assets Fixed Json to JSON 2023-08-06 16:57:51 -04:00
config
src Fixed linting issues, added container 2023-05-16 17:56:00 -04:00
teams
.eslintrc.js
.gitignore
.npmignore
.yo-rc.json
README.md Minor typo in readme 2023-05-16 17:56:33 -04:00
gulpfile.js
package-lock.json Bump word-wrap from 1.2.3 to 1.2.4 in /samples/react-json-form 2023-07-20 21:17:44 +00:00
package.json
tsconfig.json 🤦‍♂️ - [React-json-form]: Git is hard, think I made it back 2023-05-16 21:04:45 +02:00

README.md

JSON Form builder

Summary

Let's the user build a form and receive responses in the form

Sample gif

Compatibility

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

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

For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix

Applies to

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

Contributors

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 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. 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

property pane


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!

conditional fields


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)

Group fields

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 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.