@fluentui/react-tooltip 0.0.0-nightlyd3bf09bf8120211201.1 → 0.0.0-nightlye1926bfeca20220204.1
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.json +111 -25
- package/CHANGELOG.md +24 -14
- package/dist/react-tooltip.d.ts +27 -46
- package/lib/components/Tooltip/Tooltip.d.ts +3 -2
- package/lib/components/Tooltip/Tooltip.js +9 -9
- package/lib/components/Tooltip/Tooltip.js.map +1 -1
- package/lib/components/Tooltip/Tooltip.types.d.ts +20 -37
- package/lib/components/Tooltip/private/constants.d.ts +12 -0
- package/lib/components/Tooltip/private/constants.js +14 -0
- package/lib/components/Tooltip/private/constants.js.map +1 -0
- package/lib/components/Tooltip/renderTooltip.d.ts +1 -1
- package/lib/components/Tooltip/renderTooltip.js +5 -4
- package/lib/components/Tooltip/renderTooltip.js.map +1 -1
- package/lib/components/Tooltip/useTooltip.d.ts +3 -6
- package/lib/components/Tooltip/useTooltip.js +45 -57
- package/lib/components/Tooltip/useTooltip.js.map +1 -1
- package/lib/components/Tooltip/useTooltipStyles.d.ts +1 -1
- package/lib/components/Tooltip/useTooltipStyles.js +38 -25
- package/lib/components/Tooltip/useTooltipStyles.js.map +1 -1
- package/lib-commonjs/components/Tooltip/Tooltip.d.ts +3 -2
- package/lib-commonjs/components/Tooltip/Tooltip.js +8 -7
- package/lib-commonjs/components/Tooltip/Tooltip.js.map +1 -1
- package/lib-commonjs/components/Tooltip/Tooltip.types.d.ts +20 -37
- package/lib-commonjs/components/Tooltip/private/constants.d.ts +12 -0
- package/lib-commonjs/components/Tooltip/private/constants.js +21 -0
- package/lib-commonjs/components/Tooltip/private/constants.js.map +1 -0
- package/lib-commonjs/components/Tooltip/renderTooltip.d.ts +1 -1
- package/lib-commonjs/components/Tooltip/renderTooltip.js +7 -6
- package/lib-commonjs/components/Tooltip/renderTooltip.js.map +1 -1
- package/lib-commonjs/components/Tooltip/useTooltip.d.ts +3 -6
- package/lib-commonjs/components/Tooltip/useTooltip.js +50 -61
- package/lib-commonjs/components/Tooltip/useTooltip.js.map +1 -1
- package/lib-commonjs/components/Tooltip/useTooltipStyles.d.ts +1 -1
- package/lib-commonjs/components/Tooltip/useTooltipStyles.js +43 -28
- package/lib-commonjs/components/Tooltip/useTooltipStyles.js.map +1 -1
- package/package.json +12 -13
- package/lib/common/isConformant.d.ts +0 -4
- package/lib/common/isConformant.js +0 -11
- package/lib/common/isConformant.js.map +0 -1
- package/lib-commonjs/common/isConformant.d.ts +0 -4
- package/lib-commonjs/common/isConformant.js +0 -22
- package/lib-commonjs/common/isConformant.js.map +0 -1
package/CHANGELOG.json
CHANGED
@@ -2,17 +2,35 @@
|
|
2
2
|
"name": "@fluentui/react-tooltip",
|
3
3
|
"entries": [
|
4
4
|
{
|
5
|
-
"date": "
|
6
|
-
"tag": "@fluentui/react-tooltip_v0.0.0-
|
7
|
-
"version": "0.0.0-
|
5
|
+
"date": "Fri, 04 Feb 2022 04:13:21 GMT",
|
6
|
+
"tag": "@fluentui/react-tooltip_v0.0.0-nightlye1926bfeca20220204.1",
|
7
|
+
"version": "0.0.0-nightlye1926bfeca20220204.1",
|
8
8
|
"comments": {
|
9
9
|
"prerelease": [
|
10
10
|
{
|
11
11
|
"author": "email not defined",
|
12
12
|
"package": "@fluentui/react-tooltip",
|
13
|
-
"commit": "
|
13
|
+
"commit": "448766390ca759acf60ffccef08e4c3ffe41f4f6",
|
14
14
|
"comment": "Release nightly v9"
|
15
15
|
},
|
16
|
+
{
|
17
|
+
"author": "behowell@microsoft.com",
|
18
|
+
"package": "@fluentui/react-tooltip",
|
19
|
+
"commit": "caaf3307f864b04369c13fe69d7dc8fe7ab84735",
|
20
|
+
"comment": "Move arrowHeight and tooltipBorderRadius into a shared constants.ts file"
|
21
|
+
},
|
22
|
+
{
|
23
|
+
"author": "behowell@microsoft.com",
|
24
|
+
"package": "@fluentui/react-tooltip",
|
25
|
+
"commit": "2aacc839785a2f96d84a959aea207dfdb99116f8",
|
26
|
+
"comment": "Prevent Tooltip from overriding any aria-label, etc. props on its child"
|
27
|
+
},
|
28
|
+
{
|
29
|
+
"author": "Humberto.Morimoto@microsoft.com",
|
30
|
+
"package": "@fluentui/react-tooltip",
|
31
|
+
"commit": "9204703d0a42ee34a20ae4cf28952e13872647ba",
|
32
|
+
"comment": "Replacing use of functions in makeStyles with direct use of tokens."
|
33
|
+
},
|
16
34
|
{
|
17
35
|
"author": "olfedias@microsoft.com",
|
18
36
|
"package": "@fluentui/react-tooltip",
|
@@ -20,58 +38,126 @@
|
|
20
38
|
"comment": "update styles to not use CSS shorthands"
|
21
39
|
},
|
22
40
|
{
|
23
|
-
"author": "
|
41
|
+
"author": "behowell@microsoft.com",
|
24
42
|
"package": "@fluentui/react-tooltip",
|
25
|
-
"
|
26
|
-
"
|
43
|
+
"commit": "317209bb5cd57c40f35bc42060acb7e3cce5ec95",
|
44
|
+
"comment": "BREAKING: Rename component hooks add the suffix _unstable, as their API has not been finalized yet"
|
27
45
|
},
|
28
46
|
{
|
29
|
-
"author": "
|
47
|
+
"author": "behowell@microsoft.com",
|
30
48
|
"package": "@fluentui/react-tooltip",
|
31
|
-
"
|
32
|
-
"
|
49
|
+
"commit": "7cc28ed8320b00f42d91c63882f10316db2205c5",
|
50
|
+
"comment": "Remove component's shorthandProps array"
|
33
51
|
},
|
34
52
|
{
|
35
|
-
"author": "
|
53
|
+
"author": "Humberto.Morimoto@microsoft.com",
|
54
|
+
"package": "@fluentui/react-tooltip",
|
55
|
+
"commit": "e0b8e1fa6980077e7b311fd1c72c28d3e4305db0",
|
56
|
+
"comment": "Updating based on changes to composition types."
|
57
|
+
},
|
58
|
+
{
|
59
|
+
"author": "behowell@microsoft.com",
|
60
|
+
"package": "@fluentui/react-tooltip",
|
61
|
+
"commit": "97c3818f7faf8733a0cfc9c91f5e94ddb8652d3a",
|
62
|
+
"comment": "Update documentation stories"
|
63
|
+
},
|
64
|
+
{
|
65
|
+
"author": "behowell@microsoft.com",
|
66
|
+
"package": "@fluentui/react-tooltip",
|
67
|
+
"commit": "09804275c7f346db54c33d4ff347bffc33676014",
|
68
|
+
"comment": "Fix tooltip arrow rendering, and add high contrast border around Tooltip"
|
69
|
+
},
|
70
|
+
{
|
71
|
+
"author": "behowell@microsoft.com",
|
36
72
|
"package": "@fluentui/react-tooltip",
|
37
|
-
"
|
38
|
-
"
|
73
|
+
"commit": "1513362b9adaae5d7dbda6b364e40e736710a79f",
|
74
|
+
"comment": "Remove Tooltip's inverted prop in favor of the appearance prop"
|
75
|
+
},
|
76
|
+
{
|
77
|
+
"author": "olfedias@microsoft.com",
|
78
|
+
"package": "@fluentui/react-tooltip",
|
79
|
+
"commit": "02e6236e4db8e1b591223475896537e905bf3580",
|
80
|
+
"comment": "BREAKING: implement `content` slot"
|
81
|
+
},
|
82
|
+
{
|
83
|
+
"author": "olfedias@microsoft.com",
|
84
|
+
"package": "@fluentui/react-tooltip",
|
85
|
+
"commit": "17c0b18d7983d414095661bf9f57e14c0c22685d",
|
86
|
+
"comment": "Replace make-styles packages with griffel equivalents."
|
87
|
+
},
|
88
|
+
{
|
89
|
+
"author": "behowell@microsoft.com",
|
90
|
+
"package": "@fluentui/react-tooltip",
|
91
|
+
"commit": "58ae40d6817b1fa4e095a94707dfef5050aa4c11",
|
92
|
+
"comment": "Replace `triggerAriaAttribute` prop with `relationship` and make it required with no default"
|
93
|
+
},
|
94
|
+
{
|
95
|
+
"author": "behowell@microsoft.com",
|
96
|
+
"package": "@fluentui/react-tooltip",
|
97
|
+
"commit": "f30e7585a8d2abd9db06c4076f39a779008b0eca",
|
98
|
+
"comment": "Update MenuTrigger and Tooltip to work together"
|
39
99
|
},
|
40
100
|
{
|
41
101
|
"author": "beachball",
|
42
102
|
"package": "@fluentui/react-tooltip",
|
43
|
-
"comment": "Bump @fluentui/react-
|
44
|
-
"commit": "
|
103
|
+
"comment": "Bump @fluentui/react-portal to v0.0.0-nightlye1926bfeca20220204.1",
|
104
|
+
"commit": "448766390ca759acf60ffccef08e4c3ffe41f4f6"
|
45
105
|
},
|
46
106
|
{
|
47
107
|
"author": "beachball",
|
48
108
|
"package": "@fluentui/react-tooltip",
|
49
|
-
"comment": "Bump @fluentui/react-
|
50
|
-
"commit": "
|
109
|
+
"comment": "Bump @fluentui/react-positioning to v0.0.0-nightlye1926bfeca20220204.1",
|
110
|
+
"commit": "448766390ca759acf60ffccef08e4c3ffe41f4f6"
|
51
111
|
},
|
52
112
|
{
|
53
113
|
"author": "beachball",
|
54
114
|
"package": "@fluentui/react-tooltip",
|
55
|
-
"comment": "Bump @fluentui/react-
|
56
|
-
"commit": "
|
115
|
+
"comment": "Bump @fluentui/react-shared-contexts to v0.0.0-nightlye1926bfeca20220204.1",
|
116
|
+
"commit": "448766390ca759acf60ffccef08e4c3ffe41f4f6"
|
57
117
|
},
|
58
118
|
{
|
59
119
|
"author": "beachball",
|
60
120
|
"package": "@fluentui/react-tooltip",
|
61
|
-
"comment": "Bump @fluentui/
|
62
|
-
"commit": "
|
121
|
+
"comment": "Bump @fluentui/react-theme to v0.0.0-nightlye1926bfeca20220204.1",
|
122
|
+
"commit": "448766390ca759acf60ffccef08e4c3ffe41f4f6"
|
63
123
|
},
|
64
124
|
{
|
65
125
|
"author": "beachball",
|
66
126
|
"package": "@fluentui/react-tooltip",
|
67
|
-
"comment": "Bump @fluentui/
|
68
|
-
"commit": "
|
127
|
+
"comment": "Bump @fluentui/react-utilities to v0.0.0-nightlye1926bfeca20220204.1",
|
128
|
+
"commit": "448766390ca759acf60ffccef08e4c3ffe41f4f6"
|
69
129
|
},
|
70
130
|
{
|
71
131
|
"author": "beachball",
|
72
132
|
"package": "@fluentui/react-tooltip",
|
73
|
-
"comment": "Bump @fluentui/react-conformance-
|
74
|
-
"commit": "
|
133
|
+
"comment": "Bump @fluentui/react-conformance-griffel to v0.0.0-nightlye1926bfeca20220204.1",
|
134
|
+
"commit": "448766390ca759acf60ffccef08e4c3ffe41f4f6"
|
135
|
+
}
|
136
|
+
],
|
137
|
+
"none": [
|
138
|
+
{
|
139
|
+
"author": "martinhochel@microsoft.com",
|
140
|
+
"package": "@fluentui/react-tooltip",
|
141
|
+
"commit": "8dfa712156b70414205b87b5b6d099367b0c297d",
|
142
|
+
"comment": "chore: use storybook runner for all vNext packages"
|
143
|
+
},
|
144
|
+
{
|
145
|
+
"author": "andredias@microsoft.com",
|
146
|
+
"package": "@fluentui/react-tooltip",
|
147
|
+
"commit": "b59f44ed5db37b457476fdb3ec86ff273b776646",
|
148
|
+
"comment": "Migrate package to use solution tsconfigs"
|
149
|
+
},
|
150
|
+
{
|
151
|
+
"author": "olfedias@microsoft.com",
|
152
|
+
"package": "@fluentui/react-tooltip",
|
153
|
+
"commit": "c061e98be4b4a718c72a144a1f60bb5515824612",
|
154
|
+
"comment": "remove inline-style-expand-shorthand from tsconfigs"
|
155
|
+
},
|
156
|
+
{
|
157
|
+
"author": "elcraig@microsoft.com",
|
158
|
+
"package": "@fluentui/react-tooltip",
|
159
|
+
"commit": "d892c7f79c543b6008634ecd669b75b5108cad46",
|
160
|
+
"comment": "Remove outdated boilerplate comment in useTooltip"
|
75
161
|
}
|
76
162
|
]
|
77
163
|
}
|
package/CHANGELOG.md
CHANGED
@@ -1,27 +1,37 @@
|
|
1
1
|
# Change Log - @fluentui/react-tooltip
|
2
2
|
|
3
|
-
This log was last generated on
|
3
|
+
This log was last generated on Fri, 04 Feb 2022 04:13:21 GMT and should not be manually modified.
|
4
4
|
|
5
5
|
<!-- Start content -->
|
6
6
|
|
7
|
-
## [0.0.0-
|
7
|
+
## [0.0.0-nightlye1926bfeca20220204.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-tooltip_v0.0.0-nightlye1926bfeca20220204.1)
|
8
8
|
|
9
|
-
|
10
|
-
[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-tooltip_v9.0.0-beta.5..@fluentui/react-tooltip_v0.0.0-
|
9
|
+
Fri, 04 Feb 2022 04:13:21 GMT
|
10
|
+
[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-tooltip_v9.0.0-beta.5..@fluentui/react-tooltip_v0.0.0-nightlye1926bfeca20220204.1)
|
11
11
|
|
12
12
|
### Changes
|
13
13
|
|
14
|
-
- Release nightly v9 ([commit](https://github.com/microsoft/fluentui/commit/
|
14
|
+
- Release nightly v9 ([commit](https://github.com/microsoft/fluentui/commit/448766390ca759acf60ffccef08e4c3ffe41f4f6) by email not defined)
|
15
|
+
- Move arrowHeight and tooltipBorderRadius into a shared constants.ts file ([PR #21204](https://github.com/microsoft/fluentui/pull/21204) by behowell@microsoft.com)
|
16
|
+
- Prevent Tooltip from overriding any aria-label, etc. props on its child ([PR #21532](https://github.com/microsoft/fluentui/pull/21532) by behowell@microsoft.com)
|
17
|
+
- Replacing use of functions in makeStyles with direct use of tokens. ([PR #21058](https://github.com/microsoft/fluentui/pull/21058) by Humberto.Morimoto@microsoft.com)
|
15
18
|
- update styles to not use CSS shorthands ([PR #20795](https://github.com/microsoft/fluentui/pull/20795) by olfedias@microsoft.com)
|
16
|
-
-
|
17
|
-
-
|
18
|
-
-
|
19
|
-
-
|
20
|
-
-
|
21
|
-
-
|
22
|
-
-
|
23
|
-
-
|
24
|
-
-
|
19
|
+
- BREAKING: Rename component hooks add the suffix _unstable, as their API has not been finalized yet ([PR #21365](https://github.com/microsoft/fluentui/pull/21365) by behowell@microsoft.com)
|
20
|
+
- Remove component's shorthandProps array ([PR #21134](https://github.com/microsoft/fluentui/pull/21134) by behowell@microsoft.com)
|
21
|
+
- Updating based on changes to composition types. ([PR #20891](https://github.com/microsoft/fluentui/pull/20891) by Humberto.Morimoto@microsoft.com)
|
22
|
+
- Update documentation stories ([PR #21298](https://github.com/microsoft/fluentui/pull/21298) by behowell@microsoft.com)
|
23
|
+
- Fix tooltip arrow rendering, and add high contrast border around Tooltip ([PR #21086](https://github.com/microsoft/fluentui/pull/21086) by behowell@microsoft.com)
|
24
|
+
- Remove Tooltip's inverted prop in favor of the appearance prop ([PR #21327](https://github.com/microsoft/fluentui/pull/21327) by behowell@microsoft.com)
|
25
|
+
- BREAKING: implement `content` slot ([PR #21470](https://github.com/microsoft/fluentui/pull/21470) by olfedias@microsoft.com)
|
26
|
+
- Replace make-styles packages with griffel equivalents. ([PR #21422](https://github.com/microsoft/fluentui/pull/21422) by olfedias@microsoft.com)
|
27
|
+
- Replace `triggerAriaAttribute` prop with `relationship` and make it required with no default ([PR #21331](https://github.com/microsoft/fluentui/pull/21331) by behowell@microsoft.com)
|
28
|
+
- Update MenuTrigger and Tooltip to work together ([PR #21495](https://github.com/microsoft/fluentui/pull/21495) by behowell@microsoft.com)
|
29
|
+
- Bump @fluentui/react-portal to v0.0.0-nightlye1926bfeca20220204.1 ([commit](https://github.com/microsoft/fluentui/commit/448766390ca759acf60ffccef08e4c3ffe41f4f6) by beachball)
|
30
|
+
- Bump @fluentui/react-positioning to v0.0.0-nightlye1926bfeca20220204.1 ([commit](https://github.com/microsoft/fluentui/commit/448766390ca759acf60ffccef08e4c3ffe41f4f6) by beachball)
|
31
|
+
- Bump @fluentui/react-shared-contexts to v0.0.0-nightlye1926bfeca20220204.1 ([commit](https://github.com/microsoft/fluentui/commit/448766390ca759acf60ffccef08e4c3ffe41f4f6) by beachball)
|
32
|
+
- Bump @fluentui/react-theme to v0.0.0-nightlye1926bfeca20220204.1 ([commit](https://github.com/microsoft/fluentui/commit/448766390ca759acf60ffccef08e4c3ffe41f4f6) by beachball)
|
33
|
+
- Bump @fluentui/react-utilities to v0.0.0-nightlye1926bfeca20220204.1 ([commit](https://github.com/microsoft/fluentui/commit/448766390ca759acf60ffccef08e4c3ffe41f4f6) by beachball)
|
34
|
+
- Bump @fluentui/react-conformance-griffel to v0.0.0-nightlye1926bfeca20220204.1 ([commit](https://github.com/microsoft/fluentui/commit/448766390ca759acf60ffccef08e4c3ffe41f4f6) by beachball)
|
25
35
|
|
26
36
|
## [9.0.0-beta.5](https://github.com/microsoft/fluentui/tree/@fluentui/react-tooltip_v9.0.0-beta.5)
|
27
37
|
|
package/dist/react-tooltip.d.ts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
import type { ComponentProps } from '@fluentui/react-utilities';
|
2
2
|
import type { ComponentState } from '@fluentui/react-utilities';
|
3
|
-
import type {
|
4
|
-
import type {
|
3
|
+
import type { FluentTriggerComponent } from '@fluentui/react-utilities';
|
4
|
+
import type { IntrinsicSlotProps } from '@fluentui/react-utilities';
|
5
5
|
import type { PositioningShorthand } from '@fluentui/react-positioning';
|
6
6
|
import * as React_2 from 'react';
|
7
7
|
|
@@ -15,12 +15,12 @@ export declare type OnVisibleChangeData = {
|
|
15
15
|
/**
|
16
16
|
* Render the final JSX of Tooltip
|
17
17
|
*/
|
18
|
-
export declare const
|
18
|
+
export declare const renderTooltip_unstable: (state: TooltipState) => JSX.Element;
|
19
19
|
|
20
20
|
/**
|
21
21
|
* A tooltip provides light weight contextual information on top of its target element.
|
22
22
|
*/
|
23
|
-
export declare const Tooltip:
|
23
|
+
export declare const Tooltip: React_2.FC<TooltipProps> & FluentTriggerComponent;
|
24
24
|
|
25
25
|
export declare const tooltipClassName = "fui-Tooltip";
|
26
26
|
|
@@ -29,20 +29,13 @@ export declare const tooltipClassName = "fui-Tooltip";
|
|
29
29
|
*/
|
30
30
|
export declare type TooltipCommons = {
|
31
31
|
/**
|
32
|
-
*
|
33
|
-
*
|
34
|
-
|
35
|
-
appearance?: 'inverted';
|
36
|
-
/**
|
37
|
-
* The content displayed inside the tooltip.
|
38
|
-
*/
|
39
|
-
content: React_2.ReactNode;
|
40
|
-
/**
|
41
|
-
* Color variant with inverted colors
|
32
|
+
* The tooltip's visual appearance.
|
33
|
+
* * `normal` - Uses the theme's background and text colors.
|
34
|
+
* * `inverted` - Higher contrast variant that uses the theme's inverted colors.
|
42
35
|
*
|
43
|
-
* @defaultvalue
|
36
|
+
* @defaultvalue normal
|
44
37
|
*/
|
45
|
-
|
38
|
+
appearance?: 'normal' | 'inverted';
|
46
39
|
/**
|
47
40
|
* Render an arrow pointing to the target element
|
48
41
|
*
|
@@ -69,15 +62,15 @@ export declare type TooltipCommons = {
|
|
69
62
|
*/
|
70
63
|
onVisibleChange?: (event: React_2.PointerEvent<HTMLElement> | React_2.FocusEvent<HTMLElement> | undefined, data: OnVisibleChangeData) => void;
|
71
64
|
/**
|
72
|
-
* Specifies
|
73
|
-
* * `label` - Set aria-label to the tooltip's content. Requires content to be a string; if not, uses `labelledby`.
|
74
|
-
* * `labelledby` - Set aria-labelledby to the tooltip's id. The id is generated if not provided.
|
75
|
-
* * `describedby` - Set aria-describedby to the tooltip's id. The id is generated if not provided.
|
76
|
-
* * null - Do not set any aria attributes on the trigger element.
|
65
|
+
* (Required) Specifies whether this tooltip is acting as the description or label of its trigger element.
|
77
66
|
*
|
78
|
-
*
|
67
|
+
* * `label` - The tooltip sets the trigger's aria-label or aria-labelledby attribute. This is useful for buttons
|
68
|
+
* displaying only an icon, for example.
|
69
|
+
* * `description` - The tooltip sets the trigger's aria-description or aria-describedby attribute.
|
70
|
+
* * `inaccessible` - No aria attributes are set on the trigger. This makes the tooltip's content inaccessible to
|
71
|
+
* screen readers, and should only be used if the tooltip's text is available by some other means.
|
79
72
|
*/
|
80
|
-
|
73
|
+
relationship: 'label' | 'description' | 'inaccessible';
|
81
74
|
/**
|
82
75
|
* Delay before the tooltip is shown, in milliseconds.
|
83
76
|
*
|
@@ -95,36 +88,26 @@ export declare type TooltipCommons = {
|
|
95
88
|
/**
|
96
89
|
* Properties for Tooltip
|
97
90
|
*/
|
98
|
-
export declare type TooltipProps = ComponentProps<TooltipSlots> & Partial<Omit<TooltipCommons, '
|
91
|
+
export declare type TooltipProps = Omit<ComponentProps<TooltipSlots>, 'content'> & Required<Pick<ComponentProps<TooltipSlots>, 'content'>> & Partial<Omit<TooltipCommons, 'relationship'>> & Pick<TooltipCommons, 'relationship'> & {
|
92
|
+
children?: (React_2.ReactElement & {
|
93
|
+
ref?: React_2.Ref<unknown>;
|
94
|
+
}) | ((props: TooltipTriggerProps) => React_2.ReactNode) | null;
|
95
|
+
};
|
99
96
|
|
100
97
|
/**
|
101
98
|
* Slot properties for Tooltip
|
102
99
|
*/
|
103
100
|
export declare type TooltipSlots = {
|
104
|
-
|
105
|
-
/**
|
106
|
-
* The child is the element that triggers the Tooltip. It will have additional properties added,
|
107
|
-
* including events and aria properties.
|
108
|
-
* Alternatively, children can be a render function that takes the props and adds
|
109
|
-
* them to the appropriate elements.
|
110
|
-
*/
|
111
|
-
children?: (React_2.ReactElement<React_2.HTMLAttributes<HTMLElement>> & {
|
112
|
-
ref?: React_2.Ref<unknown>;
|
113
|
-
}) | ((props: TooltipTriggerProps) => React_2.ReactNode) | null;
|
114
|
-
};
|
101
|
+
content: IntrinsicSlotProps<'div'>;
|
115
102
|
};
|
116
103
|
|
117
104
|
/**
|
118
105
|
* State used in rendering Tooltip
|
119
106
|
*/
|
120
107
|
export declare type TooltipState = ComponentState<TooltipSlots> & TooltipCommons & {
|
108
|
+
children?: React_2.ReactNode;
|
121
109
|
/**
|
122
110
|
* Whether the tooltip should be rendered to the DOM.
|
123
|
-
*
|
124
|
-
* Normally the tooltip will only be rendered when visible. However, if
|
125
|
-
* triggerAriaAttribute is labelledby or describedby, the tooltip will
|
126
|
-
* always be rendered even when hidden so that those aria attributes
|
127
|
-
* to always refer to a valid DOM element.
|
128
111
|
*/
|
129
112
|
shouldRenderTooltip?: boolean;
|
130
113
|
/**
|
@@ -147,18 +130,16 @@ export declare type TooltipTriggerProps = {
|
|
147
130
|
/**
|
148
131
|
* Create the state required to render Tooltip.
|
149
132
|
*
|
150
|
-
* The returned state can be modified with hooks such as
|
151
|
-
* before being passed to
|
133
|
+
* The returned state can be modified with hooks such as useTooltipStyles_unstable,
|
134
|
+
* before being passed to renderTooltip_unstable.
|
152
135
|
*
|
153
136
|
* @param props - props from this instance of Tooltip
|
154
|
-
* @param ref - reference to root HTMLElement of Tooltip
|
155
|
-
* @param defaultProps - (optional) default prop values provided by the implementing type
|
156
137
|
*/
|
157
|
-
export declare const
|
138
|
+
export declare const useTooltip_unstable: (props: TooltipProps) => TooltipState;
|
158
139
|
|
159
140
|
/**
|
160
141
|
* Apply styling to the Tooltip slots based on the state
|
161
142
|
*/
|
162
|
-
export declare const
|
143
|
+
export declare const useTooltipStyles_unstable: (state: TooltipState) => TooltipState;
|
163
144
|
|
164
145
|
export { }
|
@@ -1,6 +1,7 @@
|
|
1
|
+
import * as React from 'react';
|
1
2
|
import type { TooltipProps } from './Tooltip.types';
|
2
|
-
import type {
|
3
|
+
import type { FluentTriggerComponent } from '@fluentui/react-utilities';
|
3
4
|
/**
|
4
5
|
* A tooltip provides light weight contextual information on top of its target element.
|
5
6
|
*/
|
6
|
-
export declare const Tooltip:
|
7
|
+
export declare const Tooltip: React.FC<TooltipProps> & FluentTriggerComponent;
|
@@ -1,15 +1,15 @@
|
|
1
|
-
import
|
2
|
-
import {
|
3
|
-
import {
|
4
|
-
import { useTooltipStyles } from './useTooltipStyles';
|
1
|
+
import { useTooltip_unstable } from './useTooltip';
|
2
|
+
import { renderTooltip_unstable } from './renderTooltip';
|
3
|
+
import { useTooltipStyles_unstable } from './useTooltipStyles';
|
5
4
|
/**
|
6
5
|
* A tooltip provides light weight contextual information on top of its target element.
|
7
6
|
*/
|
8
7
|
|
9
|
-
export const Tooltip =
|
10
|
-
const state =
|
11
|
-
|
12
|
-
return
|
13
|
-
}
|
8
|
+
export const Tooltip = props => {
|
9
|
+
const state = useTooltip_unstable(props);
|
10
|
+
useTooltipStyles_unstable(state);
|
11
|
+
return renderTooltip_unstable(state);
|
12
|
+
};
|
14
13
|
Tooltip.displayName = 'Tooltip';
|
14
|
+
Tooltip.isFluentTriggerComponent = true;
|
15
15
|
//# sourceMappingURL=Tooltip.js.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["../../../src/components/Tooltip/Tooltip.tsx"],"names":[],"mappings":"
|
1
|
+
{"version":3,"sources":["../../../src/components/Tooltip/Tooltip.tsx"],"names":[],"mappings":"AACA,SAAS,mBAAT,QAAoC,cAApC;AACA,SAAS,sBAAT,QAAuC,iBAAvC;AACA,SAAS,yBAAT,QAA0C,oBAA1C;AAIA;;AAEG;;AACH,OAAO,MAAM,OAAO,GAAoD,KAAK,IAAG;AAC9E,QAAM,KAAK,GAAG,mBAAmB,CAAC,KAAD,CAAjC;AAEA,EAAA,yBAAyB,CAAC,KAAD,CAAzB;AACA,SAAO,sBAAsB,CAAC,KAAD,CAA7B;AACD,CALM;AAOP,OAAO,CAAC,WAAR,GAAsB,SAAtB;AACA,OAAO,CAAC,wBAAR,GAAmC,IAAnC","sourceRoot":""}
|
@@ -1,41 +1,24 @@
|
|
1
1
|
import * as React from 'react';
|
2
2
|
import type { PositioningShorthand } from '@fluentui/react-positioning';
|
3
|
-
import type { ComponentProps, ComponentState,
|
3
|
+
import type { ComponentProps, ComponentState, IntrinsicSlotProps } from '@fluentui/react-utilities';
|
4
4
|
/**
|
5
5
|
* Slot properties for Tooltip
|
6
6
|
*/
|
7
7
|
export declare type TooltipSlots = {
|
8
|
-
|
9
|
-
/**
|
10
|
-
* The child is the element that triggers the Tooltip. It will have additional properties added,
|
11
|
-
* including events and aria properties.
|
12
|
-
* Alternatively, children can be a render function that takes the props and adds
|
13
|
-
* them to the appropriate elements.
|
14
|
-
*/
|
15
|
-
children?: (React.ReactElement<React.HTMLAttributes<HTMLElement>> & {
|
16
|
-
ref?: React.Ref<unknown>;
|
17
|
-
}) | ((props: TooltipTriggerProps) => React.ReactNode) | null;
|
18
|
-
};
|
8
|
+
content: IntrinsicSlotProps<'div'>;
|
19
9
|
};
|
20
10
|
/**
|
21
11
|
* Properties and state for Tooltip
|
22
12
|
*/
|
23
13
|
export declare type TooltipCommons = {
|
24
14
|
/**
|
25
|
-
*
|
26
|
-
*
|
27
|
-
|
28
|
-
appearance?: 'inverted';
|
29
|
-
/**
|
30
|
-
* The content displayed inside the tooltip.
|
31
|
-
*/
|
32
|
-
content: React.ReactNode;
|
33
|
-
/**
|
34
|
-
* Color variant with inverted colors
|
15
|
+
* The tooltip's visual appearance.
|
16
|
+
* * `normal` - Uses the theme's background and text colors.
|
17
|
+
* * `inverted` - Higher contrast variant that uses the theme's inverted colors.
|
35
18
|
*
|
36
|
-
* @defaultvalue
|
19
|
+
* @defaultvalue normal
|
37
20
|
*/
|
38
|
-
|
21
|
+
appearance?: 'normal' | 'inverted';
|
39
22
|
/**
|
40
23
|
* Render an arrow pointing to the target element
|
41
24
|
*
|
@@ -62,15 +45,15 @@ export declare type TooltipCommons = {
|
|
62
45
|
*/
|
63
46
|
onVisibleChange?: (event: React.PointerEvent<HTMLElement> | React.FocusEvent<HTMLElement> | undefined, data: OnVisibleChangeData) => void;
|
64
47
|
/**
|
65
|
-
* Specifies
|
66
|
-
* * `label` - Set aria-label to the tooltip's content. Requires content to be a string; if not, uses `labelledby`.
|
67
|
-
* * `labelledby` - Set aria-labelledby to the tooltip's id. The id is generated if not provided.
|
68
|
-
* * `describedby` - Set aria-describedby to the tooltip's id. The id is generated if not provided.
|
69
|
-
* * null - Do not set any aria attributes on the trigger element.
|
48
|
+
* (Required) Specifies whether this tooltip is acting as the description or label of its trigger element.
|
70
49
|
*
|
71
|
-
*
|
50
|
+
* * `label` - The tooltip sets the trigger's aria-label or aria-labelledby attribute. This is useful for buttons
|
51
|
+
* displaying only an icon, for example.
|
52
|
+
* * `description` - The tooltip sets the trigger's aria-description or aria-describedby attribute.
|
53
|
+
* * `inaccessible` - No aria attributes are set on the trigger. This makes the tooltip's content inaccessible to
|
54
|
+
* screen readers, and should only be used if the tooltip's text is available by some other means.
|
72
55
|
*/
|
73
|
-
|
56
|
+
relationship: 'label' | 'description' | 'inaccessible';
|
74
57
|
/**
|
75
58
|
* Delay before the tooltip is shown, in milliseconds.
|
76
59
|
*
|
@@ -99,18 +82,18 @@ export declare type OnVisibleChangeData = {
|
|
99
82
|
/**
|
100
83
|
* Properties for Tooltip
|
101
84
|
*/
|
102
|
-
export declare type TooltipProps = ComponentProps<TooltipSlots> & Partial<Omit<TooltipCommons, '
|
85
|
+
export declare type TooltipProps = Omit<ComponentProps<TooltipSlots>, 'content'> & Required<Pick<ComponentProps<TooltipSlots>, 'content'>> & Partial<Omit<TooltipCommons, 'relationship'>> & Pick<TooltipCommons, 'relationship'> & {
|
86
|
+
children?: (React.ReactElement & {
|
87
|
+
ref?: React.Ref<unknown>;
|
88
|
+
}) | ((props: TooltipTriggerProps) => React.ReactNode) | null;
|
89
|
+
};
|
103
90
|
/**
|
104
91
|
* State used in rendering Tooltip
|
105
92
|
*/
|
106
93
|
export declare type TooltipState = ComponentState<TooltipSlots> & TooltipCommons & {
|
94
|
+
children?: React.ReactNode;
|
107
95
|
/**
|
108
96
|
* Whether the tooltip should be rendered to the DOM.
|
109
|
-
*
|
110
|
-
* Normally the tooltip will only be rendered when visible. However, if
|
111
|
-
* triggerAriaAttribute is labelledby or describedby, the tooltip will
|
112
|
-
* always be rendered even when hidden so that those aria attributes
|
113
|
-
* to always refer to a valid DOM element.
|
114
97
|
*/
|
115
98
|
shouldRenderTooltip?: boolean;
|
116
99
|
/**
|
@@ -0,0 +1,12 @@
|
|
1
|
+
/**
|
2
|
+
* The height of the tooltip's arrow in pixels.
|
3
|
+
*/
|
4
|
+
export declare const arrowHeight = 6;
|
5
|
+
/**
|
6
|
+
* The default value of the tooltip's border radius (borderRadiusMedium).
|
7
|
+
*
|
8
|
+
* Unfortunately, Popper requires it to be specified as a variable instead of using CSS.
|
9
|
+
* While we could use getComputedStyle, that adds a performance penalty for something that
|
10
|
+
* will likely never change.
|
11
|
+
*/
|
12
|
+
export declare const tooltipBorderRadius = 4;
|
@@ -0,0 +1,14 @@
|
|
1
|
+
/**
|
2
|
+
* The height of the tooltip's arrow in pixels.
|
3
|
+
*/
|
4
|
+
export const arrowHeight = 6;
|
5
|
+
/**
|
6
|
+
* The default value of the tooltip's border radius (borderRadiusMedium).
|
7
|
+
*
|
8
|
+
* Unfortunately, Popper requires it to be specified as a variable instead of using CSS.
|
9
|
+
* While we could use getComputedStyle, that adds a performance penalty for something that
|
10
|
+
* will likely never change.
|
11
|
+
*/
|
12
|
+
|
13
|
+
export const tooltipBorderRadius = 4;
|
14
|
+
//# sourceMappingURL=constants.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"sources":["../../../../src/components/Tooltip/private/constants.ts"],"names":[],"mappings":"AAAA;;AAEG;AACH,OAAO,MAAM,WAAW,GAAG,CAApB;AAEP;;;;;;AAMG;;AACH,OAAO,MAAM,mBAAmB,GAAG,CAA5B","sourceRoot":""}
|
@@ -5,14 +5,15 @@ import { getSlots } from '@fluentui/react-utilities';
|
|
5
5
|
* Render the final JSX of Tooltip
|
6
6
|
*/
|
7
7
|
|
8
|
-
export const
|
8
|
+
export const renderTooltip_unstable = state => {
|
9
9
|
const {
|
10
10
|
slots,
|
11
11
|
slotProps
|
12
|
-
} = getSlots(state
|
13
|
-
return /*#__PURE__*/React.createElement(React.Fragment, null, state.
|
12
|
+
} = getSlots(state);
|
13
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, state.children, state.shouldRenderTooltip && /*#__PURE__*/React.createElement(Portal, null, /*#__PURE__*/React.createElement(slots.content, { ...slotProps.content
|
14
|
+
}, state.withArrow && /*#__PURE__*/React.createElement("div", {
|
14
15
|
ref: state.arrowRef,
|
15
16
|
className: state.arrowClassName
|
16
|
-
}), state.content)));
|
17
|
+
}), state.content.children)));
|
17
18
|
};
|
18
19
|
//# sourceMappingURL=renderTooltip.js.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["../../../src/components/Tooltip/renderTooltip.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,MAAT,QAAuB,wBAAvB;AACA,SAAS,QAAT,QAAyB,2BAAzB;AAGA;;AAEG;;AACH,OAAO,MAAM,
|
1
|
+
{"version":3,"sources":["../../../src/components/Tooltip/renderTooltip.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,MAAT,QAAuB,wBAAvB;AACA,SAAS,QAAT,QAAyB,2BAAzB;AAGA;;AAEG;;AACH,OAAO,MAAM,sBAAsB,GAAI,KAAD,IAAwB;AAC5D,QAAM;AAAE,IAAA,KAAF;AAAS,IAAA;AAAT,MAAuB,QAAQ,CAAe,KAAf,CAArC;AAEA,sBACE,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EACG,KAAK,CAAC,QADT,EAEG,KAAK,CAAC,mBAAN,iBACC,KAAA,CAAA,aAAA,CAAC,MAAD,EAAO,IAAP,eACE,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,OAAP,EAAc,EAAA,GAAK,SAAS,CAAC;AAAf,GAAd,EACG,KAAK,CAAC,SAAN,iBAAmB,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA;AAAK,IAAA,GAAG,EAAE,KAAK,CAAC,QAAhB;AAA0B,IAAA,SAAS,EAAE,KAAK,CAAC;AAA3C,GAAA,CADtB,EAEG,KAAK,CAAC,OAAN,CAAc,QAFjB,CADF,CAHJ,CADF;AAaD,CAhBM","sourceRoot":""}
|
@@ -1,13 +1,10 @@
|
|
1
|
-
import * as React from 'react';
|
2
1
|
import type { TooltipProps, TooltipState } from './Tooltip.types';
|
3
2
|
/**
|
4
3
|
* Create the state required to render Tooltip.
|
5
4
|
*
|
6
|
-
* The returned state can be modified with hooks such as
|
7
|
-
* before being passed to
|
5
|
+
* The returned state can be modified with hooks such as useTooltipStyles_unstable,
|
6
|
+
* before being passed to renderTooltip_unstable.
|
8
7
|
*
|
9
8
|
* @param props - props from this instance of Tooltip
|
10
|
-
* @param ref - reference to root HTMLElement of Tooltip
|
11
|
-
* @param defaultProps - (optional) default prop values provided by the implementing type
|
12
9
|
*/
|
13
|
-
export declare const
|
10
|
+
export declare const useTooltip_unstable: (props: TooltipProps) => TooltipState;
|