chore: started some documentation on FieldExtensions

Signed-off-by: blam <ben@blam.sh>
2021-07-27 10:40:57 +02:00
parent 34fa0b3450
commit 512a04ec3a
1 changed files with 24 additions and 0 deletions
@@ -0,0 +1,24 @@
+---
+id: writing-custom-field-extensions
+title: Writing Custom Field Extensions
+description: How to write your own field extensions
+---
+
+Collecting input from the user is a very large part of the scaffolding process
+and Software Templates as a whole. Sometimes the built in components and fields
+just aren't good enough, and sometimes you want to enrich the form that the
+users sees with better inputs that fit better.
+
+This is where `Custom Field Extensions` come in.
+
+With them you can show your own `React` Components and use them to control the
+state of the JSON schema, as well as provide your own validation functions to
+validate the data too.
+
+## Creating a Field Extension
+
+Field extensions are a way to combine an ID, a `React` Component and a
+`validation` function together in a modular way that you can then use to pass to
+the `Scaffolder` frontend plugin in your own `App.tsx`.
+
+You can create your own Field Extension by us