Input 输入框
使用 |
文档 |
何时使用#
- 需要用户输入表单域内容时。
- 提供组合型输入框,带搜索的输入框,还可以进行大小选择。
代码演示 #
加载中
加载中
20.0.0
加载中
20.4.0
加载中
20.4.0
加载中
加载中
加载中
20.4.0
加载中
加载中
加载中
加载中
20.4.0
加载中
With Formatter (Uppercase)
With Disabled
With Length (8)
With custom display character
加载中
加载中
加载中
20.4.0
加载中
API#
[nz-input]#
[nz-input] 可以使用所有的 W3C 标准下的所有 使用方式 和 Angular 对 input 的全部额外功能支持。
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
[nzSize] | 控件大小。注:标准表单内的输入框大小限制为 large | 'large' | 'small' | 'default' | 'default' | |
[nzAutosize] | 只可以用于 textarea,自适应内容高度,可设置为 boolean 或对象:{ minRows: 2, maxRows: 6 } | boolean | { minRows: number, maxRows: number } | false | |
[nzBorderless] | boolean | false | ||
[nzVariant] | 形态变体 | 'outlined' | 'borderless' | 'filled' | 'underlined' | 'outlined' | 20.0.0 |
[nzStatus] | 设置校验状态 | 'error' | 'warning' | - |
nz-input-wrapper#
当需要为 [nz-input] 添加额外功能时使用。
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
[nzAddonBefore] | 带标签的 input,设置前置标签 | string | - |
[nzAddonAfter] | 带标签的 input,设置后置标签 | string | - |
[nzPrefix] | 带有前缀图标的 input | string | - |
[nzSuffix] | 带有后缀图标的 input | string | - |
[nzAllowClear] | 可以点击清除图标删除内容 | boolean | false |
(nzClear) | 点击清除图标时触发 | OutputEmitterRef<void> | - |
nz-input-password#
可使用 nz-input-wrapper 的所有属性。
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
[nzVisibilityToggle] | 是否显示切换按钮 | boolean | true |
[nzVisible] | 是否显示密码,支持双向绑定 | boolean | false |
(nzVisibleChange) | 是否显示密码变更事件 | OutputEmitterRef<boolean> | - |
nz-input-search#
可使用 nz-input-wrapper 的所有属性。
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
[nzEnterButton] | 是否有确认按钮,可设为按钮文字。该属性会与 nzAddonAfter 冲突。 | boolean | string | false |
[nzLoading] | 搜索 loading | boolean | false |
(nzSearch) | 点击搜索图标、清除图标,或按下回车键时的事件 | { value: string, event: Event, source: 'clear' | 'input' } |
nz-input-group#
⚠️
nz-input-group已在v20.0.0中废弃,将在v22.0.0中移除,请使用nz-input-wrapper组件。
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
[nzAddOnAfter] | 带标签的 input,设置后置标签,可以与 nzAddOnBefore 配合使用 | string | TemplateRef<void> | - |
[nzAddOnBefore] | 带标签的 input,设置前置标签,可以与 nzAddOnAfter 配合使用 | string | TemplateRef<void> | - |
[nzPrefix] | 带有前缀图标的 input,可以与 nzSuffix 配合使用 | string | TemplateRef<void> | - |
[nzSuffix] | 带有后缀图标的 input,可以与 nzPrefix 配合使用 | string | TemplateRef<void> | - |
[nzSearch] | 是否用搜索框 | boolean | false |
[nzSize] | nz-input-group 中所有的 nz-input 的大小 | 'large' | 'small' | 'default' | 'default' |
[nzStatus] | 设置校验状态 | 'error' | 'warning' | - |
nz-textarea-count#
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
[nzMaxCharacterCount] | textarea 数字提示显示的最大值 | number | - |
[nzComputeCharacterCount] | 自定义计算 characterCount 的函数 | (v: string) => number | v => v.length |
nz-input-otp#
| Property | Description | Type | Default |
|---|---|---|---|
[disabled] | 是否禁用 | boolean | false |
[nzFormatter] | 格式化展示,留空字段会被 填充 | (value: string) => string | - |
[nzMask] | 自定义展示,和 formatter 的区别是不会修改原始值 | boolean | null | null |
[nzLength] | 输入元素数量 | number | 6 |
[nzStatus] | 设置校验状态 | 'error' | 'warning' | - |
[nzSize] | 输入框大小 | 'large' | 'small' | 'default' | 'default' |
Q&A#
如何使用紧凑型输入框组合?#
从 v20 版本开始,nz-input-group 不再直接支持紧凑模式,你可以使用 nz-space-compact 替代。