Skip to content

Commit c75582b

Browse files
author
binhaoCen
authored
chror : Fix types popconfirm , page-header ... (#2692)
* chore: update type popconfirm * chore: update type page-header * chore: update type popover * chore: update type progress * chore: update type radio * chore: update type rate * chore: update type row * fix: remove string type * chore: update type Select * fix:add $props * chore: update type spin * chore: update type statistic * chore: update type step * fix : add $props * fix:popconfirm add $props * fix: page-header types * fix: add onChange * fix : select type * fix: add type * fix: defined PaginationRenderProps
1 parent 79bb979 commit c75582b

18 files changed

+901
-827
lines changed

‎types/grid/row.d.ts

+28-26
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,40 @@ import { AntdComponent } from '../component';
77
type Gutter =
88
| number
99
| {
10-
xs: number;
11-
sm: number;
12-
md: number;
13-
lg: number;
14-
xl: number;
15-
xxl: number;
16-
};
10+
xs: number;
11+
sm: number;
12+
md: number;
13+
lg: number;
14+
xl: number;
15+
xxl: number;
16+
};
1717
export declare class Row extends AntdComponent {
18-
/**
18+
$props: {
19+
/**
1920
* spacing between grids, could be a number or a object like { xs: 8, sm: 16, md: 24}
2021
* @default 0
2122
* @type numner | object
2223
*/
23-
gutter: Gutter | [Gutter, Gutter];
24+
gutter?: Gutter | [Gutter, Gutter];
2425

25-
/**
26-
* layout mode, optional flex
27-
* @type string
28-
*/
29-
type: string;
26+
/**
27+
* layout mode, optional flex
28+
* @type string
29+
*/
30+
type?: string;
3031

31-
/**
32-
* the vertical alignment of the flex layout: top middle bottom
33-
* @default 'top'
34-
* @type string
35-
*/
36-
align: 'top' | 'middle' | 'bottom';
32+
/**
33+
* the vertical alignment of the flex layout: top middle bottom
34+
* @default 'top'
35+
* @type string
36+
*/
37+
align?: 'top' | 'middle' | 'bottom';
3738

38-
/**
39-
* horizontal arrangement of the flex layout: start end center space-around space-between
40-
* @default 'start'
41-
* @type string
42-
*/
43-
justify: 'start' | 'end' | 'center' | 'space-around' | 'space-between';
39+
/**
40+
* horizontal arrangement of the flex layout: start end center space-around space-between
41+
* @default 'start'
42+
* @type string
43+
*/
44+
justify?: 'start' | 'end' | 'center' | 'space-around' | 'space-between';
45+
}
4446
}

‎types/page-header.d.ts

+67-53
Original file line numberDiff line numberDiff line change
@@ -3,59 +3,73 @@
33
// Definitions: https://github.com/vueComponent/ant-design-vue/types
44

55
import { AntdComponent } from './component';
6+
import { VNodeChild } from 'vue';
67

78
export declare class PageHeader extends AntdComponent {
8-
/**
9-
* Custom backIcon
10-
* @default <ArrowLeftOutlined />
11-
* @type any (string | slot)
12-
*/
13-
backIcon: any;
14-
15-
/**
16-
* Custom prefixCls
17-
* @type string
18-
*/
19-
prefixCls: string;
20-
21-
/**
22-
* Custom title
23-
* @type any (string | slot)
24-
*/
25-
title: any;
26-
27-
/**
28-
* Custom subTitle
29-
* @type any (string | slot)
30-
*/
31-
subTitle: any;
32-
33-
breadcrumb: object;
34-
35-
/**
36-
* Custom tags
37-
* @type any (string | slot)
38-
*/
39-
tags: any;
40-
41-
/**
42-
* Custom footer
43-
* @type any (string | slot)
44-
*/
45-
footer: any;
46-
47-
/**
48-
* Custom extra
49-
* @type any (string | slot)
50-
*/
51-
extra: any;
52-
53-
avatar: object;
54-
55-
ghost: boolean;
56-
57-
/**
58-
* Specify a callback that will be called when a user clicks backIcon.
59-
*/
60-
back(): void;
9+
$props: {
10+
/**
11+
* Custom backIcon
12+
* @default <ArrowLeftOutlined />
13+
* @type any (string | slot)
14+
*/
15+
backIcon?: VNodeChild | JSX.Element;
16+
17+
/**
18+
* Custom prefixCls
19+
* @type string
20+
*/
21+
prefixCls?: string;
22+
23+
/**
24+
* Custom title
25+
* @type any (string | slot)
26+
*/
27+
title?: VNodeChild | JSX.Element;
28+
29+
/**
30+
* Custom subTitle
31+
* @type any (string | slot)
32+
*/
33+
subTitle?: VNodeChild | JSX.Element;
34+
/**
35+
* Breadcrumb configuration
36+
* @type breadcrumb
37+
*/
38+
breadcrumb?: object;
39+
40+
/**
41+
* Tag list next to title
42+
* @type any (string | slot)
43+
*/
44+
tags?: VNodeChild | JSX.Element;
45+
46+
/**
47+
* PageHeader's footer, generally used to render TabBar
48+
* @type any (string | slot)
49+
*/
50+
footer?: VNodeChild | JSX.Element;
51+
52+
/**
53+
* Operating area, at the end of the line of the title line
54+
* @type any (string | slot)
55+
*/
56+
extra?: VNodeChild | JSX.Element;
57+
/**
58+
* Avatar next to the title bar
59+
* @type Avatar
60+
*/
61+
avatar?: object;
62+
/**
63+
* PageHeader type, will change background color
64+
* @default true
65+
* @type boolean
66+
*/
67+
ghost?: boolean;
68+
69+
/**
70+
* Specify a callback that will be called when a user clicks backIcon.
71+
*/
72+
onBack(): () => void;
73+
}
74+
6175
}

‎types/pagination.d.ts

+81-75
Original file line numberDiff line numberDiff line change
@@ -3,92 +3,98 @@
33
// Definitions: https://github.com/vueComponent/ant-design-vue/types
44

55
import { AntdComponent } from './component';
6-
import { VNode } from 'vue';
7-
6+
import { VNodeChild } from 'vue';
7+
interface PaginationRenderProps {
8+
page: number
9+
type: 'page' | 'prev' | 'next'
10+
originalElement: any
11+
}
812
export declare class Pagination extends AntdComponent {
9-
/**
10-
* total number of data items
11-
* @default 0
12-
* @type number
13-
*/
14-
total?: number;
13+
$props: {
14+
/**
15+
* total number of data items
16+
* @default 0
17+
* @type number
18+
*/
19+
total?: number;
1520

16-
/**
17-
* default initial page number
18-
* @default 1
19-
* @type number
20-
*/
21-
defaultCurrent?: number;
21+
/**
22+
* default initial page number
23+
* @default 1
24+
* @type number
25+
*/
26+
defaultCurrent?: number;
2227

23-
/**
24-
* current page number
25-
* @type number
26-
*/
27-
current?: number;
28+
/**
29+
* current page number
30+
* @type number
31+
*/
32+
current?: number;
2833

29-
/**
30-
* default number of data items per page
31-
* @default 10
32-
* @type number
33-
*/
34-
defaultPageSize?: number;
34+
/**
35+
* default number of data items per page
36+
* @default 10
37+
* @type number
38+
*/
39+
defaultPageSize?: number;
3540

36-
/**
37-
* number of data items per page
38-
* @type number
39-
*/
40-
pageSize?: number;
41+
/**
42+
* number of data items per page
43+
* @type number
44+
*/
45+
pageSize?: number;
4146

42-
/**
43-
* Whether to hide pager on single page
44-
* @default false
45-
* @type boolean
46-
*/
47-
hideOnSinglePage?: boolean;
47+
/**
48+
* Whether to hide pager on single page
49+
* @default false
50+
* @type boolean
51+
*/
52+
hideOnSinglePage?: boolean;
4853

49-
/**
50-
* determine whether pageSize can be changed
51-
* @default false
52-
* @type boolean
53-
*/
54-
showSizeChanger?: boolean;
54+
/**
55+
* determine whether pageSize can be changed
56+
* @default false
57+
* @type boolean
58+
*/
59+
showSizeChanger?: boolean;
5560

56-
/**
57-
* specify the sizeChanger options
58-
* @default ['10', '20', '30', '40']
59-
* @type string[]
60-
*/
61-
pageSizeOptions?: string[];
61+
/**
62+
* specify the sizeChanger options
63+
* @default ['10', '20', '30', '40']
64+
* @type string[]
65+
*/
66+
pageSizeOptions?: string[];
6267

63-
/**
64-
* determine whether you can jump to pages directly
65-
* @default false
66-
* @type boolean
67-
*/
68-
showQuickJumper?: boolean | object;
68+
/**
69+
* determine whether you can jump to pages directly
70+
* @default false
71+
* @type boolean
72+
*/
73+
showQuickJumper?: boolean | object;
6974

70-
/**
71-
* to display the total number and range
72-
* @type Function
73-
*/
74-
showTotal?: (total: number, range: [number, number]) => any;
75+
/**
76+
* to display the total number and range
77+
* @type Function
78+
*/
79+
showTotal?: (total: number, range: [number, number]) => any;
7580

76-
/**
77-
* specify the size of Pagination, can be set to small
78-
* @default ''
79-
* @type string
80-
*/
81-
size?: string;
81+
/**
82+
* specify the size of Pagination, can be set to small
83+
* @default ''
84+
* @type string
85+
*/
86+
size?: string;
8287

83-
/**
84-
* whether to use simple mode
85-
* @type boolean
86-
*/
87-
simple?: boolean;
88+
/**
89+
* whether to use simple mode
90+
* @type boolean
91+
*/
92+
simple?: boolean;
8893

89-
/**
90-
* to customize item innerHTML
91-
* @type Function
92-
*/
93-
itemRender?: (page: number, type: 'page' | 'prev' | 'next', originalElement: any) => VNode;
94+
/**
95+
* to customize item innerHTML
96+
* @type Function
97+
*/
98+
itemRender?: (props:PaginationRenderProps) => VNodeChild | JSX.Element;
99+
}
94100
}

0 commit comments

Comments
 (0)