Skip to content

Commit 63e8747

Browse files
sendyasendya
authored
fix: slider, time-picker typo (#2726)
1 parent 941ebc2 commit 63e8747

File tree

2 files changed

+331
-260
lines changed

2 files changed

+331
-260
lines changed

‎types/slider.d.ts

+129-100
Original file line numberDiff line numberDiff line change
@@ -3,108 +3,137 @@
33
// Definitions: https://github.com/vueComponent/ant-design-vue/types
44

55
import { AntdComponent } from './component';
6-
import { VNode } from 'vue';
6+
import { VNodeChild } from 'vue';
77

88
export declare class Slider extends AntdComponent {
9-
/**
10-
* get focus when component mounted
11-
* @default false
12-
* @type boolean
13-
*/
14-
autofocus: boolean;
15-
16-
/**
17-
* The default value of slider. When range is false, use number, otherwise, use [number, number]
18-
* @default 0 | [0, 0]
19-
* @type number | number[]
20-
*/
21-
defaultValue: number | number[];
22-
23-
/**
24-
* If true, the slider will not be interactable.
25-
* @default false
26-
* @type boolean
27-
*/
28-
disabled: boolean;
29-
30-
/**
31-
* Whether the thumb can drag over tick only.
32-
* @default false
33-
* @type boolean
34-
*/
35-
dots: boolean;
36-
37-
/**
38-
* Make effect when marks not null，true means containment and false means coordinative
39-
* @default true
40-
* @type boolean
41-
*/
42-
included: boolean;
43-
44-
/**
45-
* Tick mark of Slider, type of key must be number, and must in closed interval [min, max] ，each mark can declare its own style.
46-
* @default { number: string|VNode } | { number: { style: object, label: string|VNode } } | { number: () => VNode }
47-
* @type object
48-
*/
49-
marks: {
50-
[key: number]: string | VNode | { style: object; label: string | VNode } | Function;
51-
};
52-
53-
/**
54-
* The maximum value the slider can slide to
55-
* @default 100
56-
* @type number
57-
*/
58-
max: number;
59-
60-
/**
61-
* The minimum value the slider can slide to.
62-
* @default 0
63-
* @type number
64-
*/
65-
min: number;
66-
67-
/**
68-
* dual thumb mode
69-
* @default false
70-
* @type boolean
71-
*/
72-
range: boolean;
73-
74-
/**
75-
* The granularity the slider can step through values.
76-
* Must greater than 0, and be divided by (max - min) . When marks no null, step can be null.
77-
* @default 1
78-
* @type number | null
79-
*/
80-
step: number | null;
81-
82-
/**
83-
* Slider will pass its value to tipFormatter, and display its value in Tooltip, and hide Tooltip when return value is null.
84-
* @default IDENTITY
85-
* @type Function | null
86-
*/
87-
tipFormatter: Function | null;
88-
89-
/**
90-
* The value of slider. When range is false, use number, otherwise, use [number, number]
91-
* @type number | number[]
92-
*/
93-
value: number | number[];
94-
95-
/**
96-
* If true, the slider will be vertical.
97-
* @default false
98-
* @type boolean
99-
*/
100-
vertical: boolean;
101-
102-
/**
103-
* If true, Tooltip will show always, or it will not show anyway, even if dragging or hovering.
104-
* @default false
105-
* @type boolean
106-
*/
107-
tooltipVisible: boolean;
9+
$props: {
10+
/**
11+
* get focus when component mounted
12+
* @default false
13+
* @type boolean
14+
*/
15+
autofocus?: boolean;
16+
17+
/**
18+
* The default value of slider. When range is false, use number, otherwise, use [number, number]
19+
* @default 0 | [0, 0]
20+
* @type number | number[]
21+
*/
22+
defaultValue?: number | number[];
23+
24+
/**
25+
* If true, the slider will not be interactable.
26+
* @default false
27+
* @type boolean
28+
*/
29+
disabled?: boolean;
30+
31+
/**
32+
* Whether the thumb can drag over tick only.
33+
* @default false
34+
* @type boolean
35+
*/
36+
dots?: boolean;
37+
38+
/**
39+
* Make effect when marks not null，true means containment and false means coordinative
40+
* @default true
41+
* @type boolean
42+
*/
43+
included?: boolean;
44+
45+
/**
46+
* Tick mark of Slider, type of key must be number, and must in closed interval [min, max] ，each mark can declare its own style.
47+
* @default { number: string|VNode } | { number: { style: object, label: string|VNode } } | { number: () => VNode }
48+
* @type object
49+
*/
50+
marks?: {
51+
[key: number]: string
52+
| VNodeChild
53+
| { style: object; label: string | VNodeChild }
54+
| Function;
55+
};
56+
57+
/**
58+
* The maximum value the slider can slide to
59+
* @default 100
60+
* @type number
61+
*/
62+
max?: number;
63+
64+
/**
65+
* The minimum value the slider can slide to.
66+
* @default 0
67+
* @type number
68+
*/
69+
min?: number;
70+
71+
/**
72+
* dual thumb mode
73+
* @default false
74+
* @type boolean
75+
*/
76+
range?: boolean;
77+
78+
/**
79+
* The granularity the slider can step through values.
80+
* Must greater than 0, and be divided by (max - min) . When marks no null, step can be null.
81+
* @default 1
82+
* @type number | null
83+
*/
84+
step?: number | null;
85+
86+
/**
87+
* Slider will pass its value to tipFormatter, and display its value in Tooltip, and hide Tooltip when return value is null.
88+
* @default IDENTITY
89+
* @type Function | null
90+
*/
91+
tipFormatter?: Function | null;
92+
93+
/**
94+
* The value of slider. When range is false, use number, otherwise, use [number, number]
95+
* @type number | number[]
96+
*/
97+
value?: number | number[];
98+
99+
/**
100+
* If true, the slider will be vertical.
101+
* @default false
102+
* @type boolean
103+
*/
104+
vertical?: boolean;
105+
106+
/**
107+
* If true, Tooltip will show always, or it will not show anyway, even if dragging or hovering.
108+
* @default false
109+
* @type boolean
110+
*/
111+
tooltipVisible?: boolean;
112+
113+
/**
114+
* Set Tooltip display position. Ref Tooltip
115+
* @see https://antdv.com/components/tooltip/
116+
*/
117+
tooltipPlacement?: string;
118+
119+
/**
120+
* The DOM container of the Tooltip,
121+
* the default behavior is to create a div element in body.
122+
*/
123+
getTooltipPopupContainer?: Function;
124+
125+
/**
126+
* Fire when mouseup is fired.
127+
* @param value
128+
*/
129+
onAfterChange?: (value?: any) => void;
130+
131+
/**
132+
* Callback function that is fired when the user changes the slider's value.
133+
* @param value
134+
*/
135+
onChange?: (value?: any) => void;
136+
}
108137

109138
/**
110139
* remove focus

0 commit comments

Comments
 (0)