u-search.vue 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  1. <template>
  2. <view
  3. class="u-search"
  4. :class="[iconPosition === 'right' && 'u-search__reverse']"
  5. @tap="clickHandler"
  6. :style="[{
  7. margin: margin,
  8. }, addStyle(customStyle)]"
  9. >
  10. <view
  11. class="u-search__content"
  12. :style="{
  13. backgroundColor: bgColor,
  14. borderRadius: shape == 'round' ? '100px' : '4px',
  15. borderColor: borderColor,
  16. }"
  17. >
  18. <template v-if="$slots.label || label !== null">
  19. <slot name="label">
  20. <text class="u-search__content__label">{{ label }}</text>
  21. </slot>
  22. </template>
  23. <view class="u-search__content__icon">
  24. <up-icon
  25. @tap="clickIcon"
  26. :size="searchIconSize"
  27. :name="searchIcon"
  28. :color="searchIconColor ? searchIconColor : color"
  29. ></up-icon>
  30. </view>
  31. <input
  32. confirm-type="search"
  33. @blur="blur"
  34. :value="keyword"
  35. @confirm="search"
  36. @input="inputChange"
  37. :disabled="disabled"
  38. @focus="getFocus"
  39. :focus="focus"
  40. :maxlength="maxlength"
  41. :adjust-position="adjustPosition"
  42. :auto-blur="autoBlur"
  43. placeholder-class="u-search__content__input--placeholder"
  44. :placeholder="placeholder"
  45. :placeholder-style="`color: ${placeholderColor}`"
  46. class="u-search__content__input"
  47. type="text"
  48. :style="[{
  49. pointerEvents: disabled ? 'none' : 'auto',
  50. textAlign: inputAlign,
  51. color: color,
  52. backgroundColor: bgColor,
  53. height: addUnit(height)
  54. }, inputStyle]"
  55. />
  56. <view
  57. class="u-search__content__icon u-search__content__close"
  58. v-if="isShowClear"
  59. @click="clear"
  60. >
  61. <up-icon
  62. name="close"
  63. size="11"
  64. color="#ffffff"
  65. customStyle="line-height: 12px"
  66. ></up-icon>
  67. </view>
  68. <slot name="inputRight"></slot>
  69. </view>
  70. <text
  71. :style="[actionStyle]"
  72. class="u-search__action"
  73. :class="[(showActionBtn || show) && 'u-search__action--active']"
  74. @tap.stop.prevent="custom"
  75. >{{ actionText }}</text>
  76. </view>
  77. </template>
  78. <script>
  79. import { props } from './props';
  80. import { mpMixin } from '../../libs/mixin/mpMixin';
  81. import { mixin } from '../../libs/mixin/mixin';
  82. import { addUnit, addStyle } from '../../libs/function/index';
  83. /**
  84. * search 搜索框
  85. * @description 搜索组件,集成了常见搜索框所需功能,用户可以一键引入,开箱即用。
  86. * @tutorial https://ijry.github.io/uview-plus/components/search.html
  87. * @property {String} shape 搜索框形状,round-圆形,square-方形(默认 'round' )
  88. * @property {String} bgColor 搜索框背景颜色(默认 '#f2f2f2' )
  89. * @property {String} placeholder 占位文字内容(默认 '请输入关键字' )
  90. * @property {Boolean} clearabled 是否启用清除控件(默认 true )
  91. * @property {Boolean} focus 是否自动获得焦点(默认 false )
  92. * @property {Boolean} showAction 是否显示右侧控件(默认 true )
  93. * @property {Object} actionStyle 右侧控件的样式,对象形式
  94. * @property {String} actionText 右侧控件文字(默认 '搜索' )
  95. * @property {String} inputAlign 输入框内容水平对齐方式 (默认 'left' )
  96. * @property {Object} inputStyle 自定义输入框样式,对象形式
  97. * @property {Boolean} disabled 是否启用输入框(默认 false )
  98. * @property {String} borderColor 边框颜色,配置了颜色,才会有边框 (默认 'transparent' )
  99. * @property {String} searchIconColor 搜索图标的颜色,默认同输入框字体颜色 (默认 '#909399' )
  100. * @property {Number | String} searchIconSize 搜索图标的字体,默认22
  101. * @property {String} color 输入框字体颜色(默认 '#606266' )
  102. * @property {String} placeholderColor placeholder的颜色(默认 '#909399' )
  103. * @property {String} searchIcon 输入框左边的图标,可以为uView图标名称或图片路径 (默认 'search' )
  104. * @property {String} iconPosition 输入框图标位置,left-左边, right-右边 (默认 'left' )
  105. * @property {String} margin 组件与其他上下左右元素之间的距离,带单位的字符串形式,如"30px" (默认 '0' )
  106. * @property {Boolean} animation 是否开启动画,见上方说明(默认 false )
  107. * @property {String} value 输入框初始值
  108. * @property {String | Number} maxlength 输入框最大能输入的长度,-1为不限制长度 (默认 '-1' )
  109. * @property {String | Number} height 输入框高度,单位px(默认 64 )
  110. * @property {String | Number} label 搜索框左边显示内容
  111. * @property {Boolean} adjustPosition 键盘弹起时,是否自动上推页面
  112. * @property {Boolean} autoBlur 键盘收起时,是否自动失去焦点
  113. * @property {Boolean} onlyClearableOnFocused 是否仅在聚焦时显示清除控件(默认 true )
  114. * @property {Object} customStyle 定义需要用到的外部样式
  115. *
  116. * @event {Function} change 输入框内容发生变化时触发
  117. * @event {Function} search 用户确定搜索时触发,用户按回车键,或者手机键盘右下角的"搜索"键时触发
  118. * @event {Function} custom 用户点击右侧控件时触发
  119. * @event {Function} clear 用户点击清除按钮时触发
  120. * @example <u-search placeholder="日照香炉生紫烟" v-model="keyword"></u-search>
  121. */
  122. export default {
  123. name: "u-search",
  124. mixins: [mpMixin, mixin, props],
  125. data() {
  126. return {
  127. keyword: '',
  128. show: false,
  129. // 标记input当前状态是否处于聚焦中,如果是,才会显示右侧的清除控件
  130. focused: this.focus
  131. // 绑定输入框的值
  132. // inputValue: this.value
  133. };
  134. },
  135. watch: {
  136. keyword(nVal) {
  137. // 双向绑定值,让v-model绑定的值双向变化
  138. // #ifdef VUE3
  139. this.$emit("update:modelValue", nVal);
  140. // #endif
  141. // #ifdef VUE2
  142. this.$emit('input', nVal);
  143. // #endif
  144. // 触发change事件,事件效果和v-model双向绑定的效果一样,让用户多一个选择
  145. this.$emit('change', nVal);
  146. },
  147. // #ifdef VUE3
  148. modelValue: {
  149. immediate: true,
  150. handler(nVal) {
  151. this.keyword = nVal;
  152. }
  153. },
  154. // #endif
  155. // #ifdef VUE2
  156. value: {
  157. immediate: true,
  158. handler(nVal) {
  159. this.keyword = nVal;
  160. }
  161. },
  162. // #endif
  163. },
  164. computed: {
  165. showActionBtn() {
  166. return !this.animation && this.showAction
  167. },
  168. // 是否显示清除控件
  169. isShowClear() {
  170. const { clearabled, focused, keyword, onlyClearableOnFocused } = this;
  171. if (!clearabled) {
  172. return false;
  173. }
  174. if (onlyClearableOnFocused) {
  175. return !!focused && keyword !== "";
  176. } else {
  177. return keyword !== "";
  178. }
  179. }
  180. },
  181. emits: ['clear', 'search', 'custom', 'focus', 'blur', 'click', 'clickIcon', 'update:modelValue', 'change'],
  182. methods: {
  183. addStyle,
  184. addUnit,
  185. // 目前HX2.6.9 v-model双向绑定无效,故监听input事件获取输入框内容的变化
  186. inputChange(e) {
  187. this.keyword = e.detail.value;
  188. },
  189. // 清空输入
  190. // 也可以作为用户通过this.$refs形式调用清空输入框内容
  191. clear() {
  192. this.keyword = '';
  193. // 延后发出事件,避免在父组件监听clear事件时,value为更新前的值(不为空)
  194. this.$nextTick(() => {
  195. this.$emit('clear');
  196. })
  197. },
  198. // 确定搜索
  199. search(e) {
  200. this.$emit('search', e.detail.value);
  201. try {
  202. // 收起键盘
  203. uni.hideKeyboard();
  204. } catch (e) {}
  205. },
  206. // 点击右边自定义按钮的事件
  207. custom() {
  208. this.$emit('custom', this.keyword);
  209. try {
  210. // 收起键盘
  211. uni.hideKeyboard();
  212. } catch (e) {}
  213. },
  214. // 获取焦点
  215. getFocus() {
  216. this.focused = true;
  217. // 开启右侧搜索按钮展开的动画效果
  218. if (this.animation && this.showAction) this.show = true;
  219. this.$emit('focus', this.keyword);
  220. },
  221. // 失去焦点
  222. blur() {
  223. // 最开始使用的是监听图标@touchstart事件,自从hx2.8.4后,此方法在微信小程序出错
  224. // 这里改为监听点击事件,手点击清除图标时,同时也发生了@blur事件,导致图标消失而无法点击,这里做一个延时
  225. setTimeout(() => {
  226. this.focused = false;
  227. }, 100)
  228. this.show = false;
  229. this.$emit('blur', this.keyword);
  230. },
  231. // 点击搜索框,只有disabled=true时才发出事件,因为禁止了输入,意味着是想跳转真正的搜索页
  232. clickHandler() {
  233. if (this.disabled) this.$emit('click');
  234. },
  235. // 点击左边图标
  236. clickIcon(e) {
  237. this.$emit('clickIcon', this.keyword);
  238. try {
  239. // 收起键盘
  240. uni.hideKeyboard();
  241. } catch (e) {}
  242. }
  243. }
  244. }
  245. </script>
  246. <style lang="scss" scoped>
  247. $u-search-content-padding: 0 10px !default;
  248. $u-search-label-color: $u-main-color !default;
  249. $u-search-label-font-size: 14px !default;
  250. $u-search-label-margin: 0 4px !default;
  251. $u-search-close-size: 20px !default;
  252. $u-search-close-radius: 100px !default;
  253. $u-search-close-bgColor: #C6C7CB !default;
  254. $u-search-close-transform: scale(0.82) !default;
  255. $u-search-input-font-size: 14px !default;
  256. $u-search-input-margin: 0 5px !default;
  257. $u-search-input-color: $u-main-color !default;
  258. $u-search-input-placeholder-color: $u-tips-color !default;
  259. $u-search-action-font-size: 14px !default;
  260. $u-search-action-color: $u-main-color !default;
  261. $u-search-action-width: 0 !default;
  262. $u-search-action-active-width: 40px !default;
  263. $u-search-action-margin-left: 5px !default;
  264. /* #ifdef H5 */
  265. // iOS15在H5下,hx的某些版本,input type=search时,会多了一个搜索图标,进行移除
  266. [type="search"]::-webkit-search-decoration {
  267. display: none;
  268. }
  269. /* #endif */
  270. .u-search {
  271. @include flex(row);
  272. align-items: center;
  273. flex: 1;
  274. &__content {
  275. @include flex;
  276. align-items: center;
  277. padding: $u-search-content-padding;
  278. flex: 1;
  279. justify-content: space-between;
  280. border-width: 1px;
  281. border-color: transparent;
  282. border-style: solid;
  283. overflow: hidden;
  284. &__icon {
  285. @include flex;
  286. align-items: center;
  287. }
  288. &__label {
  289. color: $u-search-label-color;
  290. font-size: $u-search-label-font-size;
  291. margin: $u-search-label-margin;
  292. }
  293. &__close {
  294. width: $u-search-close-size;
  295. height: $u-search-close-size;
  296. border-top-left-radius: $u-search-close-radius;
  297. border-top-right-radius: $u-search-close-radius;
  298. border-bottom-left-radius: $u-search-close-radius;
  299. border-bottom-right-radius: $u-search-close-radius;
  300. background-color: $u-search-close-bgColor;
  301. @include flex(row);
  302. align-items: center;
  303. justify-content: center;
  304. transform: $u-search-close-transform;
  305. }
  306. &__input {
  307. flex: 1;
  308. font-size: $u-search-input-font-size;
  309. line-height: 1;
  310. margin: $u-search-input-margin;
  311. color: $u-search-input-color;
  312. &--placeholder {
  313. color: $u-search-input-placeholder-color;
  314. }
  315. }
  316. }
  317. &__action {
  318. font-size: $u-search-action-font-size;
  319. color: $u-search-action-color;
  320. width: $u-search-action-width;
  321. overflow: hidden;
  322. transition-property: width;
  323. transition-duration: 0.3s;
  324. /* #ifndef APP-NVUE */
  325. white-space: nowrap;
  326. /* #endif */
  327. text-align: center;
  328. &--active {
  329. width: $u-search-action-active-width;
  330. margin-left: $u-search-action-margin-left;
  331. }
  332. }
  333. &__reverse &__content__icon {
  334. order: 3;
  335. }
  336. &__reverse &__content__close {
  337. order: 2;
  338. }
  339. }
  340. </style>