Methods
# inner GenericInlineForm(props) → {React.ReactElement}
A Generic Form with a header and buttons to submit and cancel
Must be wrapped in a FormProvider
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props |
object
|
||
resetColor |
string
|
<optional> |
the color to use for the edit button |
submitColor |
string
|
<optional> |
the color to use for the submit button |
sectionProps |
InlineFormSectionProps
|
<optional> |
the props to pass to the section (See FormSections Component) |
resetLabel |
string
|
<optional> |
the label to use for the reset button |
submitLabel |
string
|
<optional> |
the label to use for the submit button |
onSubmit |
function
|
<optional> |
the function to call when the form is submitted |
modifying |
boolean
|
<optional> |
whether or not the form is currently being modified |
formOptions |
object
|
<optional> |
the options to pass to the form to customize the styling |
children |
object
|
<optional> |
the children to render |
renderLoading |
function
|
<optional> |
the function to render while the form is loading |
- the rendered form
React.ReactElement
Type Definitions
# renderColumnSection(section, control, index, optionsopt) → {React.ReactElement}
Renderer for a section with
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
section |
object
|
the section to render | |
control |
object
|
the control object from react-hook-form | |
index |
number
|
the index of the section | |
options |
object
|
<optional> |
options object |
columnCount |
number
|
<optional> |
the number of columns to render |
renderSectionDescription |
renderSectionDescription
|
<optional> |
a function to render the section description |
renderSectionTitle |
renderSectionTitle
|
<optional> |
a function to render the section title |
renderSectionTop |
renderSectionTop
|
<optional> |
a function to render the section top |
hideEmptySections |
boolean
|
<optional> |
a flag to hide sections that are empty |
- the rendered column section
React.ReactElement