Form
Import |
Source |
Docs |
When To Use#
- When you need to create an instance or collect information.
- When you need to validate fields in certain rules.
Form is totally based on Angular Forms, you can use reactive forms or template-driven-forms. Please make sure you have read the official form document before using the component.
Form#
You can align the controls of a form
using the layout
prop:
horizontal
:to horizontally align thelabel
s and controls of the fields. (Default)vertical
:to vertically align thelabel
s and controls of the fields.inline
:to render form fields in one line.
nz-form-item#
Used to separate the item in forms, contains label(optional) and control field.
nz-form-label#
The label of the form item, optional.
nz-form-control#
A form consists of one or more form fields whose type includes input, textarea, checkbox, radio, select, tag, and more.
<form nz-form>
<nz-form-item>
<nz-form-label [nzSpan]="6" nzFor="email">E-mail</nz-form-label>
<nz-form-control [nzSpan]="14">
<input nz-input name="email" type="email" id="email" />
</nz-form-control>
</nz-form-item>
</form>
Examples
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
API#
[nz-form]#
Property | Description | Type | Default Value | Global Config |
---|---|---|---|---|
[nzLayout] | Form layout | 'horizontal' | 'vertical' | 'inline' | 'horizontal' | |
[nzAutoTips] | Set default props [nzAutoTips] value of nz-form-control , please refer to the example: Auto tips | Record<string, Record<string, string>> | {} | ✅ |
[nzDisableAutoTips] | Set default props [nzDisableAutoTip] value of nz-form-control | boolean | false | ✅ |
[nzNoColon] | Set default props [nzNoColon] value of nz-form-label | boolean | false | ✅ |
[nzTooltipIcon] | Set default props [nzTooltipIcon] value of nz-form-label | string | { type: string; theme: ThemeType } | { type: 'question-circle', theme: 'outline' } | ✅ |
[nzLabelAlign] | Set default props [nzLabelAlign] value of nz-form-label | 'left' | 'right' | 'right' | |
[nzLabelWrap] | Set default props [nzLabelWrap] value of nz-form-label | boolean | false |
nz-form-item#
Used to separate the item in forms, contains label(optional) and control field.
All api in nz-row can be used in
nz-form-item
.
nz-form-label#
The label of the form item, optional.
All api in nz-col can be used in
nz-form-label
.
Property | Description | Type | Default Value |
---|---|---|---|
[nzRequired] | add required style to current item | boolean | false |
[nzNoColon] | whether to not display : after label text. | boolean | false |
[nzFor] | The for property of label | string | - |
[nzTooltipTitle] | Set tooltip info | string | TemplateRef<void> | - |
[nzTooltipIcon] | Set icon of tooltip info | string | NzFormTooltipIcon | - |
[nzLabelAlign] | The text align of label | 'left' | 'right' | 'right' |
[nzLabelWrap] | whether label can be wrap | boolean | false |
nz-form-control#
Note:Due to the lack of partial Observable in Angular Form, you have to notify
nz-form-control
to update its status withupdateValueAndValidity
when you update form status using methods likemarkAsDirty
.
A form consists of one or more form fields whose type includes input, textarea, checkbox, radio, select, tag, and more.
All api in nz-col can be used in
nz-form-control
.
Property | Description | Type | Default Value |
---|---|---|---|
[nzValidateStatus] | Will generate status based on the input FormControl , NgModel or string, the default value is the first FormControl or NgModel in nz-form-control | 'success' | 'warning' | 'error' | 'validating' | FormControl | NgModel | first FormControl or NgModel in nz-form-control |
[nzHasFeedback] | Used with nzValidateStatus , this option specifies the validation status icon. Recommended to be used only with Input . | boolean | false |
[nzExtra] | The extra prompt message | string | TemplateRef<void> | - |
[nzSuccessTip] | Tip display when validate success | string | TemplateRef<{ $implicit: FormControl | NgModel }> | - |
[nzWarningTip] | Tip display when validate warning | string | TemplateRef<{ $implicit: FormControl | NgModel }> | - |
[nzErrorTip] | Tip display when validate error | string | TemplateRef<{ $implicit: FormControl | NgModel }> | - |
[nzValidatingTip] | Tip display when validating | string | TemplateRef<{ $implicit: FormControl | NgModel }> | - |
[nzAutoTips] | The object of the tips, please refer to the example: Auto tips | Record<string, string | Record<string, string>> | - |
[nzDisableAutoTips] | Disable Auto Tips | boolean | - |
nz-form-split#
The split icon of -
nz-form-text#
Text in nz-form-control