Browse Source

fix: searchBar 组件文档完善

杨小璐 5 years ago
parent
commit
e02a89e115

+ 9 - 5
src/packages/searchbar/demo.vue

@@ -2,25 +2,29 @@
   <div class="s-bar demo-list">
     <h4>基本用法</h4>
     <div class="demo1">
-      <nut-searchbar :hasIcon="true" :hasSearchButton="false"></nut-searchbar>
+      <nut-searchbar :hasIcon="true" :hasSearchButton="false" :clearable='true'></nut-searchbar>
     </div>
 
     <h4>搜索框对齐方式</h4>
     <div class="demo1">
-      <nut-searchbar :hasSearchButton="false" inputAlign="center"></nut-searchbar>
+      <nut-searchbar :hasIcon="true" :hasSearchButton="false" inputAlign="center"></nut-searchbar>
     </div>
 
     <h4>自定义右侧按钮</h4>
     <div class="demo1">
-      <nut-searchbar placeText="请输入关键词" :hasSearchButton="true" @submit="submitFun"></nut-searchbar>
+      <nut-searchbar placeText="右侧默认图标" @submit="submitFun"></nut-searchbar>
     </div>
 
     <div class="demo1">
-      <nut-searchbar placeText="请输入关键词" :hasTextButton="true" @submit="submitFun"></nut-searchbar>
+      <nut-searchbar placeText="右侧图标自定义" @submit="submitFun" :searchBtnIcon="require('../../assets/svg/qr.svg')"></nut-searchbar>
+    </div>
+
+    <div class="demo1">
+      <nut-searchbar placeText="右侧默认文字" :hasTextButton="true" @submit="submitFun"></nut-searchbar>
     </div>
     
     <div class="demo1">
-      <nut-searchbar placeText="请输入关键词" :hasIcon="true" :hasTextButton="true" textInfo="取消" customClass="search_demo" @submit="submitFun"></nut-searchbar>
+      <nut-searchbar placeText="右侧文字自定义" :hasIcon="true" :hasTextButton="true" textInfo="取消" @submit="submitFun"></nut-searchbar>
     </div>
 
     <h4>自定义搜索框右侧按钮</h4>

+ 57 - 12
src/packages/searchbar/doc.md

@@ -8,28 +8,64 @@
 <nut-searchbar 
     :hasIcon="true" 
     :hasSearchButton="false"
+    :clearable='true'
 ></nut-searchbar>
 ```
 
-## 右侧搜索按钮可根据需要进行配置
+## 搜索框对齐方式
 
 ```html
-<nut-searchbar
-    placeText="请输入自定义文案"
-    :hasSearchButton="false"
+<nut-searchbar 
+    :hasIcon="true"
+    :hasSearchButton="false" 
+    inputAlign="center"
 ></nut-searchbar>
 ```
 
-## 可配置输入框前面是否显示搜索图标、右侧是否显示文字按钮、显示文字、自定义 class
+## 自定义右侧按钮
 
 ```html
-<nut-searchbar
-    placeText="ERP/姓名/邮箱"
-    :hasIcon="true"
-    :hasTextButton="true"
-    textInfo="取消"
-    customClass="search_demo"
-></nut-searchbar>
+
+// 默认图标
+<nut-searchbar placeText="右侧默认图标" @submit="submitFun"></nut-searchbar>
+
+// 自定义图标
+<nut-searchbar placeText="右侧图标自定义" @submit="submitFun" :searchButtonIcon="require('../../assets/svg/qr.svg')"></nut-searchbar>
+
+// 默认文案
+<nut-searchbar placeText="右侧默认文字" :hasTextButton="true" @submit="submitFun"></nut-searchbar>
+
+// 自定义文案
+<nut-searchbar placeText="右侧文字自定义" :hasIcon="true" :hasTextButton="true" textInfo="取消" @submit="submitFun"></nut-searchbar>
+
+export default {
+    methods:{
+        submitFun(value) {
+            console.log('您输入的内容为:'+value);
+            console.log('您触发了右侧按钮的事件,默认提交操作!');
+        }
+    }
+}
+```
+
+## 自定义搜索框右侧按钮
+
+```html
+
+// 默认图标
+<nut-searchbar :hasIcon="true" :hasSearchButton="false" :hasAction="true" @handleAction="handleAction"></nut-searchbar>
+
+// 自定义图标
+<nut-searchbar :hasIcon="true" :hasSearchButton="false" :hasAction="true" :actionIcon="require('../../assets/svg/rate-default-img.svg')" @handleAction="handleAction"></nut-searchbar>
+
+export default {
+    methods:{
+        handleAction(value){
+            console.log('您输入的内容为:'+value);
+            console.log('您点击了input搜索框右侧的图标')
+        }
+    }
+}
 ```
 
 ## 事件
@@ -42,6 +78,7 @@
     @blur="blurFun"
     @submit="submitFun"
 ></nut-searchbar>
+
 ```
 
 ## 获取焦点与失去焦点
@@ -102,6 +139,7 @@ export default {
 |----- | ----- | ----- | -----
 | hasIcon | 是否显示输入框前面的 icon | Boolean | false
 | placeText | 输入框 placeholder 内容 | String | '请输入内容...'
+| inputAlign | 输入框内容的对齐方式,可选值:left/center/right| String | left
 | hasSearchButton | 是否显示右侧搜索按钮 | Boolean | true
 | hasTextButton | 右侧搜索按钮是否为文字按钮 | Boolean | false
 | textInfo | 右侧文字搜索按钮文案 | String | '搜索'
@@ -109,10 +147,15 @@ export default {
 | customClass | 自定义 class | String | ''
 | searchIconSize | Search 图标的尺寸 | String | '20px'
 | searchIconColor | Search 图标的颜色 | String | '#2e2d2d'
+| searchBtnIcon | 自定义 Search 图标 | String | 默认 搜索图标
 | searchBtnIconSize | 搜索按钮图标的尺寸 | String | '20px'
 | searchBtnIconColor | 搜索按钮图标的颜色 | String | '#2e2d2d'
+| clearable | 是否启用清除控件 | Boolean | true
 | clearIconSize | 清空按钮图标的尺寸 | String | '15px'
 | clearIconColor | 清空按钮图标的颜色 | String | '#2e2d2d'
+| hasAction | 输入框右侧是否展示图标 | Boolean | false
+| actionIcon | 自定义输入框右侧图标 | String | 二维码图标
+| actionIconSize | 设置自定义输入框右侧图标的大小 | String | '20px'
 
 ## Event
 
@@ -122,3 +165,5 @@ export default {
 | input | 输入框输入内容时触发事件 | 无
 | blur | 输入框失去焦点时触发事件 | 无
 | submit | 默认提交事件,点击右侧Icon或文字也会触发 | 无
+| handleAction | 点击输入框右侧图标触发 | 无
+

+ 7 - 1
src/packages/searchbar/searchbar.vue

@@ -27,7 +27,8 @@
     </div>
     <div class="btn-right" v-if="hasSearchButton" @click="submitFun">
       <span v-if="hasTextButton">{{ textInfo || nutTranslate('lang.searchbar.textInfo') }}</span>
-      <nut-icon type="search3" v-else :size="searchBtnIconSize" :color="searchBtnIconColor"></nut-icon>
+      <nut-icon type="search3" v-if="!hasTextButton && searchBtnIcon == ''" :size="searchBtnIconSize" :color="searchBtnIconColor"></nut-icon>
+      <nut-icon type="self" v-if="!hasTextButton && searchBtnIcon != ''" :size="searchBtnIconSize" :color="searchBtnIconColor" :url='searchBtnIcon'></nut-icon>
     </div>
   </div>
 </template>
@@ -106,6 +107,11 @@ export default {
     actionIconSize:{
       type:String,
       default:'20px'
+    },
+    // 新增 右侧按钮图标
+    searchBtnIcon:{
+      type:String,
+      default:''
     }
   },
   components: {