@reactables/forms 1.0.0-beta.2 → 1.0.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -32,7 +32,7 @@ Reactive forms with [Reactables](https://github.com/reactables/reactables/tree/m
|
|
|
32
32
|
|
|
33
33
|
## Installation <a name="installation"></a>
|
|
34
34
|
|
|
35
|
-
Installation
|
|
35
|
+
Installation requires [RxJS](https://rxjs.dev/) to be present.
|
|
36
36
|
|
|
37
37
|
`npm i rxjs @reactables/forms`
|
|
38
38
|
|
|
@@ -46,7 +46,7 @@ Actions available to trigger state changes on Reactable.
|
|
|
46
46
|
|
|
47
47
|
#### `updateValues` <a name="api-actions-update-values"></a>
|
|
48
48
|
|
|
49
|
-
Updates
|
|
49
|
+
Updates values of a [`FormControl`](#api-form-control). For form group and form arrays, updates will only occur if the specified descendant controls exists. Otherwise it will throw an error.
|
|
50
50
|
|
|
51
51
|
```typescript
|
|
52
52
|
type updateValues = <T>(payload: UpdateValuesPayload<T>) => void;
|
|
@@ -88,7 +88,7 @@ export interface PushControlPayload {
|
|
|
88
88
|
|
|
89
89
|
#### `removeControl` <a name="api-actions-remove-control"></a>
|
|
90
90
|
|
|
91
|
-
Removes a specified control from form.
|
|
91
|
+
Removes a specified control from the form.
|
|
92
92
|
|
|
93
93
|
```typescript
|
|
94
94
|
type removeControl = (payload: ControlRef) => void;
|
|
@@ -106,7 +106,7 @@ type markControlAsPristine = (payload: ControlRef) => void;
|
|
|
106
106
|
|
|
107
107
|
#### `markControlAsTouched` <a name="api-actions-mark-as-touched"></a>
|
|
108
108
|
|
|
109
|
-
Marks a control and all ancestors as touched. Can
|
|
109
|
+
Marks a control and all ancestors as touched. Can set `markAll` to `true` to mark all descendants as touched as well.
|
|
110
110
|
|
|
111
111
|
```typescript
|
|
112
112
|
type markControlAsTouched = (payload: MarkTouchedPayload) => void;
|
|
@@ -120,7 +120,7 @@ export interface MarkTouchedPayload {
|
|
|
120
120
|
|
|
121
121
|
#### `markControlAsUntouched` <a name="api-actions-mark-as-untouched"></a>
|
|
122
122
|
|
|
123
|
-
Marks a control and all descendants as untouched.
|
|
123
|
+
Marks a control and all descendants as untouched. This will recheck ancestor controls and update the touched status.
|
|
124
124
|
|
|
125
125
|
```typescript
|
|
126
126
|
type markControlAsUnTouched = (payload: ControlRef) => void;
|
|
@@ -129,7 +129,7 @@ type markControlAsUnTouched = (payload: ControlRef) => void;
|
|
|
129
129
|
|
|
130
130
|
#### `resetControl` <a name="api-actions-resetControl"></a>
|
|
131
131
|
|
|
132
|
-
Marks a control and all descendants as untouched.
|
|
132
|
+
Marks a control and all descendants as untouched. This will recheck ancestor controls and update the touched status.
|
|
133
133
|
|
|
134
134
|
```typescript
|
|
135
135
|
type resetControls = (payload: ControlRef) => void;
|
|
@@ -276,7 +276,7 @@ export interface FormErrors {
|
|
|
276
276
|
|
|
277
277
|
#### `FormReducers` <a name="api-form-reducers"></a>
|
|
278
278
|
|
|
279
|
-
Built in reducers
|
|
279
|
+
Built in reducers which can be used to update the state of the form tree. Payload and behaviour is the same and descrbed in [`RxActions`](#api-actions);
|
|
280
280
|
|
|
281
281
|
```typescript
|
|
282
282
|
|
package/package.json
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"author": "David Lai",
|
|
15
15
|
"license": "ISC",
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@reactables/core": "^1.0.0-beta.
|
|
17
|
+
"@reactables/core": "^1.0.0-beta.4",
|
|
18
18
|
"lodash.isequal": "^4.5.0"
|
|
19
19
|
},
|
|
20
20
|
"peerDependencies": {
|
|
@@ -23,5 +23,5 @@
|
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"lodash.clonedeep": "^4.5.0"
|
|
25
25
|
},
|
|
26
|
-
"version": "1.0.0-beta.
|
|
26
|
+
"version": "1.0.0-beta.4"
|
|
27
27
|
}
|