@elliemae/ds-tooltip 2.0.0-rc.6 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +20 -10
- package/types/v1/DSTooltip.d.ts +79 -16
- package/types/v2/DSTooltip.d.ts +62 -15
- package/types/v2/propTypes.d.ts +57 -14
- package/types/v3/propsTypes.d.ts +48 -17
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elliemae/ds-tooltip",
|
|
3
|
-
"version": "2.0.0
|
|
3
|
+
"version": "2.0.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "ICE MT - Dimsum - Tooltip",
|
|
6
6
|
"module": "./esm/index.js",
|
|
@@ -92,21 +92,31 @@
|
|
|
92
92
|
"build": "node ../../scripts/build/build.js"
|
|
93
93
|
},
|
|
94
94
|
"dependencies": {
|
|
95
|
-
"@elliemae/ds-
|
|
96
|
-
"@elliemae/ds-classnames": "2.0.0
|
|
97
|
-
"@elliemae/ds-popper": "2.0.0
|
|
98
|
-
"@elliemae/ds-popperjs": "2.0.0
|
|
99
|
-
"@elliemae/ds-portal": "2.0.0
|
|
100
|
-
"@elliemae/ds-
|
|
101
|
-
"@elliemae/ds-
|
|
102
|
-
"@elliemae/ds-
|
|
95
|
+
"@elliemae/ds-button": "2.0.0",
|
|
96
|
+
"@elliemae/ds-classnames": "2.0.0",
|
|
97
|
+
"@elliemae/ds-popper": "2.0.0",
|
|
98
|
+
"@elliemae/ds-popperjs": "2.0.0",
|
|
99
|
+
"@elliemae/ds-portal": "2.0.0",
|
|
100
|
+
"@elliemae/ds-props-helpers": "2.0.0",
|
|
101
|
+
"@elliemae/ds-shared": "2.0.0",
|
|
102
|
+
"@elliemae/ds-system": "2.0.0",
|
|
103
|
+
"@elliemae/ds-utilities": "2.0.0",
|
|
103
104
|
"@popperjs/core": "~2.9.2",
|
|
104
105
|
"react-desc": "~4.1.3",
|
|
105
106
|
"react-popper": "~2.2.5"
|
|
106
107
|
},
|
|
108
|
+
"devDependencies": {
|
|
109
|
+
"@testing-library/jest-dom": "~5.15.0",
|
|
110
|
+
"@testing-library/react": "~12.1.2",
|
|
111
|
+
"@testing-library/user-event": "~13.5.0",
|
|
112
|
+
"react": "^17.0.2",
|
|
113
|
+
"react-dom": "^17.0.2",
|
|
114
|
+
"styled-components": "~5.3.3"
|
|
115
|
+
},
|
|
107
116
|
"peerDependencies": {
|
|
108
117
|
"react": "^17.0.2",
|
|
109
|
-
"react-dom": "^17.0.2"
|
|
118
|
+
"react-dom": "^17.0.2",
|
|
119
|
+
"styled-components": "^5.3.3"
|
|
110
120
|
},
|
|
111
121
|
"publishConfig": {
|
|
112
122
|
"access": "public",
|
package/types/v1/DSTooltip.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/// <reference path="../../../../../shared/typings/react-desc.d.ts" />
|
|
1
2
|
import React from 'react';
|
|
2
3
|
declare const TooltipContainer: React.ForwardRefExoticComponent<React.RefAttributes<unknown>>;
|
|
3
4
|
declare const TooltipText: React.ForwardRefExoticComponent<React.RefAttributes<unknown>>;
|
|
@@ -21,23 +22,85 @@ declare const DSTooltip: {
|
|
|
21
22
|
zIndex: any;
|
|
22
23
|
}): JSX.Element;
|
|
23
24
|
propTypes: {
|
|
24
|
-
containerProps:
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
25
|
+
containerProps: {
|
|
26
|
+
defaultValue<T = unknown>(arg: T): {
|
|
27
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
28
|
+
};
|
|
29
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
30
|
+
};
|
|
31
|
+
placement: {
|
|
32
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
33
|
+
};
|
|
34
|
+
title: import("react-desc").PropTypesDescValidator;
|
|
35
|
+
delayClose: {
|
|
36
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
37
|
+
};
|
|
38
|
+
delayOpen: {
|
|
39
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
40
|
+
};
|
|
41
|
+
interactionType: {
|
|
42
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
43
|
+
};
|
|
44
|
+
triggerComponent: import("react-desc").PropTypesDescValidator;
|
|
45
|
+
isOpen: {
|
|
46
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
47
|
+
};
|
|
48
|
+
onOpen: {
|
|
49
|
+
defaultValue<T = unknown>(arg: T): {
|
|
50
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
51
|
+
};
|
|
52
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
53
|
+
};
|
|
54
|
+
springAnimationComponent: {
|
|
55
|
+
defaultValue<T = unknown>(arg: T): {
|
|
56
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
57
|
+
};
|
|
58
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
59
|
+
};
|
|
60
|
+
showArrow: {
|
|
61
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
62
|
+
};
|
|
63
|
+
className: {
|
|
64
|
+
defaultValue<T = unknown>(arg: T): {
|
|
65
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
66
|
+
};
|
|
67
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
68
|
+
};
|
|
69
|
+
tooltipType: {
|
|
70
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
71
|
+
};
|
|
72
|
+
zIndex: {
|
|
73
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
74
|
+
};
|
|
75
|
+
innerRef: {
|
|
76
|
+
defaultValue<T = unknown>(arg: T): {
|
|
77
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
78
|
+
};
|
|
79
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
80
|
+
};
|
|
39
81
|
};
|
|
40
82
|
};
|
|
41
|
-
declare const TooltipWithSchema:
|
|
83
|
+
declare const TooltipWithSchema: {
|
|
84
|
+
(props?: {
|
|
85
|
+
[x: string]: any;
|
|
86
|
+
containerProps?: {} | undefined;
|
|
87
|
+
innerRef: any;
|
|
88
|
+
placement?: string | undefined;
|
|
89
|
+
title?: string | undefined;
|
|
90
|
+
delayClose?: any;
|
|
91
|
+
delayOpen?: any;
|
|
92
|
+
interactionType?: string | undefined;
|
|
93
|
+
triggerComponent?: null | undefined;
|
|
94
|
+
className?: string | undefined;
|
|
95
|
+
isOpen?: undefined;
|
|
96
|
+
onOpen?: (() => null) | undefined;
|
|
97
|
+
springAnimationComponent?: undefined;
|
|
98
|
+
tooltipType?: string | undefined;
|
|
99
|
+
showArrow?: boolean | undefined;
|
|
100
|
+
zIndex: any;
|
|
101
|
+
} | undefined): JSX.Element;
|
|
102
|
+
propTypes: unknown;
|
|
103
|
+
toTypescript: () => import("react-desc").TypescriptSchema;
|
|
104
|
+
};
|
|
42
105
|
export { DSTooltip, TooltipContainer, TooltipText, TooltipWithSchema };
|
|
43
106
|
export default DSTooltip;
|
package/types/v2/DSTooltip.d.ts
CHANGED
|
@@ -1,23 +1,70 @@
|
|
|
1
|
+
/// <reference path="../../../../../shared/typings/react-desc.d.ts" />
|
|
1
2
|
import React from 'react';
|
|
2
3
|
import { DSTooltipT } from '.';
|
|
3
4
|
declare const DSTooltipV2: {
|
|
4
5
|
({ containerProps, innerRef, placement, title, delayClose, delayOpen, triggerComponent, className, getIsOpen, onOpen, tooltipType, showArrow, offset, zIndex, extraModifiers, }: DSTooltipT): React.ReactElement;
|
|
5
6
|
propTypes: {
|
|
6
|
-
containerProps:
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
7
|
+
containerProps: {
|
|
8
|
+
defaultValue<T = unknown>(arg: T): {
|
|
9
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
10
|
+
};
|
|
11
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
12
|
+
};
|
|
13
|
+
placement: {
|
|
14
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
15
|
+
};
|
|
16
|
+
title: import("react-desc").PropTypesDescValidator;
|
|
17
|
+
delayClose: {
|
|
18
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
19
|
+
};
|
|
20
|
+
delayOpen: {
|
|
21
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
22
|
+
};
|
|
23
|
+
triggerComponent: import("react-desc").PropTypesDescValidator;
|
|
24
|
+
getIsOpen: {
|
|
25
|
+
defaultValue<T = unknown>(arg: T): {
|
|
26
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
27
|
+
};
|
|
28
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
29
|
+
};
|
|
30
|
+
onOpen: {
|
|
31
|
+
defaultValue<T = unknown>(arg: T): {
|
|
32
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
33
|
+
};
|
|
34
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
35
|
+
};
|
|
36
|
+
showArrow: {
|
|
37
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
38
|
+
};
|
|
39
|
+
className: {
|
|
40
|
+
defaultValue<T = unknown>(arg: T): {
|
|
41
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
42
|
+
};
|
|
43
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
44
|
+
};
|
|
45
|
+
tooltipType: {
|
|
46
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
47
|
+
};
|
|
48
|
+
zIndex: {
|
|
49
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
50
|
+
};
|
|
51
|
+
innerRef: {
|
|
52
|
+
defaultValue<T = unknown>(arg: T): {
|
|
53
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
54
|
+
};
|
|
55
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
56
|
+
};
|
|
57
|
+
offset: {
|
|
58
|
+
defaultValue<T = unknown>(arg: T): {
|
|
59
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
60
|
+
};
|
|
61
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
62
|
+
};
|
|
20
63
|
};
|
|
21
64
|
};
|
|
22
|
-
declare const TooltipV2WithSchema:
|
|
65
|
+
declare const TooltipV2WithSchema: {
|
|
66
|
+
(props?: DSTooltipT | undefined): JSX.Element;
|
|
67
|
+
propTypes: unknown;
|
|
68
|
+
toTypescript: () => import("react-desc").TypescriptSchema;
|
|
69
|
+
};
|
|
23
70
|
export { DSTooltipV2, TooltipV2WithSchema };
|
package/types/v2/propTypes.d.ts
CHANGED
|
@@ -1,17 +1,60 @@
|
|
|
1
|
+
/// <reference path="../../../../../shared/typings/react-desc.d.ts" />
|
|
1
2
|
declare const tooltipV2Props: {
|
|
2
|
-
containerProps:
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
3
|
+
containerProps: {
|
|
4
|
+
defaultValue<T = unknown>(arg: T): {
|
|
5
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
6
|
+
};
|
|
7
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
8
|
+
};
|
|
9
|
+
placement: {
|
|
10
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
11
|
+
};
|
|
12
|
+
title: import("react-desc").PropTypesDescValidator;
|
|
13
|
+
delayClose: {
|
|
14
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
15
|
+
};
|
|
16
|
+
delayOpen: {
|
|
17
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
18
|
+
};
|
|
19
|
+
triggerComponent: import("react-desc").PropTypesDescValidator;
|
|
20
|
+
getIsOpen: {
|
|
21
|
+
defaultValue<T = unknown>(arg: T): {
|
|
22
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
23
|
+
};
|
|
24
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
25
|
+
};
|
|
26
|
+
onOpen: {
|
|
27
|
+
defaultValue<T = unknown>(arg: T): {
|
|
28
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
29
|
+
};
|
|
30
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
31
|
+
};
|
|
32
|
+
showArrow: {
|
|
33
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
34
|
+
};
|
|
35
|
+
className: {
|
|
36
|
+
defaultValue<T = unknown>(arg: T): {
|
|
37
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
38
|
+
};
|
|
39
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
40
|
+
};
|
|
41
|
+
tooltipType: {
|
|
42
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
43
|
+
};
|
|
44
|
+
zIndex: {
|
|
45
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
46
|
+
};
|
|
47
|
+
innerRef: {
|
|
48
|
+
defaultValue<T = unknown>(arg: T): {
|
|
49
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
50
|
+
};
|
|
51
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
52
|
+
};
|
|
53
|
+
offset: {
|
|
54
|
+
defaultValue<T = unknown>(arg: T): {
|
|
55
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
56
|
+
};
|
|
57
|
+
isRequired: import("react-desc").PropTypesDescValidator;
|
|
58
|
+
};
|
|
16
59
|
};
|
|
17
60
|
export { tooltipV2Props };
|
package/types/v3/propsTypes.d.ts
CHANGED
|
@@ -1,72 +1,103 @@
|
|
|
1
|
+
/// <reference path="../../../../../shared/typings/react-desc.d.ts" />
|
|
1
2
|
export declare const dsTooltipPropTypes: {
|
|
2
3
|
/**
|
|
3
4
|
* Tooltip text to be displayed on hover/focus
|
|
4
5
|
*/
|
|
5
|
-
text:
|
|
6
|
+
text: import("react-desc").PropTypesDescValidator;
|
|
6
7
|
/**
|
|
7
8
|
* Tooltip text alignment
|
|
8
9
|
*/
|
|
9
|
-
textAlign:
|
|
10
|
+
textAlign: {
|
|
11
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
12
|
+
};
|
|
10
13
|
/**
|
|
11
14
|
* Element to tie the tooltip to, must be a single node
|
|
12
15
|
*/
|
|
13
|
-
children:
|
|
16
|
+
children: import("react-desc").PropTypesDescValidator;
|
|
14
17
|
/**
|
|
15
18
|
* Wheter or not the tooltip content should appear in a DOM portal or not
|
|
16
19
|
*/
|
|
17
|
-
withoutPortal:
|
|
20
|
+
withoutPortal: {
|
|
21
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
22
|
+
};
|
|
18
23
|
/**
|
|
19
24
|
* Wheter or not the tooltip should use the arrow
|
|
20
25
|
*/
|
|
21
|
-
withoutArrow:
|
|
26
|
+
withoutArrow: {
|
|
27
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
28
|
+
};
|
|
22
29
|
/**
|
|
23
30
|
* Bounding element to calculate upon, defaults to it is "clippingParents",
|
|
24
31
|
* which are the scrolling containers that may cause the element to be partially or fully cut off.
|
|
25
32
|
*/
|
|
26
|
-
boundaryElement:
|
|
33
|
+
boundaryElement: {
|
|
34
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
35
|
+
};
|
|
27
36
|
/**
|
|
28
37
|
* Whether or not the popper context menu should be animated
|
|
29
38
|
*/
|
|
30
|
-
withoutAnimation:
|
|
39
|
+
withoutAnimation: {
|
|
40
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
41
|
+
};
|
|
31
42
|
/**
|
|
32
43
|
* Popper context menus Animation duration in ms
|
|
33
44
|
*/
|
|
34
|
-
animationDuration:
|
|
45
|
+
animationDuration: {
|
|
46
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
47
|
+
};
|
|
35
48
|
/**
|
|
36
49
|
* When using portal, the container in which to append the DOM content, defaults to document body
|
|
37
50
|
*/
|
|
38
|
-
portalDOMContainer:
|
|
51
|
+
portalDOMContainer: {
|
|
52
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
53
|
+
};
|
|
39
54
|
/**
|
|
40
55
|
* start placement preferences, as per popperjs placement option
|
|
41
56
|
*/
|
|
42
|
-
startPlacementPreference:
|
|
57
|
+
startPlacementPreference: {
|
|
58
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
59
|
+
};
|
|
43
60
|
/**
|
|
44
61
|
* Array of placement preferences, as per popperjs "flip" placement option
|
|
45
62
|
*/
|
|
46
|
-
placementOrderPreference:
|
|
63
|
+
placementOrderPreference: {
|
|
64
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
65
|
+
};
|
|
47
66
|
/**
|
|
48
67
|
* tooltip wrapper z-index
|
|
49
68
|
*/
|
|
50
|
-
zIndex:
|
|
69
|
+
zIndex: {
|
|
70
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
71
|
+
};
|
|
51
72
|
/**
|
|
52
73
|
* placement offset array
|
|
53
74
|
*/
|
|
54
|
-
customOffset:
|
|
75
|
+
customOffset: {
|
|
76
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
77
|
+
};
|
|
55
78
|
/**
|
|
56
79
|
* modifiers array for full-custom tooltip-js override
|
|
57
80
|
* https://tooltip.js.org/docs/v2/modifiers/
|
|
58
81
|
*/
|
|
59
|
-
modifiers:
|
|
82
|
+
modifiers: {
|
|
83
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
84
|
+
};
|
|
60
85
|
/**
|
|
61
86
|
* Optional id appended to data-testid
|
|
62
87
|
*/
|
|
63
|
-
id:
|
|
88
|
+
id: {
|
|
89
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
90
|
+
};
|
|
64
91
|
/**
|
|
65
92
|
* Optional callback to be invoked when the tooltip opens
|
|
66
93
|
*/
|
|
67
|
-
onOpen:
|
|
94
|
+
onOpen: {
|
|
95
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
96
|
+
};
|
|
68
97
|
/**
|
|
69
98
|
* 'Optional callback to be invoked when the tooltip closes
|
|
70
99
|
*/
|
|
71
|
-
onClose:
|
|
100
|
+
onClose: {
|
|
101
|
+
deprecated: import("react-desc").PropTypesDescValidator;
|
|
102
|
+
};
|
|
72
103
|
};
|