@fluentui/react-tooltip 0.0.0-nightly-20220513-0417.1 → 0.0.0-nightly-20220516-0419.1
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/CHANGELOG.json +35 -11
- package/CHANGELOG.md +12 -8
- package/{lib → dist}/tsdoc-metadata.json +0 -0
- package/package.json +9 -9
- package/lib/Tooltip.d.ts +0 -1
- package/lib/components/Tooltip/Tooltip.d.ts +0 -7
- package/lib/components/Tooltip/Tooltip.types.d.ts +0 -114
- package/lib/components/Tooltip/index.d.ts +0 -5
- package/lib/components/Tooltip/private/constants.d.ts +0 -12
- package/lib/components/Tooltip/renderTooltip.d.ts +0 -5
- package/lib/components/Tooltip/useTooltip.d.ts +0 -10
- package/lib/components/Tooltip/useTooltipStyles.d.ts +0 -11
- package/lib/index.d.ts +0 -2
- package/lib-commonjs/Tooltip.d.ts +0 -1
- package/lib-commonjs/components/Tooltip/Tooltip.d.ts +0 -7
- package/lib-commonjs/components/Tooltip/Tooltip.types.d.ts +0 -114
- package/lib-commonjs/components/Tooltip/index.d.ts +0 -5
- package/lib-commonjs/components/Tooltip/private/constants.d.ts +0 -12
- package/lib-commonjs/components/Tooltip/renderTooltip.d.ts +0 -5
- package/lib-commonjs/components/Tooltip/useTooltip.d.ts +0 -10
- package/lib-commonjs/components/Tooltip/useTooltipStyles.d.ts +0 -11
- package/lib-commonjs/index.d.ts +0 -2
package/CHANGELOG.json
CHANGED
@@ -2,9 +2,9 @@
|
|
2
2
|
"name": "@fluentui/react-tooltip",
|
3
3
|
"entries": [
|
4
4
|
{
|
5
|
-
"date": "
|
6
|
-
"tag": "@fluentui/react-tooltip_v0.0.0-nightly-
|
7
|
-
"version": "0.0.0-nightly-
|
5
|
+
"date": "Mon, 16 May 2022 04:32:39 GMT",
|
6
|
+
"tag": "@fluentui/react-tooltip_v0.0.0-nightly-20220516-0419.1",
|
7
|
+
"version": "0.0.0-nightly-20220516-0419.1",
|
8
8
|
"comments": {
|
9
9
|
"prerelease": [
|
10
10
|
{
|
@@ -13,29 +13,53 @@
|
|
13
13
|
"commit": "13543c30b0a05b61cb8d75c804d9b2aee45a8ae5",
|
14
14
|
"comment": "Removing TooltipCommons type."
|
15
15
|
},
|
16
|
+
{
|
17
|
+
"author": "martinhochel@microsoft.com",
|
18
|
+
"package": "@fluentui/react-tooltip",
|
19
|
+
"commit": "e7b70cb06f4422e5574993fd2ad44d9073647417",
|
20
|
+
"comment": "feat: ship rolluped only dts"
|
21
|
+
},
|
22
|
+
{
|
23
|
+
"author": "olfedias@microsoft.com",
|
24
|
+
"package": "@fluentui/react-tooltip",
|
25
|
+
"commit": "f120fe9160ad7311a87af0cfacd8d2fb26275e34",
|
26
|
+
"comment": "chore: Update Griffel to latest version"
|
27
|
+
},
|
28
|
+
{
|
29
|
+
"author": "beachball",
|
30
|
+
"package": "@fluentui/react-tooltip",
|
31
|
+
"comment": "Bump @fluentui/react-portal to v0.0.0-nightly-20220516-0419.1",
|
32
|
+
"commit": "737cd1292dec6412494b80cf051d7e51e2a0993f"
|
33
|
+
},
|
34
|
+
{
|
35
|
+
"author": "beachball",
|
36
|
+
"package": "@fluentui/react-tooltip",
|
37
|
+
"comment": "Bump @fluentui/react-positioning to v0.0.0-nightly-20220516-0419.1",
|
38
|
+
"commit": "737cd1292dec6412494b80cf051d7e51e2a0993f"
|
39
|
+
},
|
16
40
|
{
|
17
41
|
"author": "beachball",
|
18
42
|
"package": "@fluentui/react-tooltip",
|
19
|
-
"comment": "Bump @fluentui/react-
|
20
|
-
"commit": "
|
43
|
+
"comment": "Bump @fluentui/react-shared-contexts to v0.0.0-nightly-20220516-0419.1",
|
44
|
+
"commit": "737cd1292dec6412494b80cf051d7e51e2a0993f"
|
21
45
|
},
|
22
46
|
{
|
23
47
|
"author": "beachball",
|
24
48
|
"package": "@fluentui/react-tooltip",
|
25
|
-
"comment": "Bump @fluentui/react-
|
26
|
-
"commit": "
|
49
|
+
"comment": "Bump @fluentui/react-theme to v0.0.0-nightly-20220516-0419.1",
|
50
|
+
"commit": "737cd1292dec6412494b80cf051d7e51e2a0993f"
|
27
51
|
},
|
28
52
|
{
|
29
53
|
"author": "beachball",
|
30
54
|
"package": "@fluentui/react-tooltip",
|
31
|
-
"comment": "Bump @fluentui/react-
|
32
|
-
"commit": "
|
55
|
+
"comment": "Bump @fluentui/react-utilities to v0.0.0-nightly-20220516-0419.1",
|
56
|
+
"commit": "737cd1292dec6412494b80cf051d7e51e2a0993f"
|
33
57
|
},
|
34
58
|
{
|
35
59
|
"author": "beachball",
|
36
60
|
"package": "@fluentui/react-tooltip",
|
37
|
-
"comment": "Bump @fluentui/react-conformance-griffel to v0.0.0-nightly-
|
38
|
-
"commit": "
|
61
|
+
"comment": "Bump @fluentui/react-conformance-griffel to v0.0.0-nightly-20220516-0419.1",
|
62
|
+
"commit": "737cd1292dec6412494b80cf051d7e51e2a0993f"
|
39
63
|
}
|
40
64
|
]
|
41
65
|
}
|
package/CHANGELOG.md
CHANGED
@@ -1,21 +1,25 @@
|
|
1
1
|
# Change Log - @fluentui/react-tooltip
|
2
2
|
|
3
|
-
This log was last generated on
|
3
|
+
This log was last generated on Mon, 16 May 2022 04:32:39 GMT and should not be manually modified.
|
4
4
|
|
5
5
|
<!-- Start content -->
|
6
6
|
|
7
|
-
## [0.0.0-nightly-
|
7
|
+
## [0.0.0-nightly-20220516-0419.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-tooltip_v0.0.0-nightly-20220516-0419.1)
|
8
8
|
|
9
|
-
|
10
|
-
[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-tooltip_v9.0.0-rc.9..@fluentui/react-tooltip_v0.0.0-nightly-
|
9
|
+
Mon, 16 May 2022 04:32:39 GMT
|
10
|
+
[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-tooltip_v9.0.0-rc.9..@fluentui/react-tooltip_v0.0.0-nightly-20220516-0419.1)
|
11
11
|
|
12
12
|
### Changes
|
13
13
|
|
14
14
|
- Removing TooltipCommons type. ([PR #22953](https://github.com/microsoft/fluentui/pull/22953) by Humberto.Morimoto@microsoft.com)
|
15
|
-
-
|
16
|
-
-
|
17
|
-
- Bump @fluentui/react-
|
18
|
-
- Bump @fluentui/react-
|
15
|
+
- feat: ship rolluped only dts ([PR #22828](https://github.com/microsoft/fluentui/pull/22828) by martinhochel@microsoft.com)
|
16
|
+
- chore: Update Griffel to latest version ([PR #22894](https://github.com/microsoft/fluentui/pull/22894) by olfedias@microsoft.com)
|
17
|
+
- Bump @fluentui/react-portal to v0.0.0-nightly-20220516-0419.1 ([commit](https://github.com/microsoft/fluentui/commit/737cd1292dec6412494b80cf051d7e51e2a0993f) by beachball)
|
18
|
+
- Bump @fluentui/react-positioning to v0.0.0-nightly-20220516-0419.1 ([commit](https://github.com/microsoft/fluentui/commit/737cd1292dec6412494b80cf051d7e51e2a0993f) by beachball)
|
19
|
+
- Bump @fluentui/react-shared-contexts to v0.0.0-nightly-20220516-0419.1 ([commit](https://github.com/microsoft/fluentui/commit/737cd1292dec6412494b80cf051d7e51e2a0993f) by beachball)
|
20
|
+
- Bump @fluentui/react-theme to v0.0.0-nightly-20220516-0419.1 ([commit](https://github.com/microsoft/fluentui/commit/737cd1292dec6412494b80cf051d7e51e2a0993f) by beachball)
|
21
|
+
- Bump @fluentui/react-utilities to v0.0.0-nightly-20220516-0419.1 ([commit](https://github.com/microsoft/fluentui/commit/737cd1292dec6412494b80cf051d7e51e2a0993f) by beachball)
|
22
|
+
- Bump @fluentui/react-conformance-griffel to v0.0.0-nightly-20220516-0419.1 ([commit](https://github.com/microsoft/fluentui/commit/737cd1292dec6412494b80cf051d7e51e2a0993f) by beachball)
|
19
23
|
|
20
24
|
## [9.0.0-rc.9](https://github.com/microsoft/fluentui/tree/@fluentui/react-tooltip_v9.0.0-rc.9)
|
21
25
|
|
File without changes
|
package/package.json
CHANGED
@@ -1,10 +1,10 @@
|
|
1
1
|
{
|
2
2
|
"name": "@fluentui/react-tooltip",
|
3
|
-
"version": "0.0.0-nightly-
|
3
|
+
"version": "0.0.0-nightly-20220516-0419.1",
|
4
4
|
"description": "React components for building web experiences",
|
5
5
|
"main": "lib-commonjs/index.js",
|
6
6
|
"module": "lib/index.js",
|
7
|
-
"typings": "
|
7
|
+
"typings": "dist/index.d.ts",
|
8
8
|
"sideEffects": false,
|
9
9
|
"repository": {
|
10
10
|
"type": "git",
|
@@ -28,16 +28,16 @@
|
|
28
28
|
"devDependencies": {
|
29
29
|
"@fluentui/eslint-plugin": "*",
|
30
30
|
"@fluentui/react-conformance": "*",
|
31
|
-
"@fluentui/react-conformance-griffel": "0.0.0-nightly-
|
31
|
+
"@fluentui/react-conformance-griffel": "0.0.0-nightly-20220516-0419.1",
|
32
32
|
"@fluentui/scripts": "^1.0.0"
|
33
33
|
},
|
34
34
|
"dependencies": {
|
35
|
-
"@fluentui/react-portal": "0.0.0-nightly-
|
36
|
-
"@fluentui/react-positioning": "0.0.0-nightly-
|
37
|
-
"@fluentui/react-shared-contexts": "0.0.0-nightly-
|
38
|
-
"@fluentui/react-theme": "0.0.0-nightly-
|
39
|
-
"@fluentui/react-utilities": "0.0.0-nightly-
|
40
|
-
"@griffel/react": "1.0.
|
35
|
+
"@fluentui/react-portal": "0.0.0-nightly-20220516-0419.1",
|
36
|
+
"@fluentui/react-positioning": "0.0.0-nightly-20220516-0419.1",
|
37
|
+
"@fluentui/react-shared-contexts": "0.0.0-nightly-20220516-0419.1",
|
38
|
+
"@fluentui/react-theme": "0.0.0-nightly-20220516-0419.1",
|
39
|
+
"@fluentui/react-utilities": "0.0.0-nightly-20220516-0419.1",
|
40
|
+
"@griffel/react": "1.0.4",
|
41
41
|
"tslib": "^2.1.0"
|
42
42
|
},
|
43
43
|
"peerDependencies": {
|
package/lib/Tooltip.d.ts
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
export * from './components/Tooltip/index';
|
@@ -1,7 +0,0 @@
|
|
1
|
-
import * as React from 'react';
|
2
|
-
import type { TooltipProps } from './Tooltip.types';
|
3
|
-
import type { FluentTriggerComponent } from '@fluentui/react-utilities';
|
4
|
-
/**
|
5
|
-
* A tooltip provides light weight contextual information on top of its target element.
|
6
|
-
*/
|
7
|
-
export declare const Tooltip: React.FC<TooltipProps> & FluentTriggerComponent;
|
@@ -1,114 +0,0 @@
|
|
1
|
-
import * as React from 'react';
|
2
|
-
import type { PositioningShorthand } from '@fluentui/react-positioning';
|
3
|
-
import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
|
4
|
-
import type { PortalProps } from '@fluentui/react-portal';
|
5
|
-
/**
|
6
|
-
* Slot properties for Tooltip
|
7
|
-
*/
|
8
|
-
export declare type TooltipSlots = {
|
9
|
-
/**
|
10
|
-
* The text or JSX content of the tooltip.
|
11
|
-
*/
|
12
|
-
content: NonNullable<Slot<'div'>>;
|
13
|
-
};
|
14
|
-
/**
|
15
|
-
* The properties that are added to the trigger of the Tooltip
|
16
|
-
*/
|
17
|
-
export declare type TooltipTriggerProps = {
|
18
|
-
ref?: React.Ref<never>;
|
19
|
-
} & Pick<React.HTMLAttributes<HTMLElement>, 'aria-describedby' | 'aria-label' | 'aria-labelledby' | 'onBlur' | 'onFocus' | 'onPointerEnter' | 'onPointerLeave'>;
|
20
|
-
/**
|
21
|
-
* Data for the Tooltip's onVisibleChange event.
|
22
|
-
*/
|
23
|
-
export declare type OnVisibleChangeData = {
|
24
|
-
visible: boolean;
|
25
|
-
};
|
26
|
-
/**
|
27
|
-
* Properties for Tooltip
|
28
|
-
*/
|
29
|
-
export declare type TooltipProps = ComponentProps<TooltipSlots> & Pick<PortalProps, 'mountNode'> & {
|
30
|
-
/**
|
31
|
-
* The tooltip's visual appearance.
|
32
|
-
* * `normal` - Uses the theme's background and text colors.
|
33
|
-
* * `inverted` - Higher contrast variant that uses the theme's inverted colors.
|
34
|
-
*
|
35
|
-
* @default normal
|
36
|
-
*/
|
37
|
-
appearance?: 'normal' | 'inverted';
|
38
|
-
/**
|
39
|
-
* The tooltip can have a single JSX child, or a render function that accepts TooltipTriggerProps.
|
40
|
-
*
|
41
|
-
* If no child is provided, the tooltip's target must be set with the `positioning` prop, and its
|
42
|
-
* visibility must be controlled with the `visible` prop.
|
43
|
-
*/
|
44
|
-
children?: (React.ReactElement & {
|
45
|
-
ref?: React.Ref<unknown>;
|
46
|
-
}) | ((props: TooltipTriggerProps) => React.ReactElement | null) | null;
|
47
|
-
/**
|
48
|
-
* Delay before the tooltip is hidden, in milliseconds.
|
49
|
-
*
|
50
|
-
* @default 250
|
51
|
-
*/
|
52
|
-
hideDelay?: number;
|
53
|
-
/**
|
54
|
-
* Notification when the visibility of the tooltip is changing
|
55
|
-
*/
|
56
|
-
onVisibleChange?: (event: React.PointerEvent<HTMLElement> | React.FocusEvent<HTMLElement> | undefined, data: OnVisibleChangeData) => void;
|
57
|
-
/**
|
58
|
-
* Configure the positioning of the tooltip
|
59
|
-
*
|
60
|
-
* @default above
|
61
|
-
*/
|
62
|
-
positioning?: PositioningShorthand;
|
63
|
-
/**
|
64
|
-
* (Required) Specifies whether this tooltip is acting as the description or label of its trigger element.
|
65
|
-
*
|
66
|
-
* * `label` - The tooltip sets the trigger's aria-label or aria-labelledby attribute. This is useful for buttons
|
67
|
-
* displaying only an icon, for example.
|
68
|
-
* * `description` - The tooltip sets the trigger's aria-description or aria-describedby attribute.
|
69
|
-
* * `inaccessible` - No aria attributes are set on the trigger. This makes the tooltip's content inaccessible to
|
70
|
-
* screen readers, and should only be used if the tooltip's text is available by some other means.
|
71
|
-
*/
|
72
|
-
relationship: 'label' | 'description' | 'inaccessible';
|
73
|
-
/**
|
74
|
-
* Delay before the tooltip is shown, in milliseconds.
|
75
|
-
*
|
76
|
-
* @default 250
|
77
|
-
*/
|
78
|
-
showDelay?: number;
|
79
|
-
/**
|
80
|
-
* Control the tooltip's visibility programatically.
|
81
|
-
*
|
82
|
-
* This can be used in conjunction with onVisibleChange to modify the tooltip's show and hide behavior.
|
83
|
-
*
|
84
|
-
* If not provided, the visibility will be controlled by the tooltip itself, based on hover and focus events on the
|
85
|
-
* trigger (child) element.
|
86
|
-
*
|
87
|
-
* @default false
|
88
|
-
*/
|
89
|
-
visible?: boolean;
|
90
|
-
/**
|
91
|
-
* Render an arrow pointing to the target element
|
92
|
-
*
|
93
|
-
* @default false
|
94
|
-
*/
|
95
|
-
withArrow?: boolean;
|
96
|
-
};
|
97
|
-
/**
|
98
|
-
* State used in rendering Tooltip
|
99
|
-
*/
|
100
|
-
export declare type TooltipState = ComponentState<TooltipSlots> & Pick<TooltipProps, 'mountNode' | 'relationship'> & Required<Pick<TooltipProps, 'appearance' | 'hideDelay' | 'positioning' | 'showDelay' | 'visible' | 'withArrow'>> & {
|
101
|
-
children?: React.ReactElement | null;
|
102
|
-
/**
|
103
|
-
* Whether the tooltip should be rendered to the DOM.
|
104
|
-
*/
|
105
|
-
shouldRenderTooltip?: boolean;
|
106
|
-
/**
|
107
|
-
* Ref to the arrow element
|
108
|
-
*/
|
109
|
-
arrowRef?: React.Ref<HTMLDivElement>;
|
110
|
-
/**
|
111
|
-
* CSS class for the arrow element
|
112
|
-
*/
|
113
|
-
arrowClassName?: string;
|
114
|
-
};
|
@@ -1,12 +0,0 @@
|
|
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;
|
@@ -1,10 +0,0 @@
|
|
1
|
-
import type { TooltipProps, TooltipState } from './Tooltip.types';
|
2
|
-
/**
|
3
|
-
* Create the state required to render Tooltip.
|
4
|
-
*
|
5
|
-
* The returned state can be modified with hooks such as useTooltipStyles_unstable,
|
6
|
-
* before being passed to renderTooltip_unstable.
|
7
|
-
*
|
8
|
-
* @param props - props from this instance of Tooltip
|
9
|
-
*/
|
10
|
-
export declare const useTooltip_unstable: (props: TooltipProps) => TooltipState;
|
@@ -1,11 +0,0 @@
|
|
1
|
-
import type { TooltipSlots, TooltipState } from './Tooltip.types';
|
2
|
-
import type { SlotClassNames } from '@fluentui/react-utilities';
|
3
|
-
/**
|
4
|
-
* @deprecated Use `tooltipClassNames.root` instead.
|
5
|
-
*/
|
6
|
-
export declare const tooltipClassName = "fui-Tooltip";
|
7
|
-
export declare const tooltipClassNames: SlotClassNames<TooltipSlots>;
|
8
|
-
/**
|
9
|
-
* Apply styling to the Tooltip slots based on the state
|
10
|
-
*/
|
11
|
-
export declare const useTooltipStyles_unstable: (state: TooltipState) => TooltipState;
|
package/lib/index.d.ts
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
export * from './components/Tooltip/index';
|
@@ -1,7 +0,0 @@
|
|
1
|
-
import * as React from 'react';
|
2
|
-
import type { TooltipProps } from './Tooltip.types';
|
3
|
-
import type { FluentTriggerComponent } from '@fluentui/react-utilities';
|
4
|
-
/**
|
5
|
-
* A tooltip provides light weight contextual information on top of its target element.
|
6
|
-
*/
|
7
|
-
export declare const Tooltip: React.FC<TooltipProps> & FluentTriggerComponent;
|
@@ -1,114 +0,0 @@
|
|
1
|
-
import * as React from 'react';
|
2
|
-
import type { PositioningShorthand } from '@fluentui/react-positioning';
|
3
|
-
import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
|
4
|
-
import type { PortalProps } from '@fluentui/react-portal';
|
5
|
-
/**
|
6
|
-
* Slot properties for Tooltip
|
7
|
-
*/
|
8
|
-
export declare type TooltipSlots = {
|
9
|
-
/**
|
10
|
-
* The text or JSX content of the tooltip.
|
11
|
-
*/
|
12
|
-
content: NonNullable<Slot<'div'>>;
|
13
|
-
};
|
14
|
-
/**
|
15
|
-
* The properties that are added to the trigger of the Tooltip
|
16
|
-
*/
|
17
|
-
export declare type TooltipTriggerProps = {
|
18
|
-
ref?: React.Ref<never>;
|
19
|
-
} & Pick<React.HTMLAttributes<HTMLElement>, 'aria-describedby' | 'aria-label' | 'aria-labelledby' | 'onBlur' | 'onFocus' | 'onPointerEnter' | 'onPointerLeave'>;
|
20
|
-
/**
|
21
|
-
* Data for the Tooltip's onVisibleChange event.
|
22
|
-
*/
|
23
|
-
export declare type OnVisibleChangeData = {
|
24
|
-
visible: boolean;
|
25
|
-
};
|
26
|
-
/**
|
27
|
-
* Properties for Tooltip
|
28
|
-
*/
|
29
|
-
export declare type TooltipProps = ComponentProps<TooltipSlots> & Pick<PortalProps, 'mountNode'> & {
|
30
|
-
/**
|
31
|
-
* The tooltip's visual appearance.
|
32
|
-
* * `normal` - Uses the theme's background and text colors.
|
33
|
-
* * `inverted` - Higher contrast variant that uses the theme's inverted colors.
|
34
|
-
*
|
35
|
-
* @default normal
|
36
|
-
*/
|
37
|
-
appearance?: 'normal' | 'inverted';
|
38
|
-
/**
|
39
|
-
* The tooltip can have a single JSX child, or a render function that accepts TooltipTriggerProps.
|
40
|
-
*
|
41
|
-
* If no child is provided, the tooltip's target must be set with the `positioning` prop, and its
|
42
|
-
* visibility must be controlled with the `visible` prop.
|
43
|
-
*/
|
44
|
-
children?: (React.ReactElement & {
|
45
|
-
ref?: React.Ref<unknown>;
|
46
|
-
}) | ((props: TooltipTriggerProps) => React.ReactElement | null) | null;
|
47
|
-
/**
|
48
|
-
* Delay before the tooltip is hidden, in milliseconds.
|
49
|
-
*
|
50
|
-
* @default 250
|
51
|
-
*/
|
52
|
-
hideDelay?: number;
|
53
|
-
/**
|
54
|
-
* Notification when the visibility of the tooltip is changing
|
55
|
-
*/
|
56
|
-
onVisibleChange?: (event: React.PointerEvent<HTMLElement> | React.FocusEvent<HTMLElement> | undefined, data: OnVisibleChangeData) => void;
|
57
|
-
/**
|
58
|
-
* Configure the positioning of the tooltip
|
59
|
-
*
|
60
|
-
* @default above
|
61
|
-
*/
|
62
|
-
positioning?: PositioningShorthand;
|
63
|
-
/**
|
64
|
-
* (Required) Specifies whether this tooltip is acting as the description or label of its trigger element.
|
65
|
-
*
|
66
|
-
* * `label` - The tooltip sets the trigger's aria-label or aria-labelledby attribute. This is useful for buttons
|
67
|
-
* displaying only an icon, for example.
|
68
|
-
* * `description` - The tooltip sets the trigger's aria-description or aria-describedby attribute.
|
69
|
-
* * `inaccessible` - No aria attributes are set on the trigger. This makes the tooltip's content inaccessible to
|
70
|
-
* screen readers, and should only be used if the tooltip's text is available by some other means.
|
71
|
-
*/
|
72
|
-
relationship: 'label' | 'description' | 'inaccessible';
|
73
|
-
/**
|
74
|
-
* Delay before the tooltip is shown, in milliseconds.
|
75
|
-
*
|
76
|
-
* @default 250
|
77
|
-
*/
|
78
|
-
showDelay?: number;
|
79
|
-
/**
|
80
|
-
* Control the tooltip's visibility programatically.
|
81
|
-
*
|
82
|
-
* This can be used in conjunction with onVisibleChange to modify the tooltip's show and hide behavior.
|
83
|
-
*
|
84
|
-
* If not provided, the visibility will be controlled by the tooltip itself, based on hover and focus events on the
|
85
|
-
* trigger (child) element.
|
86
|
-
*
|
87
|
-
* @default false
|
88
|
-
*/
|
89
|
-
visible?: boolean;
|
90
|
-
/**
|
91
|
-
* Render an arrow pointing to the target element
|
92
|
-
*
|
93
|
-
* @default false
|
94
|
-
*/
|
95
|
-
withArrow?: boolean;
|
96
|
-
};
|
97
|
-
/**
|
98
|
-
* State used in rendering Tooltip
|
99
|
-
*/
|
100
|
-
export declare type TooltipState = ComponentState<TooltipSlots> & Pick<TooltipProps, 'mountNode' | 'relationship'> & Required<Pick<TooltipProps, 'appearance' | 'hideDelay' | 'positioning' | 'showDelay' | 'visible' | 'withArrow'>> & {
|
101
|
-
children?: React.ReactElement | null;
|
102
|
-
/**
|
103
|
-
* Whether the tooltip should be rendered to the DOM.
|
104
|
-
*/
|
105
|
-
shouldRenderTooltip?: boolean;
|
106
|
-
/**
|
107
|
-
* Ref to the arrow element
|
108
|
-
*/
|
109
|
-
arrowRef?: React.Ref<HTMLDivElement>;
|
110
|
-
/**
|
111
|
-
* CSS class for the arrow element
|
112
|
-
*/
|
113
|
-
arrowClassName?: string;
|
114
|
-
};
|
@@ -1,12 +0,0 @@
|
|
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;
|
@@ -1,10 +0,0 @@
|
|
1
|
-
import type { TooltipProps, TooltipState } from './Tooltip.types';
|
2
|
-
/**
|
3
|
-
* Create the state required to render Tooltip.
|
4
|
-
*
|
5
|
-
* The returned state can be modified with hooks such as useTooltipStyles_unstable,
|
6
|
-
* before being passed to renderTooltip_unstable.
|
7
|
-
*
|
8
|
-
* @param props - props from this instance of Tooltip
|
9
|
-
*/
|
10
|
-
export declare const useTooltip_unstable: (props: TooltipProps) => TooltipState;
|
@@ -1,11 +0,0 @@
|
|
1
|
-
import type { TooltipSlots, TooltipState } from './Tooltip.types';
|
2
|
-
import type { SlotClassNames } from '@fluentui/react-utilities';
|
3
|
-
/**
|
4
|
-
* @deprecated Use `tooltipClassNames.root` instead.
|
5
|
-
*/
|
6
|
-
export declare const tooltipClassName = "fui-Tooltip";
|
7
|
-
export declare const tooltipClassNames: SlotClassNames<TooltipSlots>;
|
8
|
-
/**
|
9
|
-
* Apply styling to the Tooltip slots based on the state
|
10
|
-
*/
|
11
|
-
export declare const useTooltipStyles_unstable: (state: TooltipState) => TooltipState;
|
package/lib-commonjs/index.d.ts
DELETED