@@ -643,29 +643,29 @@ export default Demo6
643643
644644## Props
645645
646- | 参数 | 说明 | 类型 | 默认值 |
647- | -------------- | ------------------------------------------------------ | ----------------------------------------------- | -- ---- |
648- | columns | 与` uiw table ` columns用法一致 必传, 如果需要表单,也在此增加` props ` | FormCol[ ] | [ ] |
646+ | 参数 | 说明 | 类型 | 默认值 |
647+ | ---- | ---- | ---- | ---- |
648+ | columns | 与` uiw table ` columns用法一致 必传, 如果需要表单,也在此增加` props ` | ` FormCol[] ` | [ ] |
649649| operateButtons | 操作栏按钮集合,属性与uiw button一致并支持自定义render | ` Array<ButtonProps & { render?: JSX.Element }> ` | [ ] |
650- | searchBtns | 搜索栏按钮集合,属性与uiw button一致并支持自定义render | ` Array<ButtonProps & { render?: JSX.Element }> ` | [ ] |
651- | table | useTable返回值 | Object 必传 | |
652- | onPageChange | 分页回调 | ( page: number) => void | - |
653- | onBeforeSearch | 查询table前表单回调,可用于表单验证,返回true 继续查询 | ({initial, current}) => Boolean | |
654- | rowSelection | 选择框配置 | RowSelection | - |
655- | scroll | 设置横向滚动 | ScrollProps | - |
656- | paginationProps| 分页属性 | 继承自[ uiw Pagination] ( https://uiwjs.github.io/#/components/pagination ) | - |
657- | formCol | 网格中表单一行列数 | number | 5 |
658- | tableBackgroundColor | 网格中表格的背景色 | React.CSSProperties[ 'backgroundColor'] | - |
659- | tableHeadHidden | 网格中表头是否显示 | boolean | false |
650+ | searchBtns | 搜索栏按钮集合,属性与uiw button一致并支持自定义render | ` Array<ButtonProps & { render?: JSX.Element }> ` | [ ] |
651+ | table | 必传。 useTable返回值 | ` object ` | - |
652+ | onPageChange | 分页回调 | ` ( page: number) => void` | - |
653+ | onBeforeSearch | 查询table前表单回调,可用于表单验证,返回true 继续查询 | ` ({initial, current}) => Boolean ` | - |
654+ | rowSelection | 选择框配置 | ` RowSelection ` | - |
655+ | scroll | 设置横向滚动 | ` ScrollProps ` | - |
656+ | paginationProps| 分页属性 | 继承自[ uiw Pagination] ( https://uiwjs.github.io/#/components/pagination ) | - |
657+ | formCol | 网格中表单一行列数 | ` number ` | ` 5 ` |
658+ | tableBackgroundColor | 网格中表格的背景色 | ` React.CSSProperties['backgroundColor'] ` | - |
659+ | tableHeadHidden | 网格中表头是否显示 | ` boolean ` | ` false ` |
660660
661661更多属性文档请参考 [ uiw/Table] ( https://uiwjs.github.io/#/components/table )
662662
663663### searchBtns
664664
665665| 参数 | 说明 | 类型 | 默认值 |
666666| --------------- | ---------------------------------------- | -------- | ------ |
667- | label | 按钮标题 | string | - |
668- | render | 不使用button,自定义组件 | React Component | - |
667+ | label | 按钮标题 | ` string ` | - |
668+ | render | 不使用button,自定义组件 | ` React Component ` | - |
669669
670670更多属性文档请参考 [ uiw button] ( https://uiwjs.github.io/#/components/button )
671671
@@ -677,9 +677,9 @@ export default Demo6
677677
678678| 参数 | 说明 | 类型 | 默认值 |
679679| --------------- | ---------------------------------------- | -------- | ------ |
680- | checkbox | 选择框类型 | checkbox | radio | checkbox |
681- | selectKey | 选择框的键名,必填,对应的column里的key。 | String | - |
682- | defaultSelected | 选中默认值 | [ ] | - |
680+ | checkbox | 选择框类型 | ` checkbox \ | radio ` | ` checkbox ` |
681+ | selectKey | 选择框的键名,必填,对应的column里的key。 | ` string ` | - |
682+ | defaultSelected | 选中默认值 | ` string[] ` | - |
683683
684684### ScrollProps
685685
@@ -693,13 +693,13 @@ export default Demo6
693693
694694配置搜索表单
695695
696- | 参数 | 说明 | 类型 | 默认值 |
697- | ----------- | ------------------------------------- | --------------------------------------------------------------- | --- --- |
698- | widget | 表单组件 | 支持例子中的组件, 组件名与uiw表单组件名字一致,只是首字母小写了 | - |
699- | widgetProps | 组件属性 | 与uiw对应的组件属性一致 | - |
700- | label | 表单标题,如果不填则继承columns title | String | - |
701- | key | 表单name,如果不填则继承columns key | String | - |
702- | option | 组件 是` checkbox ` 、` select ` 、` searchSelect ` 、` searchTree ` 使用, 数据源统一叫option | Array | - |
696+ | 参数 | 说明 | 类型 | 默认值 |
697+ | --- | --- | --- | --- |
698+ | widget | 表单组件 | 支持例子中的组件, 组件名与uiw表单组件名字一致,只是首字母小写了 | - |
699+ | widgetProps | 组件属性 | 与uiw对应的组件属性一致 | - |
700+ | label | 表单标题,如果不填则继承columns title | ` string ` | - |
701+ | key | 表单name,如果不填则继承columns key | ` string ` | - |
702+ | option | 组件 是` checkbox ` 、` select ` 、` searchSelect ` 、` searchTree ` 使用, 数据源统一叫option | ` array ` | - |
703703
704704当前支持的widget组件有
705705
@@ -722,7 +722,7 @@ dateInputRange
722722 props可以是个对象属性值是以上参数,也可以是个数组方便处理筛选条件大于列表展示的情况
723723
724724``` js
725- <!-- 对象 -->
725+ // 对象
726726props: {
727727 widget: ' input' ,
728728 initialValue: ' zzz' ,
@@ -732,7 +732,7 @@ props: {
732732 }
733733}
734734
735- <!-- 数组 -->
735+ // 数组
736736props: [
737737 {
738738 widget: ' input' ,
@@ -751,9 +751,9 @@ props: [
751751
752752| 参数 | 说明 | 类型 | 默认值 |
753753| ------- | ------------ | ------ | ------ |
754- | pageSizeOptions | 指定每页可以显示多少条 | Number [ ] | {} |
755- | pageSize | 每页条数 | Number | 10 |
756- | onShowSizeChange | pageSize 变化的回调 | Function (current, pageSize) | - |
754+ | pageSizeOptions | 指定每页可以显示多少条 | ` number[] ` | - |
755+ | pageSize | 每页条数 | ` number ` | ` 10 ` |
756+ | onShowSizeChange | pageSize 变化的回调 | ` (current, pageSize) => void ` | - |
757757
758758更多属性文档请参考 [ uiw Pagination] ( https://uiwjs.github.io/#/components/pagination )
759759
@@ -763,48 +763,48 @@ props: [
763763
764764| 参数 | 说明 | 类型 | 默认值 |
765765| ------- | ------------ | ------ | ------ |
766- | api | 接口请求地址 | string | - |
767- | options | 配置集合 | object | {} |
766+ | api | 接口请求地址 | ` string ` | - |
767+ | options | 配置集合 | ` object ` | {} |
768768
769769### options
770770
771- | 参数 | 说明 | 类型 | 默认值 |
772- | ---------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ----------------------- --- |
773- | formatData | 格式化接口返回的数据,必须返回{total: 总数, data: 列表数据}的格式 | (data) => {total: 10, data: [ ] } | - |
774- | query | 格式化请求参数, 会接收到pageIndex 当前页 searchValues 表单数据 | (pageIndex: number, searchValues: any) => {page: pageIndex, pageSize: 10, searchValues} | {} |
775- | SWRConfiguration | swr配置 | SWRConfiguration | {revalidateOnFocus: false } |
776- | requestOptions | request参数,继承自[ axios config ] ( https://axios-http.com/docs/req_config ) | object | {} |
771+ | 参数 | 说明 | 类型 | 默认值 |
772+ | --- | --- | --- | --- |
773+ | formatData | 格式化接口返回的数据,必须返回{total: 总数, data: 列表数据}的格式 | (data) => {total: 10, data: [ ] } | - |
774+ | mutationOptions | [ useReactMutation ] ( https://uiwjs.github.io/uiw-admin/#/docs/request ) 配置 | ReactMutationOptions | - |
775+ | query | 格式化请求参数, 会接收到pageIndex 当前页 searchValues 表单数据 | (pageIndex: number, searchValues: any) => {page: pageIndex, pageSize: 10, searchValues} | {} |
776+ | requestOptions | request参数,继承自` fetch ` | object | {} |
777777
778778### response
779779
780780| 参数 | 说明 | 类型 | 默认值 |
781781| ------------ | ------------ | ------------- | ------ |
782- | data | 接口请求数据 | Array | - |
783- | total | 数据总数 | Number | - |
784- | searchValues | 表单值 | Object | - |
785- | selection | 选择框属性 | UseSelections | - |
786- | pageIndex | 当前分页 | Number | 1 |
787- | onRefersh | 刷新分页数据 | () => void | - |
788- | onReset | 重置表单,查询数据 | () => void | - |
789- | onSearch | 查询数据 | () => void | - |
790- | form | 返回搜索表单form实例各种内部函数,可用于主动触发事件, 与[ Uiw Form] ( https://uiwjs.github.io/#/components/form ) ref 属性返回的一致 | Ref | - |
782+ | data | 接口请求数据 | ` any[] ` | - |
783+ | total | 数据总数 | ` number ` | - |
784+ | searchValues | 表单值 | ` object ` | - |
785+ | selection | 选择框属性 | ` UseSelections ` | - |
786+ | pageIndex | 当前分页 | ` number ` | ` 1 ` |
787+ | onRefersh | 刷新分页数据 | ` () => void ` | - |
788+ | onReset | 重置表单,查询数据 | ` () => void ` | - |
789+ | onSearch | 查询数据 | ` () => void ` | - |
790+ | form | 返回搜索表单form实例各种内部函数,可用于主动触发事件, 与[ Uiw Form] ( https://uiwjs.github.io/#/components/form ) ref 属性返回的一致 | ` Ref ` | - |
791791
792792### selection
793793
794794| 参数 | 说明 | 类型 | 默认值 |
795795| ----------------- | ------------------ | --------------------- | ------ |
796- | selected | 已经选择的元素 | array | - |
797- | allSelected | 是否全选 | boolean | - |
798- | noneSelected | 是否一个都没有选择 | boolean | - |
799- | partiallySelected | 是否半选 | boolean | - |
800- | isSelected | 是否被选择 | (value: T) => boolean | - |
801- | setSelected | 设置选择的元素 | (value: T[ ] ) => void | - |
802- | select | 选择元素 | (value: T) => void | - |
803- | unSelect | 取消选择元素 | (value: T) => void | - |
804- | toggle | 反选元素 | (value: T) => void | - |
805- | selectAll | 选择全部元素 | () => void | - |
806- | unSelectAll | 取消选择全部元素 | () => void | - |
807- | toggleAll | 反选全部元素 | () => void | - |
796+ | selected | 已经选择的元素 | ` array ` | - |
797+ | allSelected | 是否全选 | ` boolean ` | - |
798+ | noneSelected | 是否一个都没有选择 | ` boolean ` | - |
799+ | partiallySelected | 是否半选 | boolean | - |
800+ | isSelected | 是否被选择 | ` (value: T) => boolean ` | - |
801+ | setSelected | 设置选择的元素 | ` (value: T[]) => void ` | - |
802+ | select | 选择元素 | ` (value: T) => void ` | - |
803+ | unSelect | 取消选择元素 | ` (value: T) => void ` | - |
804+ | toggle | 反选元素 | ` (value: T) => void ` | - |
805+ | selectAll | 选择全部元素 | ` () => void ` | - |
806+ | unSelectAll | 取消选择全部元素 | ` () => void ` | - |
807+ | toggleAll | 反选全部元素 | ` () => void ` | - |
808808
809809## 贡献者
810810
0 commit comments