@rxap/material-form-system
Version:
Provides directives and a module to enhance Angular Material forms. It includes features such as displaying control errors, clearing input fields, handling required fields, and managing form field visibility based on defined conditions. The package also o
210 lines (107 loc) • 6.65 kB
Markdown
[**/material-form-system v19.0.4**](../README.md)
***
[/material-form-system](../globals.md) / FormControlsComponent
# Class: FormControlsComponent\<FormData\>
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:54](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L54)
## Type Parameters
• **FormData**
## Implements
- `OnInit`
## Constructors
### new FormControlsComponent()
> **new FormControlsComponent**\<`FormData`\>(`formDirective`, `cdr`, `snackBar`, `router`): [`FormControlsComponent`](FormControlsComponent.md)\<`FormData`\>
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:71](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L71)
#### Parameters
##### formDirective
`FormDirective`
##### cdr
`ChangeDetectorRef`
##### snackBar
`MatSnackBar`
##### router
`null` | `Router`
#### Returns
[`FormControlsComponent`](FormControlsComponent.md)\<`FormData`\>
## Properties
### \_allowResubmit
> **\_allowResubmit**: `boolean` = `false`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:84](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L84)
***
### close
> **close**: `EventEmitter`\<`void` \| `FormData` \| `FormData`[]\>
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:61](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L61)
***
### invalid
> **invalid**: `boolean` = `false`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:56](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L56)
***
### isDevMode
> **isDevMode**: `boolean`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:64](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L64)
***
### navigateAfterSubmit?
> `optional` **navigateAfterSubmit**: `string`[]
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:58](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L58)
***
### submitted
> **submitted**: `EventEmitter`\<`FormData`\>
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:63](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L63)
***
### submitting$
> **submitting$**: `Observable`\<`boolean`\>
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:55](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L55)
## Accessors
### allowResubmit
#### Get Signature
> **get** **allowResubmit**(): `boolean` \| `""`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:86](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L86)
##### Returns
`boolean` \| `""`
#### Set Signature
> **set** **allowResubmit**(`value`): `void`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:91](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L91)
##### Parameters
###### value
`boolean` | `""`
##### Returns
`void`
## Methods
### cancel()
> **cancel**(): `void`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:121](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L121)
#### Returns
`void`
***
### logCurrentFormState()
> **logCurrentFormState**(): `void`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:179](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L179)
#### Returns
`void`
***
### ngOnInit()
> **ngOnInit**(): `void`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:95](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L95)
A callback method that is invoked immediately after the
default change detector has checked the directive's
data-bound properties for the first time,
and before any of the view or content children have been checked.
It is invoked only once when the directive is instantiated.
#### Returns
`void`
#### Implementation of
`OnInit.ngOnInit`
***
### reset()
> **reset**(): `void`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:116](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L116)
#### Returns
`void`
***
### submit()
> **submit**(`closeAfterSubmit`?): `void`
Defined in: [packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts:125](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/material/form-system/src/lib/form-controls/form-controls.component.ts#L125)
#### Parameters
##### closeAfterSubmit?
`boolean`
#### Returns
`void`