About the Config editing section
An adventure with React, React Hooks and Ant Design forms.
General data flow in this React app
First things to note
-
When the Admin app loads, the
ServerStatusContext(in addition to checking server/statuson a timer) makes a call to the/serverconfigAPI to get your config details. This data will be stored asserverConfigin app state, and provided to the app viauseContexthook. -
The
serverConfigin state is be the central source of data that pre-populates the forms. -
The
ServerStatusContextalso provides a method for components to update the serverConfig state, calledsetFieldInConfigState(). -
After you have updated a config value in a form field, and successfully submitted it through its endpoint, you should call
setFieldInConfigStateto update the global state with the new value. -
Each top field of the serverConfig has its own API update endpoint.
Form Flow
Each form input (or group of inputs) you make, you should
- Get the field values that you want out of
serverConfigfrom ServerStatusContext withuseContext. - Next we'll have to put these field values of interest into a
useStatein each grouping. This will help you edit the form. - Because ths config data is populated asynchronously, Use a
useEffectto check when that data has arrived before putting it into state. - You will be using the state's value to populate the
defaultValueand thevalueprops of each Ant input component (Input,Toggle,Switch,Select,Sliderare currently used). - When an
onChangeevent fires for each type of input component, you will update the local state of each page with the changed value. - Depending on the form, an
onChangeof the input component, or a subsequentonClickof a submit button will take the value from local state and POST the field's API. onSuccessof the post, you should update the global app state with the new value.
There are also a variety of other local states to manage the display of error/success messaging.
Using Ant's <Form> with form-textfield.
You may see that a couple of pages (currently Public Details and Server Details page), is mainly a grouping of similar Text fields.
const [form] = Form.useForm();
form.setFieldsValue(initialValues);
A special TextField component was created to be used with form.
Potential Optimizations
Looking back at the pages with <Form> + form-textfield, t
This pattern might be overly engineered.
There are also a few patterns across all the form groups that repeat quite a bit. Perhaps these patterns could be consolidated into a custom hook that could handle all the steps.
TODO: explain how to use
and how the customform-xxxx components work together.
Misc notes
instanceDetailsneeds to be filled out beforeyp.enabledcan be turned on.
Config data structure (with default values)
{
streamKey: '',
instanceDetails: {
tags: [],
nsfw: false,
},
yp: {
enabled: false,
instance: '',
},
videoSettings: {
videoQualityVariants: [
{
audioPassthrough: false,
videoPassthrough: false,
videoBitrate: 0,
audioBitrate: 0,
framerate: 0,
},
],
}
};
TODO:
-
fill out readme for how to use form fields and about data flow w/ ant and react
-
cleanup
- more consitent constants
- cleanup types
- cleanup style sheets..? make style module for each config page? (but what about ant deisgn overrides?)
-
redesign
- label+form layout - put them into a table, table of rows
- change Encpder preset into slider
- page headers - diff color?
- fix social handles icon in table
- consolidate things into 1 page?
- things could use smaller font?
-
maybe convert common form pattern to custom hook?
Possibly over engineered
https://uxcandy.co/demo/label_pro/preview/demo_2/pages/forms/form-elements.html