u-search.vue 9.8 KB

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