u-input.vue 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. <template>
  2. <view class="u-input" :class="inputClass" :style="[wrapperStyle]">
  3. <view class="u-input__content">
  4. <view
  5. class="u-input__content__prefix-icon"
  6. v-if="prefixIcon || $slots.prefix"
  7. >
  8. <slot name="prefix">
  9. <u-icon
  10. :name="prefixIcon"
  11. size="18"
  12. :customStyle="prefixIconStyle"
  13. ></u-icon>
  14. </slot>
  15. </view>
  16. <view class="u-input__content__field-wrapper" @tap="clickHandler">
  17. <!-- 根据uni-app的input组件文档,H5和APP中只要声明了password参数(无论true还是false),type均失效,此时
  18. 为了防止type=number时,又存在password属性,type无效,此时需要设置password为undefined
  19. -->
  20. <input
  21. class="u-input__content__field-wrapper__field"
  22. :style="[inputStyle]"
  23. :type="type"
  24. :focus="focus"
  25. :cursor="cursor"
  26. :value="innerValue"
  27. :auto-blur="autoBlur"
  28. :disabled="disabled || readonly"
  29. :maxlength="maxlength"
  30. :placeholder="placeholder"
  31. :placeholder-style="placeholderStyle"
  32. :placeholder-class="placeholderClass"
  33. :confirm-type="confirmType"
  34. :confirm-hold="confirmHold"
  35. :hold-keyboard="holdKeyboard"
  36. :cursor-spacing="cursorSpacing"
  37. :adjust-position="adjustPosition"
  38. :selection-end="selectionEnd"
  39. :selection-start="selectionStart"
  40. :password="password || type === 'password' || undefined"
  41. :ignoreCompositionEvent="ignoreCompositionEvent"
  42. @input="onInput"
  43. @blur="onBlur"
  44. @focus="onFocus"
  45. @confirm="onConfirm"
  46. @keyboardheightchange="onkeyboardheightchange"
  47. />
  48. </view>
  49. <view
  50. class="u-input__content__clear"
  51. v-if="isShowClear"
  52. @click="onClear"
  53. >
  54. <u-icon
  55. name="close"
  56. size="11"
  57. color="#ffffff"
  58. customStyle="line-height: 12px"
  59. ></u-icon>
  60. </view>
  61. <view
  62. class="u-input__content__subfix-icon"
  63. v-if="suffixIcon || $slots.suffix"
  64. >
  65. <slot name="suffix">
  66. <u-icon
  67. :name="suffixIcon"
  68. size="18"
  69. :customStyle="suffixIconStyle"
  70. ></u-icon>
  71. </slot>
  72. </view>
  73. </view>
  74. </view>
  75. </template>
  76. <script>
  77. import props from "./props.js";
  78. import mpMixin from '../../libs/mixin/mpMixin.js';
  79. import mixin from '../../libs/mixin/mixin.js';
  80. /**
  81. * Input 输入框
  82. * @description 此组件为一个输入框,默认没有边框和样式,是专门为配合表单组件u-form而设计的,利用它可以快速实现表单验证,输入内容,下拉选择等功能。
  83. * @tutorial https://uiadmin.net/uview-plus/components/input.html
  84. * @property {String | Number} value 输入的值
  85. * @property {String} type 输入框类型,见上方说明 ( 默认 'text' )
  86. * @property {Boolean} fixed 如果 textarea 是在一个 position:fixed 的区域,需要显示指定属性 fixed 为 true,兼容性:微信小程序、百度小程序、字节跳动小程序、QQ小程序 ( 默认 false )
  87. * @property {Boolean} disabled 是否禁用输入框 ( 默认 false )
  88. * @property {String} disabledColor 禁用状态时的背景色( 默认 '#f5f7fa' )
  89. * @property {Boolean} clearable 是否显示清除控件 ( 默认 false )
  90. * @property {Boolean} password 是否密码类型 ( 默认 false )
  91. * @property {String | Number} maxlength 最大输入长度,设置为 -1 的时候不限制最大长度 ( 默认 -1 )
  92. * @property {String} placeholder 输入框为空时的占位符
  93. * @property {String} placeholderClass 指定placeholder的样式类,注意页面或组件的style中写了scoped时,需要在类名前写/deep/ ( 默认 'input-placeholder' )
  94. * @property {String | Object} placeholderStyle 指定placeholder的样式,字符串/对象形式,如"color: red;"
  95. * @property {Boolean} showWordLimit 是否显示输入字数统计,只在 type ="text"或type ="textarea"时有效 ( 默认 false )
  96. * @property {String} confirmType 设置右下角按钮的文字,兼容性详见uni-app文档 ( 默认 'done' )
  97. * @property {Boolean} confirmHold 点击键盘右下角按钮时是否保持键盘不收起,H5无效 ( 默认 false )
  98. * @property {Boolean} holdKeyboard focus时,点击页面的时候不收起键盘,微信小程序有效 ( 默认 false )
  99. * @property {Boolean} focus 自动获取焦点,在 H5 平台能否聚焦以及软键盘是否跟随弹出,取决于当前浏览器本身的实现。nvue 页面不支持,需使用组件的 focus()、blur() 方法控制焦点 ( 默认 false )
  100. * @property {Boolean} autoBlur 键盘收起时,是否自动失去焦点,目前仅App3.0.0+有效 ( 默认 false )
  101. * @property {Boolean} disableDefaultPadding 是否去掉 iOS 下的默认内边距,仅微信小程序,且type=textarea时有效 ( 默认 false )
  102. * @property {String | Number} cursor 指定focus时光标的位置( 默认 -1 )
  103. * @property {String | Number} cursorSpacing 输入框聚焦时底部与键盘的距离 ( 默认 30 )
  104. * @property {String | Number} selectionStart 光标起始位置,自动聚集时有效,需与selection-end搭配使用 ( 默认 -1 )
  105. * @property {String | Number} selectionEnd 光标结束位置,自动聚集时有效,需与selection-start搭配使用 ( 默认 -1 )
  106. * @property {Boolean} adjustPosition 键盘弹起时,是否自动上推页面 ( 默认 true )
  107. * @property {String} inputAlign 输入框内容对齐方式( 默认 'left' )
  108. * @property {String | Number} fontSize 输入框字体的大小 ( 默认 '15px' )
  109. * @property {String} color 输入框字体颜色 ( 默认 '#303133' )
  110. * @property {Function} formatter 内容式化函数
  111. * @property {String} prefixIcon 输入框前置图标
  112. * @property {String | Object} prefixIconStyle 前置图标样式,对象或字符串
  113. * @property {String} suffixIcon 输入框后置图标
  114. * @property {String | Object} suffixIconStyle 后置图标样式,对象或字符串
  115. * @property {String} border 边框类型,surround-四周边框,bottom-底部边框,none-无边框 ( 默认 'surround' )
  116. * @property {Boolean} readonly 是否只读,与disabled不同之处在于disabled会置灰组件,而readonly则不会 ( 默认 false )
  117. * @property {String} shape 输入框形状,circle-圆形,square-方形 ( 默认 'square' )
  118. * @property {Object} customStyle 定义需要用到的外部样式
  119. * @property {Boolean} ignoreCompositionEvent 是否忽略组件内对文本合成系统事件的处理。
  120. * @example <u-input v-model="value" :password="true" suffix-icon="lock-fill" />
  121. */
  122. export default {
  123. name: "u-input",
  124. mixins: [mpMixin, mixin, props],
  125. data() {
  126. return {
  127. // 输入框的值
  128. innerValue: "",
  129. // 是否处于获得焦点状态
  130. focused: false,
  131. // value是否第一次变化,在watch中,由于加入immediate属性,会在第一次触发,此时不应该认为value发生了变化
  132. firstChange: true,
  133. // value绑定值的变化是由内部还是外部引起的
  134. changeFromInner: false,
  135. // 过滤处理方法
  136. innerFormatter: value => value
  137. };
  138. },
  139. watch: {
  140. // #ifdef VUE3
  141. modelValue: {
  142. immediate: true,
  143. handler(newVal, oldVal) {
  144. this.innerValue = newVal;
  145. /* #ifdef H5 */
  146. // 在H5中,外部value变化后,修改input中的值,不会触发@input事件,此时手动调用值变化方法
  147. if (
  148. this.firstChange === false &&
  149. this.changeFromInner === false
  150. ) {
  151. this.valueChange();
  152. }
  153. /* #endif */
  154. this.firstChange = false;
  155. // 重置changeFromInner的值为false,标识下一次引起默认为外部引起的
  156. this.changeFromInner = false;
  157. },
  158. },
  159. // #endif
  160. // #ifdef VUE2
  161. value: {
  162. immediate: true,
  163. handler(newVal, oldVal) {
  164. this.innerValue = newVal;
  165. /* #ifdef H5 */
  166. // 在H5中,外部value变化后,修改input中的值,不会触发@input事件,此时手动调用值变化方法
  167. if (
  168. this.firstChange === false &&
  169. this.changeFromInner === false
  170. ) {
  171. this.valueChange();
  172. }
  173. /* #endif */
  174. this.firstChange = false;
  175. // 重置changeFromInner的值为false,标识下一次引起默认为外部引起的
  176. this.changeFromInner = false;
  177. },
  178. },
  179. // #endif
  180. },
  181. computed: {
  182. // 是否显示清除控件
  183. isShowClear() {
  184. const { clearable, readonly, focused, innerValue } = this;
  185. return !!clearable && !readonly && !!focused && innerValue !== "";
  186. },
  187. // 组件的类名
  188. inputClass() {
  189. let classes = [],
  190. { border, disabled, shape } = this;
  191. border === "surround" &&
  192. (classes = classes.concat(["u-border", "u-input--radius"]));
  193. classes.push(`u-input--${shape}`);
  194. border === "bottom" &&
  195. (classes = classes.concat([
  196. "u-border-bottom",
  197. "u-input--no-radius",
  198. ]));
  199. return classes.join(" ");
  200. },
  201. // 组件的样式
  202. wrapperStyle() {
  203. const style = {};
  204. // 禁用状态下,被背景色加上对应的样式
  205. if (this.disabled) {
  206. style.backgroundColor = this.disabledColor;
  207. }
  208. // 无边框时,去除内边距
  209. if (this.border === "none") {
  210. style.padding = "0";
  211. } else {
  212. // 由于uni-app的iOS开发者能力有限,导致需要分开写才有效
  213. style.paddingTop = "6px";
  214. style.paddingBottom = "6px";
  215. style.paddingLeft = "9px";
  216. style.paddingRight = "9px";
  217. }
  218. return uni.$u.deepMerge(style, uni.$u.addStyle(this.customStyle));
  219. },
  220. // 输入框的样式
  221. inputStyle() {
  222. const style = {
  223. color: this.color,
  224. fontSize: uni.$u.addUnit(this.fontSize),
  225. textAlign: this.inputAlign
  226. };
  227. return style;
  228. },
  229. },
  230. // #ifdef VUE3
  231. emits: ['update:modelValue', 'focus', 'blur', 'change', 'confirm', 'clear', 'keyboardheightchange'],
  232. // #endif
  233. methods: {
  234. // 在微信小程序中,不支持将函数当做props参数,故只能通过ref形式调用
  235. setFormatter(e) {
  236. this.innerFormatter = e
  237. },
  238. // 当键盘输入时,触发input事件
  239. onInput(e) {
  240. let { value = "" } = e.detail || {};
  241. // 格式化过滤方法
  242. const formatter = this.formatter || this.innerFormatter
  243. const formatValue = formatter(value)
  244. // 为了避免props的单向数据流特性,需要先将innerValue值设置为当前值,再在$nextTick中重新赋予设置后的值才有效
  245. this.innerValue = value
  246. this.$nextTick(() => {
  247. this.innerValue = formatValue;
  248. this.valueChange();
  249. })
  250. },
  251. // 输入框失去焦点时触发
  252. onBlur(event) {
  253. this.$emit("blur", event.detail.value);
  254. // H5端的blur会先于点击清除控件的点击click事件触发,导致focused
  255. // 瞬间为false,从而隐藏了清除控件而无法被点击到
  256. uni.$u.sleep(50).then(() => {
  257. this.focused = false;
  258. });
  259. // 尝试调用u-form的验证方法
  260. uni.$u.formValidate(this, "blur");
  261. },
  262. // 输入框聚焦时触发
  263. onFocus(event) {
  264. this.focused = true;
  265. this.$emit("focus");
  266. },
  267. // 点击完成按钮时触发
  268. onConfirm(event) {
  269. this.$emit("confirm", this.innerValue);
  270. },
  271. // 键盘高度发生变化的时候触发此事件
  272. // 兼容性:微信小程序2.7.0+、App 3.1.0+
  273. onkeyboardheightchange(event) {
  274. this.$emit("keyboardheightchange", event);
  275. },
  276. // 内容发生变化,进行处理
  277. valueChange() {
  278. const value = this.innerValue;
  279. this.$nextTick(() => {
  280. // #ifdef VUE3
  281. this.$emit("update:modelValue", value);
  282. // #endif
  283. // #ifdef VUE2
  284. this.$emit("input", value);
  285. // #endif
  286. // 标识value值的变化是由内部引起的
  287. this.changeFromInner = true;
  288. this.$emit("change", value);
  289. // 尝试调用u-form的验证方法
  290. uni.$u.formValidate(this, "change");
  291. });
  292. },
  293. // 点击清除控件
  294. onClear() {
  295. this.innerValue = "";
  296. this.$nextTick(() => {
  297. this.valueChange();
  298. this.$emit("clear");
  299. });
  300. },
  301. /**
  302. * 在安卓nvue上,事件无法冒泡
  303. * 在某些时间,我们希望监听u-from-item的点击事件,此时会导致点击u-form-item内的u-input后
  304. * 无法触发u-form-item的点击事件,这里通过手动调用u-form-item的方法进行触发
  305. */
  306. clickHandler() {
  307. // #ifdef APP-NVUE
  308. if (uni.$u.os() === "android") {
  309. const formItem = uni.$u.$parent.call(this, "u-form-item");
  310. if (formItem) {
  311. formItem.clickHandler();
  312. }
  313. }
  314. // #endif
  315. },
  316. },
  317. };
  318. </script>
  319. <style lang="scss" scoped>
  320. @import "../../libs/css/components.scss";
  321. .u-input {
  322. @include flex(row);
  323. align-items: center;
  324. justify-content: space-between;
  325. flex: 1;
  326. &--radius,
  327. &--square {
  328. border-radius: 4px;
  329. }
  330. &--no-radius {
  331. border-radius: 0;
  332. }
  333. &--circle {
  334. border-radius: 100px;
  335. }
  336. &__content {
  337. flex: 1;
  338. @include flex(row);
  339. align-items: center;
  340. justify-content: space-between;
  341. &__field-wrapper {
  342. position: relative;
  343. @include flex(row);
  344. margin: 0;
  345. flex: 1;
  346. &__field {
  347. line-height: 26px;
  348. text-align: left;
  349. color: $u-main-color;
  350. height: 24px;
  351. font-size: 15px;
  352. flex: 1;
  353. }
  354. }
  355. &__clear {
  356. width: 20px;
  357. height: 20px;
  358. border-radius: 100px;
  359. background-color: #c6c7cb;
  360. @include flex(row);
  361. align-items: center;
  362. justify-content: center;
  363. transform: scale(0.82);
  364. margin-left: 4px;
  365. }
  366. &__subfix-icon {
  367. margin-left: 4px;
  368. }
  369. &__prefix-icon {
  370. margin-right: 4px;
  371. }
  372. }
  373. }
  374. </style>