Skip to content

Commit

Permalink
feat(docs): replace dynamic-forms API with list API in README (#1084)
Browse files Browse the repository at this point in the history
  • Loading branch information
emoralesb05 authored Jan 16, 2018
1 parent c492976 commit 1041d1f
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 deletions src/platform/dynamic-forms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 1041d1f

Please sign in to comment.