diff --git a/web/pages/components/config/README.md b/web/pages/components/config/README.md index 0595ca8e5..b73c10234 100644 --- a/web/pages/components/config/README.md +++ b/web/pages/components/config/README.md @@ -27,28 +27,37 @@ Each form input (or group of inputs) you make, you should There are also a variety of other local states to manage the display of error/success messaging. -## Notes about `form-textfield` +## Notes about `form-textfield` and `form-togglefield` - The text field is intentionally designed to make it difficult for the user to submit bad data. - If you make a change on a field, a Submit buttton will show up that you have to click to update. That will be the only way you can update it. - If you clear out a field that is marked as Required, then exit/blur the field, it will repopulate with its original value. +- Both of these elements are specifically meant to be used with updating `serverConfig` fields, since each field requires its own endpoint. + +- Give these fields a bunch of props, and they will display labelling, some helpful UI around tips, validation messaging, as well as submit the update for you. + +- (currently undergoing re-styling and TS cleanup) + +- NOTE: you don't have to use these components. Some form groups may require a customized UX flow where you're better off using the Ant components straight up. ## Using Ant's `