# BsQuery 文档

l

<template>
  <DocTable
    :table-data="tableData"
  />
</template>

<script>
  export default {
    data() {
      return {
        tableData: [
          {
            keyName: 'Props',
            desc: '参数',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'perLineItemCount',
                desc: '每行显示的项目数',
                type: 'number',
                enum: '',
                defVal: '6',
                emc: ''
              },
              {
                keyName: 'queryConfig',
                desc: '要显示哪些预设按钮',
                type: 'Object',
                enum: '',
                defVal: `{ searchBtnText: '搜索', resetBtnText: '重置', moreBtnText: '更多查询' }`,
                emc: '',
                children: [
                  {
                    keyName: 'searchBtnText',
                    desc: '是否显示 搜索 按钮',
                    type: 'string',
                    enum: `搜索 | ''`,
                    defVal: '搜索',
                    emc: ''
                  },
                  {
                    keyName: 'resetBtnText',
                    desc: '是否显示 重置 按钮',
                    type: 'string',
                    enum: `重置 | ''`,
                    defVal: '重置',
                    emc: ''
                  },
                  {
                    keyName: 'moreBtnText',
                    desc: '是否显示 更多查询 按钮',
                    type: 'string',
                    enum: `更多查询 | ''`,
                    defVal: '更多查询',
                    emc: ''
                  }
                ]
              },
              {
                keyName: 'queryFormItemConfig',
                desc: '表单项配置: 具体配置请查阅各个渲染器配置 并 结合vxe-form的Props.items',
                type: '[{}]',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'formGloabalConfig',
                desc: '表单全局配置',
                type: 'Object',
                enum: '',
                defVal: ` { span: 4, align: 'left', size: 'medium', titleAlign: 'right', titleWidth: 0, titleColon: false, preventSubmit: false, loading: false} `,
                emc: '',
                children: [
                  {
                    keyName: 'span',
                    desc: '所有项的栅格占据的列数(共 24 分栏)',
                    type: 'String, Number',
                    enum: '',
                    defVal: '8',
                    emc: ''
                  },
                  {
                    keyName: 'align',
                    desc: '所有项的内容对齐方式',
                    type: 'String',
                    enum: '',
                    defVal: 'left',
                    emc: ''
                  },
                  {
                    keyName: 'size',
                    desc: '尺寸',
                    type: 'string',
                    enum: 'medium, small, mini',
                    defVal: 'medium',
                    emc: ''
                  },
                  {
                    keyName: 'titleAlign',
                    desc: '所有项的标题对齐方式',
                    type: 'string',
                    enum: '',
                    defVal: 'right',
                    emc: ''
                  },
                  {
                    keyName: 'titleWidth',
                    desc: '所有项的标题宽度',
                    type: 'String, Number',
                    enum: '',
                    defVal: '200',
                    emc: ''
                  },
                  {
                    keyName: 'titleColon',
                    desc: '是否显示标题冒号',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'preventSubmit',
                    desc: '是否禁用默认的回车提交方式,禁用后配合 validate() 方法可以更加自由的控制提交逻辑',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'loading',
                    desc: '是否加载中',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  }
                ]
              },
              {
                keyName: 'queryFormData',
                desc: '表单数据',
                type: 'Object',
                enum: '',
                defVal: '{}',
                emc: ''
              }
            ]
          },
          {
            keyName: 'Slots',
            desc: '插槽',
            type: '',
            enum: '',
            defVal: '',
            emc: ''
          },
          {
            keyName: 'Events',
            desc: '事件',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'itemChange',
                desc: '表单项改变时触发的事件',
                type: '',
                enum: '',
                defVal: '返回:obj, form',
                emc: ''
              },
              {
                keyName: 'onSearchClick',
                desc: '当点击搜索按钮时触发的事件',
                type: '',
                enum: '',
                defVal: '返回:queryFormData, obj, true',
                emc: ''
              },
              {
                keyName: 'onSearchResetClick',
                desc: '当点击重置按钮时触发的事件',
                type: '',
                enum: '',
                defVal: '返回:queryFormData',
                emc: ''
              }
            ]
          },
          {
            keyName: 'Methods',
            desc: '方法',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'queryFormOptionFn',
                desc: '返回bsform实例',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'getFormData',
                desc: '获取表单数据【是深拷贝后的】',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'onSearchClick',
                desc: '搜索',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'onSearchResetClick',
                desc: '重置',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'onMoreSearchClick',
                desc: '是否显示更多查询选项',
                type: 'boolean',
                enum: '',
                defVal: 'false',
                emc: ''
              }
            ]
          }
        ]
      }
    }
  }
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
Expand Copy