zebra-ui基于uniapp,跨多端组件库
  • 2.x
  • 中文
开发指南
介绍
快速上手
进阶用法
常见问题
更新日志
贡献指南
国际化
基础组件
Button 按钮
Cell 单元格
ConfigProvider 全局配置
Icon 图标
Image 图片
Layout 布局
Popup 弹出层
Style 内置样式
Transition 动画
Toast 轻提示
表单组件
Area 省市区选择
Calendar 日历
Cascader 级联选择
Checkbox 复选框
DatePicker 日期选择
Field 输入框
Form 表单
NumberKeyboard 数字键盘
PasswordInput 密码输入框
Picker 选择器
PickerGroup 选择器组
Radio 单选框
Rate 评分
Search 搜索
Slider 滑块
Signature 签名
Stepper 步进器
Switch 开关
TimePicker 时间选择
Uploader 文件上传
反馈组件
ActionSheet 动作面板
Barrage 弹幕
Dialog 弹出框
DropdownMenu 下拉菜单
FloatingPanel 浮动面板
FloatingBubble 浮动气泡
Loading 加载
Notify 消息通知
Overlay 遮罩层
PullRefresh 下拉刷新
ShareSheet 分享面板
SwipeCell 滑动单元格
展示组件
Badge 徽标
Circle 环形进度条
Collapse 折叠面板
CountDown 倒计时
Divider 分割线
Empty 空状态
Highlight 高亮文本
List 列表
NoticeBar 通知栏
Popover 气泡弹出框
Progress 进度条
RollingText 翻滚文本
Skeleton 骨架屏
Steps 步骤条
Sticky 粘性布局
Swipe 轮播
Tag 标签
TextEllipsis 文本省略
Watermark 水印
导航组件
Grid 宫格
NavBar 导航栏
Sidebar 侧边导航
Tab 标签页
Tabbar 标签栏
TreeSelect 分类选择

Search 搜索

介绍

用于搜索场景的输入框组件。

代码演示

基础用法

v-model 用于控制搜索框中的文字,background 可以自定义搜索框外部背景色。

<z-search v-model="value" placeholder="请输入搜索关键词" />
import { ref } from 'vue';
const value = ref('');

事件监听

Search 组件提供了 search 和 cancel 事件,search 事件在点击键盘上的搜索/回车按钮后触发,cancel 事件在点击搜索框右侧取消按钮时触发。

<z-search
  v-model="value"
  show-action
  placeholder="请输入搜索关键词"
  @search="onSearch"
  @cancel="onCancel"
/>

搜索框内容对齐

通过 input-align 属性设置搜索框内容的对齐方式,可选值为 center、right。

<z-search
  v-model="value"
  placeholder="请输入搜索关键词"
  input-align="center"
/>

禁用搜索框

通过 disabled 属性禁用搜索框。

<z-search v-model="value" disabled placeholder="请输入搜索关键词" />

自定义背景色

通过 background 属性可以设置搜索框外部的背景色,通过 shape 属性设置搜索框的形状,可选值为 round。

<z-search
  v-model="value"
  shape="round"
  background="#4fc08d"
  placeholder="请输入搜索关键词"
/>

自定义按钮

使用 action 插槽可以自定义右侧按钮的内容。使用插槽后,cancel 事件将不再触发。

<z-search
  v-model="value"
  show-action
  label="地址"
  placeholder="请输入搜索关键词"
  @search="onSearch"
>
  <template #action>
    <div @click="onClickButton">搜索</div>
  </template>
</z-search>

API

Props

参数说明类型默认值
v-model当前输入的值number | string-
label搜索框左侧文本string-
name名称,作为提交表单时的标识符string-
shape搜索框形状,可选值为 roundstringsquare
background搜索框外部背景色string#f2f2f2
maxlength输入的最大字符数number | string-
placeholder占位提示文字string-
clearable是否启用清除图标,点击清除图标后会清空输入框booleantrue
clear-icon清除图标名称或图片链接,等同于 Icon 组件的 name 属性stringclear
clear-trigger显示清除图标的时机,always 表示输入框不为空时展示,
focus 表示输入框聚焦且不为空时展示
stringfocus
show-action是否在搜索框右侧显示取消按钮booleanfalse
action-text取消按钮文字string取消
disabled是否禁用输入框booleanfalse
readonly是否将输入框设为只读状态,只读状态下无法输入内容booleanfalse
error是否将输入内容标红booleanfalse
error-message底部错误提示文案,为空时不展示string-
formatter输入内容格式化函数(val: string) => string-
format-trigger格式化函数触发的时机,可选值为 onBlurstringonChange
input-align输入框内容对齐方式,可选值为 center rightstringleft
left-icon输入框左侧图标名称或图片链接,等同于 Icon 组件的 name 属性stringsearch
right-icon输入框右侧图标名称或图片链接,等同于 Icon 组件的 name 属性string-

Events

事件名说明回调参数
search确定搜索时触发value: string (当前输入的值)
update:model-value输入框内容变化时触发value: string (当前输入的值)
focus输入框获得焦点时触发event: Event
blur输入框失去焦点时触发event: Event
click-input点击输入区域时触发event: MouseEvent
click-left-icon点击左侧图标时触发event: MouseEvent
click-right-icon点击右侧图标时触发event: MouseEvent
clear点击清除按钮后触发event: MouseEvent
cancel点击取消按钮时触发-

方法

通过 ref 可以获取到 Search 实例并调用实例方法。

方法名说明参数返回值
focus获取输入框焦点--
blur取消输入框焦点--

Slots

名称说明
left自定义左侧内容(搜索框外)
action自定义右侧内容(搜索框外),设置 show-action 属性后展示
label自定义左侧文本(搜索框内)
left-icon自定义左侧图标(搜索框内)
right-icon自定义右侧图标(搜索框内)

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。

名称默认值描述
--z-search-padding20rpx var(--z-padding-sm)-
--z-search-backgroundvar(--z-background-2)-
--z-search-content-backgroundvar(--z-gray-1)-
--z-search-input-height68rpx-
--z-search-label-padding0 10rpx-
--z-search-label-colorvar(--z-text-color)-
--z-search-label-font-sizevar(--z-font-size-md)-
--z-search-left-icon-colorvar(--z-gray-6)-
--z-search-action-padding0 var(--z-padding-xs)-
--z-search-action-text-colorvar(--z-text-color)-
--z-search-action-font-sizevar(--z-font-size-md)-