value
用于控制搜索框中的文字,onChange
可以获得改变的值。
function BasicSearch() {
const [value, setValue] = useState("")
return (
<Search
value={value}
placeholder="请输入搜索关键词"
onChange={(e) => setValue(e.detail.value)}
/>
)
}
Search 组件提供了 onSearch
和 onCancel
事件,onSearch
事件在点击键盘上的搜索/回车按钮后触发,onCancel
事件在点击搜索框右侧取消按钮时触发。
function SearchWithEvents() {
const [value, setValue] = useState("")
const [open, setOpen] = useState(false)
return (
<>
<Toast open={open} onClose={() => setOpen(false)}>
取消
</Toast>
<Search
value={value}
placeholder="请输入搜索关键词"
action
onChange={(e) => setValue(e.detail.value)}
onCancel={() => setOpen(true)}
/>
</>
)
}
通过 inputAlign
属性设置搜索框内容的对齐方式,可选值为 center
、right
。
function InputCenterSearch() {
const [value, setValue] = useState("")
return (
<Search
value={value}
placeholder="请输入搜索关键词"
inputAlign="center"
onChange={(e) => setValue(e.detail.value)}
/>
)
}
通过 className
属性可以设置搜索框外部的背景色,通过 shape="rounded"
属性设置搜索框的形状。
<Search className="background" shape="rounded" disabled placeholder="请输入搜索关键词" />
.background {
--search-background-color: #4fc08d;
}
使用 action
插槽可以自定义右侧按钮的内容。使用插槽后,cancel
事件将不再触发。
function CustomSearch() {
const [value, setValue] = useState("")
const [open, setOpen] = useState(false)
return (
<>
<Toast open={open} onClose={() => setOpen(false)}>
搜索
</Toast>
<Search
value={value}
label="地址"
placeholder="请输入搜索关键词"
action={<View onClick={() => setOpen(true)}>搜索</View>}
onChange={(e) => setValue(e.detail.value)}
/>
</>
)
}
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
label | 搜索框左侧文本 | string | - |
shape | 搜索框形状,可选值为 square rounded | string | - |
maxlength | 输入的最大字符数 | number | string | - |
placeholder | 占位提示文字 | string | - |
autoFocus | 自动聚焦,iOS 系统不支持该属性 | boolean | false |
focus | 获取焦点 | boolean | false |
disabled | 是否禁用输入框 | boolean | false |
readonly | 是否将输入框设为只读状态,只读状态下无法输入内容 | boolean | false |
icon | 输入框左侧图标 | ReactNode | <Search /> |
rightIcon | 输入框右侧图标 | ReactNode | - |
action | 是否在搜索框右侧显示取消按钮 | boolean | ReactNode | false |
inputAlign | 输入框内容对齐方式,可选值为 center right | string | left |
inputColor | 输入框内容颜色,可选值为 primary info success warning danger | string | - |
clearable | 是否启用清除图标,点击清除图标后会清空输入框 | boolean | true |
clearIcon | 清除图标 | string | <Clear /> |
clearTrigger | 显示清除图标的时机,always 表示输入框不为空时展示,focus 表示输入框聚焦且不为空时展示 | string | focus |
feedback | 提示文案,为空时不展示 | string | FormFeedbackProps | ReactElement | - |
enableNative | 使用原生键盘(仅支付宝小程序) | boolean | true |
事件名 | 说明 | 回调参数 |
---|---|---|
onSearch | 确定搜索时触发 | event: BaseEventOrig<InputProps.inputValueEventDetail> |
onChange | 输入框内容变化时触发 | event: BaseEventOrig<InputProps.inputEventDetail> |
onFocus | 输入框获得焦点时触发 | event: BaseEventOrig<InputProps.inputForceEventDetail> |
onBlur | 输入框失去焦点时触发 | event: BaseEventOrig<InputProps.inputForceEventDetail> |
onClear | 点击清除按钮后触发 | event: event: ITouchEvent |
onCancel | 点击取消按钮时触发 | event: event: ITouchEvent |
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。
名称 | 默认值 | 描述 |
---|---|---|
—search-padding | 10px * $hd var(—padding-sm) | - |
—search-background-color | var(—white) | - |
—search-content-padding-left | var(—padding-sm) | - |
—search-content-background-color | var(—gray-1) | - |
—search-content-border-radius | var(—border-radius-sm) | - |
—search-content-square-border-radius | 0 | - |
—search-content-rounded-border-radius | var(—border-radius-max) | - |
—search-input-height | 34px * $hd | - |
—search-label-padding | 0 5px * $hd | - |
—search-label-color | var(—text-color) | - |
—search-label-font-size | var(—font-size-md) | - |
—search-label-line-height | var(—search-input-height) | - |
—search-field-padding | 5px * $hd var(—padding-xs) 5px * $hd 0 | - |
—search-left-icon-color | var(—gray-6) | - |
—search-action-padding | 0 var(—padding-xs) | - |
—search-action-color | var(—text-color) | - |
—search-action-line-height | var(—search-input-height) | - |
—search-action-font-size | var(—font-size-md) | - |
—search-action-active-background-color | var(—active-color) | - |