SearchBox Control(预览版)

[本文为预发布文档,可能会发生变化。]

用于创建搜索体验的控件。

SearchBox 控件。

说明

搜索框 (SearchBox) 提供了一个输入字段,用于在站点或应用中进行搜索以查找特定项。

此代码组件提供了一个围绕 Fluent UI SearchBox 控件的包装器,用于画布和自定义页面。

重要提示

  • 这是一项预览功能。
  • 预览功能不适合生产使用且功能可能受限。 这些功能在正式发布之前推出,以便客户可以提前使用并提供反馈。

键属性

属性 说明
SearchText 用户输入的文本。 将其作为搜索功能的输入。
IconName Fluent UI 图标的名称(请参阅 Fluent UI 图标)。
Underlined SearchBox 是否带下划线。
DisableAnimation 是否在焦点上为 SearchBox 图标添加动画效果。
PlaceholderText 搜索框的占位符。

其他属性

属性 说明
Theme 主题对象(不是 Json 格式)。 有关如何配置的指导,请参阅主题化
AccessibilityLabel 屏幕阅读器 aria 标签。
InputEvent 要发送到控件的事件。 例如,SetFocus

示例

配置搜索行为

将此控件添加到需要搜索界面的应用中,通常与库、DetailsList 或任何可以显示数据集的控件结合。

使用 Search() 或 Filter() 表达式创建搜索体验,这些表达式使用 SearchBox 中的 SearchText 属性的值。

Search( Accounts, SearchBox.SearchText, "name" )

限制

此代码组件只能在画布应用和自定义页面中使用。