跳到主要内容

搜索 Search

适用于搜索场景

安装使用

import { TiSearch } from '@titian-design/mobile-vue'

用法示例

基础用法

<template>
<TiSearch :value="value" @search="onSearch" />
</template>

<script lang="ts" setup>
import { TiSearch } from '@titian-design/mobile-vue';
</script>

居中模式

<template>
<TiSearch center />
</template>

<script lang="ts" setup>
import { TiSearch } from '@titian-design/mobile-vue';
</script>

搜索按钮状态

属性含义:
  1. animation 设置关闭搜索按钮动画。
  2. always-show-search 设置一直显示搜索按钮。
  3. use-search-button 设置不使用组件自带的搜索按钮。
<template>
<TiSearch :animation="false" />
<TiSearch always-show-search />
<TiSearch :use-search-button="false" />
</template>

<script lang="ts" setup>
import { TiSearch } from '@titian-design/mobile-vue';
</script>

使用插槽

包括4个插槽,整体组件前后位置插槽,以及输入框左右插槽

<template>
<TiSearch>
<div slot="prefix">
<span>请选择</span>
<TiIcon name="arrow-down" size="32" />
</div>
<TiIcon slot="right-icon" name="scan" size="32" />
<TiSearch />
<TiSearch>
<div slot="prefix">
<TiIcon name="category" size="42" />
</div>
<div slot="suffix">
<TiIcon name="arrange" size="42" />
</div>
<TiSearch />
</template>

<script lang="ts" setup>
import { TiSearch } from '@titian-design/mobile-vue';
</script>

键盘确认按钮文字

<template>
<TiSearch confirm-type="done" value="完成" />
<TiSearch confirm-type="send" value="发送" />
<TiSearch confirm-type="search" value="搜索" />
<TiSearch confirm-type="next" value="下一项" />
<TiSearch confirm-type="go" value="前往" />
</template>

<script lang="ts" setup>
import { TiSearch } from '@titian-design/mobile-vue';
</script>

TiSearch API

属性 Properties

名称类型必填默认值说明备注
valuestring-当前输入的值-
centerbooleanfalse输入框内容对齐方式,采用居中模式-
placeholderstring-输入框为空时占位符-
autofocusbooleanfalse获取焦点-
disabledbooleanfalse输入框禁用-
read-onlybooleanfalse输入框只读-
confirm-typestringsearch设置键盘右下角按钮的文字,仅在type='text'时生效-
clearablebooleantrue是否启用清除控件-
left-iconstringsearch左侧搜索图标,不启用传none-
ext-stylestring | Record<string, string>-根节点样式-
animationbooleantrue是否启用搜索按钮动画-
always-show-searchbooleanfalse是否常显搜索按钮,默认在聚焦状态下隐藏-
always-show-prefixbooleanfalse是否常显前置插槽,默认在聚焦状态下隐藏-
always-show-suffixbooleanfalse是否常显后置插槽,默认在聚焦状态下隐藏-
always-show-right-iconbooleanfalse是否常显右侧图标插槽,默认在聚焦状态下隐藏-
use-search-buttonbooleantrue是否启用组件搜索按钮-

事件 Events

名称参数列表描述备注
focus(e: CustomEvent) => void输入框聚焦时触发-
blur(e: CustomEvent) => void输入框失焦时触发-
search(e: CustomEvent<{value: string}>) => void确定搜索时触发-
change(e: CustomEvent<{value: string}>) => void输入值变化时触发-
clear(e: CustomEvent) => void清除时触发-
click-input(e: CustomEvent) => void点击输入框是触发-

插槽 Slots

名称说明备注
prefix输入框外部左侧插槽-
left-icon输入框内部左侧插槽-
right-icon输入框内部右侧插槽-
suffix输入框外部右侧插槽-

外部样式类 External Classes

名称说明备注
ext-class根节点样式类-
search-button-class搜索按钮样式类如果不需要按钮动画,可使用 transition: none;覆盖
search-inner-class搜索框容器样式类
input-classinput 样式类-

CSS 变量 CSS Variable

变量默认值说明备注
--search-font-size28px搜索文字字号-
--search-out-height108px搜索框整体高度-
--search-out-background#fff搜索框整体背景色-
--search-out-padding-v0px搜索框整体垂直方向内边距-
--search-out-padding-h28px搜索框整体水平方向内边距-
--search-inner-height72px搜索框内部输入区域高度-
--search-inner-background#f5f5f5搜索框内部输入区域背景色-
--search-inner-padding-v0px搜索框内部输入区域垂直方向内边距-
--search-inner-padding-h28px搜索框内部输入区域水平方向内边距-
--search-radiuscalc(var(--capsule-radius-size, 0px) + 12px)搜索框容器圆角-
--capsule-radius-size0px全局圆角增量,控制图标风格。在项目根节点统一设置-
--search-icon-color#212121搜索图标颜色-