Ant Design Blazor
Input输入框
通过鼠标或键盘输入内容，是最基础的表单域的包装。
何时使用
- 需要用户输入表单域内容时。
- 提供组合型输入框，带搜索的输入框，还可以进行大小选择。
Examples
从 0.13.0 开始，输入框的值绑定事件默认变为 onchange，如果需要在输入时绑定，请设置 BindOnInput。
注意：当在 Server Side 使用输入时变更，会存在绑定延迟和文本回退问题，可尝试加大
DebounceMilliseconds的值来解决。#579
我们为输入框定义了三种尺寸（大、默认、小），高度分别为 40px、32px 和 24px。
输入框的组合展现。 注意：使用 compact 模式时，不需要通过 Col 来控制宽度。
用于 onSearch 的时候展示 loading。
设置 AutoSize 属性为 true 启用高度自动变化。当设置了 MinRows 或 MaxRows 时，会强制开启 AutoSize。
在输入框上添加前缀或后缀图标。
带移除图标的输入框，点击图标删除所有内容。
展示字数提示。
聚焦额外配置属性。
Input API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| AddOnBefore | 属性在输入字段之前（左侧）显示的标签文本。 | RenderFragment | -- |
| AddOnAfter | 属性输入字段后（右侧）显示的标签文本。 | RenderFragment | -- |
| AllowClear | 属性允许删除带有清晰图标的输入内容 | Boolean | -- |
| ShowClear | 属性覆盖是否显示清除图标。当 |
Boolean? | -- |
| OnClear | 属性单击“ClearIcon”清空内容时的回调 | EventCallback | -- |
| AutoComplete | 属性控制输入 HTML 元素的自动完成属性。默认值 = 真 | Boolean | -- |
| AutoFocus | 属性是否自动对焦输入 | Boolean | false |
| Bordered | 属性是否有边框样式 | Boolean | -- |
| BindOnInput | 属性是否改变输入值 | Boolean | -- |
| DebounceMilliseconds | 属性延迟 KeyUp 事件的处理，直到用户停止键入预定的时间。默认值为 250 毫秒。 | Int32 | -- |
| DefaultValue | 属性初始输入内容 | TValue | -- |
| Disabled | 属性输入是否被禁用。 | Boolean | -- |
| InputElementSuffixClass | 属性将作为最后一个类条目添加到输入元素类的 Css 类。 | String | -- |
| MaxLength | 属性最长长度 | Int32 | -- |
| OnBlur | 属性输入失去焦点时回调 | EventCallback<FocusEventArgs> | -- |
| OnChange | 属性内容改变时回调 | EventCallback<TValue> | -- |
| OnFocus | 属性输入获得焦点时回调 | EventCallback<FocusEventArgs> | -- |
| OnInput | 属性输入值时回调 | EventCallback<ChangeEventArgs> | -- |
| OnkeyDown | 属性按键按下时回调 | EventCallback<KeyboardEventArgs> | -- |
| OnkeyUp | 属性松开按键时的回调 | EventCallback<KeyboardEventArgs> | -- |
| OnMouseUp | 属性释放鼠标按钮时的回调 | EventCallback<MouseEventArgs> | -- |
| OnPressEnter | 属性按下回车键时触发的回调函数 | EventCallback<KeyboardEventArgs> | -- |
| Placeholder | 属性提供描述输入字段预期值的提示信息 | String | -- |
| Prefix | 属性输入的前缀图标。 | RenderFragment | -- |
| ReadOnly | 属性如果存在，它指定输入字段是只读的。 | Boolean | -- |
| StopPropagation | 属性控制 onclick 和 blur 事件传播。 | Boolean | -- |
| Suffix | 属性输入的后缀图标。 | RenderFragment | -- |
| Type | 属性输入的类型，参见：MDN（使用`Input.TextArea`代替type=`textarea`） | String | -- |
| WrapperStyle | 属性设置包装器的 CSS 样式。当组件具有可见时使用：Prefix/Suffix 或具有参数设置 AntDesign.Input`1.AllowClear 或用于组件：InputPassword 和 Search。在这些情况下，html span 元素用于包装 html input 元素。 AntDesign.Input`1.WrapperStyle 用在 span 元素上。 |
String | -- |
| ShowCount | 属性显示输入中的字符计数 | Boolean | -- |
| Width | 属性输入的宽度 | String | -- |
| ValidationMessages | FormItem 的验证消息 | String[] | -- |
| AdditionalAttributes | 属性获取或设置将应用于所创建元素的附加属性的集合。 | IReadOnlyDictionary<String, Object> | -- |
| Value | 属性获取或设置输入的值。这应该与双向绑定一起使用。 | TValue | -- |
| ValueChanged | 属性更新绑定值的回调。 | EventCallback<TValue> | -- |
| ValueExpression | 属性标识绑定值的表达式。 | Expression<Func<TValue>> | -- |
| ValuesExpression | 属性标识可枚举绑定值的表达式。 | Expression<Func<IEnumerable<TValue>>> | -- |
| Size | 属性输入框的大小。注意：在表单的上下文中，使用“大”尺寸。可用：`大``默认``小` | String | AntSizeLDSType.Default |
| CultureInfo | 属性将字符串转换为值和将值转换为字符串时将使用什么文化对 InputNumber 组件有用。 | CultureInfo | CultureInfo.CurrentCulture |
| Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
| Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
| Style | 属性指定 DOM 元素的内联样式。 | String | -- |
| RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
| 方法签名 | 返回类型 | 描述 |
|---|---|---|
| Focus(FocusBehavior behavior, Boolean preventScroll) | Task | 具有可选行为的输入组件的焦点行为。 |
| Blur() | Task | 从输入元素中移除焦点。 |
TextArea API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| AutoSize | 属性将根据内容调整（增大或缩小）TextArea。可以与 AntDesign.TextArea.MaxRows 和 AntDesign.TextArea.MinRows 结合使用。将 textarea HTML 元素的调整大小属性设置为：无。 |
Boolean | -- |
| DefaultToEmptyString | 属性当为真时，值将被设置为空字符串。如果为 false，当内容为空或空白时，值将设置为 null。 |
Boolean | false |
| MaxRows | 属性允许增长，但当可见行数 = MaxRows 时停止（不会进一步增长）。 | UInt32 | uint.MaxValue |
| MinRows | 属性允许收缩，但当可见行数 = MinRows 时停止（不会进一步收缩）。 | UInt32 | 1 |
| Rows | 属性设置以行数表示的 TextArea 的高度。 | UInt32 | 3 |
| OnResize | 属性尺寸改变时执行的回调 | EventCallback<OnResizeEventArgs> | -- |
| Value | 属性获取或设置 TextArea 的值。 | String | -- |
| AddOnBefore | 属性在输入字段之前（左侧）显示的标签文本。 | RenderFragment | -- |
| AddOnAfter | 属性输入字段后（右侧）显示的标签文本。 | RenderFragment | -- |
| AllowClear | 属性允许删除带有清晰图标的输入内容 | Boolean | -- |
| ShowClear | 属性覆盖是否显示清除图标。当 |
Boolean? | -- |
| OnClear | 属性单击“ClearIcon”清空内容时的回调 | EventCallback | -- |
| AutoComplete | 属性控制输入 HTML 元素的自动完成属性。默认值 = 真 | Boolean | -- |
| AutoFocus | 属性是否自动对焦输入 | Boolean | false |
| Bordered | 属性是否有边框样式 | Boolean | -- |
| BindOnInput | 属性是否改变输入值 | Boolean | -- |
| DebounceMilliseconds | 属性延迟 KeyUp 事件的处理，直到用户停止键入预定的时间。默认值为 250 毫秒。 | Int32 | -- |
| DefaultValue | 属性初始输入内容 | String | -- |
| Disabled | 属性输入是否被禁用。 | Boolean | -- |
| InputElementSuffixClass | 属性将作为最后一个类条目添加到输入元素类的 Css 类。 | String | -- |
| MaxLength | 属性最长长度 | Int32 | -- |
| OnBlur | 属性输入失去焦点时回调 | EventCallback<FocusEventArgs> | -- |
| OnChange | 属性内容改变时回调 | EventCallback<String> | -- |
| OnFocus | 属性输入获得焦点时回调 | EventCallback<FocusEventArgs> | -- |
| OnInput | 属性输入值时回调 | EventCallback<ChangeEventArgs> | -- |
| OnkeyDown | 属性按键按下时回调 | EventCallback<KeyboardEventArgs> | -- |
| OnkeyUp | 属性松开按键时的回调 | EventCallback<KeyboardEventArgs> | -- |
| OnMouseUp | 属性释放鼠标按钮时的回调 | EventCallback<MouseEventArgs> | -- |
| OnPressEnter | 属性按下回车键时触发的回调函数 | EventCallback<KeyboardEventArgs> | -- |
| Placeholder | 属性提供描述输入字段预期值的提示信息 | String | -- |
| Prefix | 属性输入的前缀图标。 | RenderFragment | -- |
| ReadOnly | 属性如果存在，它指定输入字段是只读的。 | Boolean | -- |
| StopPropagation | 属性控制 onclick 和 blur 事件传播。 | Boolean | -- |
| Suffix | 属性输入的后缀图标。 | RenderFragment | -- |
| Type | 属性输入的类型，参见：MDN（使用`Input.TextArea`代替type=`textarea`） | String | -- |
| WrapperStyle | 属性设置包装器的 CSS 样式。当组件具有可见时使用：Prefix/Suffix 或具有参数设置 AntDesign.Input`1.AllowClear 或用于组件：InputPassword 和 Search。在这些情况下，html span 元素用于包装 html input 元素。 AntDesign.Input`1.WrapperStyle 用在 span 元素上。 |
String | -- |
| ShowCount | 属性显示输入中的字符计数 | Boolean | -- |
| Width | 属性输入的宽度 | String | -- |
| ValidationMessages | FormItem 的验证消息 | String[] | -- |
| AdditionalAttributes | 属性获取或设置将应用于所创建元素的附加属性的集合。 | IReadOnlyDictionary<String, Object> | -- |
| ValueChanged | 属性更新绑定值的回调。 | EventCallback<String> | -- |
| ValueExpression | 属性标识绑定值的表达式。 | Expression<Func<String>> | -- |
| ValuesExpression | 属性标识可枚举绑定值的表达式。 | Expression<Func<IEnumerable<String>>> | -- |
| Size | 属性输入框的大小。注意：在表单的上下文中，使用“大”尺寸。可用：`大``默认``小` | String | AntSizeLDSType.Default |
| CultureInfo | 属性将字符串转换为值和将值转换为字符串时将使用什么文化对 InputNumber 组件有用。 | CultureInfo | CultureInfo.CurrentCulture |
| Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
| Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
| Style | 属性指定 DOM 元素的内联样式。 | String | -- |
| RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
| 方法签名 | 返回类型 | 描述 |
|---|---|---|
| ChangeSizeAsyncJs(Single width, Single height) | void | |
| Focus(FocusBehavior behavior, Boolean preventScroll) | Task | 具有可选行为的输入组件的焦点行为。 |
| Blur() | Task | 从输入元素中移除焦点。 |
Search API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| ClassicSearchIcon | 属性搜索输入以后缀搜索图标呈现，而不是按钮。当 AntDesign.Search.EnterButton != false 时将被忽略 |
Boolean | -- |
| EnterButton | 属性输入后是否显示回车按钮。此属性与 AntDesign.Input`1.AddOnAfter 冲突 |
OneOf<Boolean, String> | -- |
| Loading | 属性正在加载的搜索框 | Boolean | -- |
| OnSearch | 属性单击搜索图标、清除图标或按回车键时执行的回调 | EventCallback<String> | -- |
| AddOnBefore | 属性在输入字段之前（左侧）显示的标签文本。 | RenderFragment | -- |
| AddOnAfter | 属性输入字段后（右侧）显示的标签文本。 | RenderFragment | -- |
| AllowClear | 属性允许删除带有清晰图标的输入内容 | Boolean | -- |
| ShowClear | 属性覆盖是否显示清除图标。当 |
Boolean? | -- |
| OnClear | 属性单击“ClearIcon”清空内容时的回调 | EventCallback | -- |
| AutoComplete | 属性控制输入 HTML 元素的自动完成属性。默认值 = 真 | Boolean | -- |
| AutoFocus | 属性是否自动对焦输入 | Boolean | false |
| Bordered | 属性是否有边框样式 | Boolean | -- |
| BindOnInput | 属性是否改变输入值 | Boolean | -- |
| DebounceMilliseconds | 属性延迟 KeyUp 事件的处理，直到用户停止键入预定的时间。默认值为 250 毫秒。 | Int32 | -- |
| DefaultValue | 属性初始输入内容 | String | -- |
| Disabled | 属性输入是否被禁用。 | Boolean | -- |
| InputElementSuffixClass | 属性将作为最后一个类条目添加到输入元素类的 Css 类。 | String | -- |
| MaxLength | 属性最长长度 | Int32 | -- |
| OnBlur | 属性输入失去焦点时回调 | EventCallback<FocusEventArgs> | -- |
| OnChange | 属性内容改变时回调 | EventCallback<String> | -- |
| OnFocus | 属性输入获得焦点时回调 | EventCallback<FocusEventArgs> | -- |
| OnInput | 属性输入值时回调 | EventCallback<ChangeEventArgs> | -- |
| OnkeyDown | 属性按键按下时回调 | EventCallback<KeyboardEventArgs> | -- |
| OnkeyUp | 属性松开按键时的回调 | EventCallback<KeyboardEventArgs> | -- |
| OnMouseUp | 属性释放鼠标按钮时的回调 | EventCallback<MouseEventArgs> | -- |
| OnPressEnter | 属性按下回车键时触发的回调函数 | EventCallback<KeyboardEventArgs> | -- |
| Placeholder | 属性提供描述输入字段预期值的提示信息 | String | -- |
| Prefix | 属性输入的前缀图标。 | RenderFragment | -- |
| ReadOnly | 属性如果存在，它指定输入字段是只读的。 | Boolean | -- |
| StopPropagation | 属性控制 onclick 和 blur 事件传播。 | Boolean | -- |
| Suffix | 属性输入的后缀图标。 | RenderFragment | -- |
| Type | 属性输入的类型，参见：MDN（使用`Input.TextArea`代替type=`textarea`） | String | -- |
| WrapperStyle | 属性设置包装器的 CSS 样式。当组件具有可见时使用：Prefix/Suffix 或具有参数设置 AntDesign.Input`1.AllowClear 或用于组件：InputPassword 和 Search。在这些情况下，html span 元素用于包装 html input 元素。 AntDesign.Input`1.WrapperStyle 用在 span 元素上。 |
String | -- |
| ShowCount | 属性显示输入中的字符计数 | Boolean | -- |
| Width | 属性输入的宽度 | String | -- |
| ValidationMessages | FormItem 的验证消息 | String[] | -- |
| AdditionalAttributes | 属性获取或设置将应用于所创建元素的附加属性的集合。 | IReadOnlyDictionary<String, Object> | -- |
| Value | 属性获取或设置输入的值。这应该与双向绑定一起使用。 | String | -- |
| ValueChanged | 属性更新绑定值的回调。 | EventCallback<String> | -- |
| ValueExpression | 属性标识绑定值的表达式。 | Expression<Func<String>> | -- |
| ValuesExpression | 属性标识可枚举绑定值的表达式。 | Expression<Func<IEnumerable<String>>> | -- |
| Size | 属性输入框的大小。注意：在表单的上下文中，使用“大”尺寸。可用：`大``默认``小` | String | AntSizeLDSType.Default |
| CultureInfo | 属性将字符串转换为值和将值转换为字符串时将使用什么文化对 InputNumber 组件有用。 | CultureInfo | CultureInfo.CurrentCulture |
| Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
| Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
| Style | 属性指定 DOM 元素的内联样式。 | String | -- |
| RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
| 方法签名 | 返回类型 | 描述 |
|---|---|---|
| Focus(FocusBehavior behavior, Boolean preventScroll) | Task | 具有可选行为的输入组件的焦点行为。 |
| Blur() | Task | 从输入元素中移除焦点。 |
InputGroup API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| ChildContent | 属性由 InputGroup 包装的内容。 | RenderFragment | -- |
| Compact | 属性是否使用紧凑样式 | Boolean | false |
| Size | 属性InputGroup 的大小指定了包含的输入字段的大小。可用：大默认小 | String | -- |
| Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
| Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
| Style | 属性指定 DOM 元素的内联样式。 | String | -- |
| RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
InputPassword API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| IconRender | 属性自定义图标渲染 | RenderFragment | -- |
| ShowPassword | 属性是否显示密码 | Boolean | false |
| VisibilityToggle | 属性是否显示密码可见性切换按钮 | Boolean | true |
| AddOnBefore | 属性在输入字段之前（左侧）显示的标签文本。 | RenderFragment | -- |
| AddOnAfter | 属性输入字段后（右侧）显示的标签文本。 | RenderFragment | -- |
| AllowClear | 属性允许删除带有清晰图标的输入内容 | Boolean | -- |
| ShowClear | 属性覆盖是否显示清除图标。当 |
Boolean? | -- |
| OnClear | 属性单击“ClearIcon”清空内容时的回调 | EventCallback | -- |
| AutoComplete | 属性控制输入 HTML 元素的自动完成属性。默认值 = 真 | Boolean | -- |
| AutoFocus | 属性是否自动对焦输入 | Boolean | false |
| Bordered | 属性是否有边框样式 | Boolean | -- |
| BindOnInput | 属性是否改变输入值 | Boolean | -- |
| DebounceMilliseconds | 属性延迟 KeyUp 事件的处理，直到用户停止键入预定的时间。默认值为 250 毫秒。 | Int32 | -- |
| DefaultValue | 属性初始输入内容 | String | -- |
| Disabled | 属性输入是否被禁用。 | Boolean | -- |
| InputElementSuffixClass | 属性将作为最后一个类条目添加到输入元素类的 Css 类。 | String | -- |
| MaxLength | 属性最长长度 | Int32 | -- |
| OnBlur | 属性输入失去焦点时回调 | EventCallback<FocusEventArgs> | -- |
| OnChange | 属性内容改变时回调 | EventCallback<String> | -- |
| OnFocus | 属性输入获得焦点时回调 | EventCallback<FocusEventArgs> | -- |
| OnInput | 属性输入值时回调 | EventCallback<ChangeEventArgs> | -- |
| OnkeyDown | 属性按键按下时回调 | EventCallback<KeyboardEventArgs> | -- |
| OnkeyUp | 属性松开按键时的回调 | EventCallback<KeyboardEventArgs> | -- |
| OnMouseUp | 属性释放鼠标按钮时的回调 | EventCallback<MouseEventArgs> | -- |
| OnPressEnter | 属性按下回车键时触发的回调函数 | EventCallback<KeyboardEventArgs> | -- |
| Placeholder | 属性提供描述输入字段预期值的提示信息 | String | -- |
| Prefix | 属性输入的前缀图标。 | RenderFragment | -- |
| ReadOnly | 属性如果存在，它指定输入字段是只读的。 | Boolean | -- |
| StopPropagation | 属性控制 onclick 和 blur 事件传播。 | Boolean | -- |
| Suffix | 属性输入的后缀图标。 | RenderFragment | -- |
| Type | 属性输入的类型，参见：MDN（使用`Input.TextArea`代替type=`textarea`） | String | -- |
| WrapperStyle | 属性设置包装器的 CSS 样式。当组件具有可见时使用：Prefix/Suffix 或具有参数设置 AntDesign.Input`1.AllowClear 或用于组件：InputPassword 和 Search。在这些情况下，html span 元素用于包装 html input 元素。 AntDesign.Input`1.WrapperStyle 用在 span 元素上。 |
String | -- |
| ShowCount | 属性显示输入中的字符计数 | Boolean | -- |
| Width | 属性输入的宽度 | String | -- |
| ValidationMessages | FormItem 的验证消息 | String[] | -- |
| AdditionalAttributes | 属性获取或设置将应用于所创建元素的附加属性的集合。 | IReadOnlyDictionary<String, Object> | -- |
| Value | 属性获取或设置输入的值。这应该与双向绑定一起使用。 | String | -- |
| ValueChanged | 属性更新绑定值的回调。 | EventCallback<String> | -- |
| ValueExpression | 属性标识绑定值的表达式。 | Expression<Func<String>> | -- |
| ValuesExpression | 属性标识可枚举绑定值的表达式。 | Expression<Func<IEnumerable<String>>> | -- |
| Size | 属性输入框的大小。注意：在表单的上下文中，使用“大”尺寸。可用：`大``默认``小` | String | AntSizeLDSType.Default |
| CultureInfo | 属性将字符串转换为值和将值转换为字符串时将使用什么文化对 InputNumber 组件有用。 | CultureInfo | CultureInfo.CurrentCulture |
| Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
| Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
| Style | 属性指定 DOM 元素的内联样式。 | String | -- |
| RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
| 方法签名 | 返回类型 | 描述 |
|---|---|---|
| Focus(FocusBehavior behavior, Boolean preventScroll) | Task | 具有可选行为的 InputPassword 组件的焦点行为。 wasm 所需的特殊行为。 |
| Blur() | Task | 从输入元素中移除焦点。 |