diff --git a/src/platform/dynamic-forms/README.md b/src/platform/dynamic-forms/README.md index 79347cdf5f..3d1f081850 100644 --- a/src/platform/dynamic-forms/README.md +++ b/src/platform/dynamic-forms/README.md @@ -2,18 +2,29 @@ ## API Summary -Properties: - -| Name | Type | Description | -| --- | --- | 650--- | -| `elements?` | `ITdDynamicElementConfig[]` | JS Object that will render the elements depending on its config. [name] property is required. -| `form` | `get(): FormGroup` | Getter property for dynamic [FormGroup]. -| `valid` | `get(): boolean` | Getter property for [valid] of dynamic [FormGroup]. -| `value` | `get(): any` | Getter property for [value] of dynamic [FormGroup]. -| `errors` | `get(): {[name: string]: any}` | Getter property for [errors] of dynamic [FormGroup]. -| `controls` | `get(): {[key: string]: AbstractControl}` | Getter property for [controls] of dynamic [FormGroup]. -| `refresh` | `function` | Refreshes the form and rerenders all validator/element modifications. +#### Inputs ++ elements: ITdDynamicElementConfig[] + + JS Object that will render the elements depending on its config. + + [name] property is required. + +#### Properties (Read only) + ++ form: FormGroup + + Getter property for dynamic [FormGroup]. ++ valid: boolean + + Getter property for [valid] of dynamic [FormGroup]. ++ value: any + + Getter property for [value] of dynamic [FormGroup]. ++ errors: {[name: string]: any} + + Getter property for [errors] of dynamic [FormGroup]. ++ controls: {[key: string]: AbstractControl} + + Getter property for [controls] of dynamic [FormGroup]. + +#### Methods + ++ refresh: function + + Refreshes the form and rerenders all validator/element modifications ## Setup