@zendeskgarden/react-tooltips 8.69.2 → 8.69.3
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/dist/index.cjs.js +3 -3
- package/dist/index.esm.js +3 -3
- package/dist/typings/elements/Paragraph.d.ts +11 -11
- package/dist/typings/elements/Title.d.ts +11 -11
- package/dist/typings/elements/Tooltip.d.ts +39 -39
- package/dist/typings/index.d.ts +10 -10
- package/dist/typings/styled/StyledParagraph.d.ts +13 -13
- package/dist/typings/styled/StyledTitle.d.ts +13 -13
- package/dist/typings/styled/StyledTooltip.d.ts +18 -18
- package/dist/typings/styled/StyledTooltipWrapper.d.ts +18 -18
- package/dist/typings/styled/index.d.ts +10 -10
- package/dist/typings/types/index.d.ts +46 -46
- package/dist/typings/utils/gardenPlacements.d.ts +22 -22
- package/package.json +3 -3
package/dist/index.cjs.js
CHANGED
|
@@ -79,7 +79,7 @@ function getArrowPosition(popperPlacement) {
|
|
|
79
79
|
const COMPONENT_ID$2 = 'tooltip.paragraph';
|
|
80
80
|
const StyledParagraph = styled__default.default.p.attrs({
|
|
81
81
|
'data-garden-id': COMPONENT_ID$2,
|
|
82
|
-
'data-garden-version': '8.69.
|
|
82
|
+
'data-garden-version': '8.69.3'
|
|
83
83
|
}).withConfig({
|
|
84
84
|
displayName: "StyledParagraph",
|
|
85
85
|
componentId: "sc-wuqkfc-0"
|
|
@@ -91,7 +91,7 @@ StyledParagraph.defaultProps = {
|
|
|
91
91
|
const COMPONENT_ID$1 = 'tooltip.title';
|
|
92
92
|
const StyledTitle = styled__default.default.strong.attrs({
|
|
93
93
|
'data-garden-id': COMPONENT_ID$1,
|
|
94
|
-
'data-garden-version': '8.69.
|
|
94
|
+
'data-garden-version': '8.69.3'
|
|
95
95
|
}).withConfig({
|
|
96
96
|
displayName: "StyledTitle",
|
|
97
97
|
componentId: "sc-vnjcvz-0"
|
|
@@ -188,7 +188,7 @@ const colorStyles = _ref2 => {
|
|
|
188
188
|
};
|
|
189
189
|
const StyledTooltip = styled__default.default.div.attrs({
|
|
190
190
|
'data-garden-id': COMPONENT_ID,
|
|
191
|
-
'data-garden-version': '8.69.
|
|
191
|
+
'data-garden-version': '8.69.3'
|
|
192
192
|
}).withConfig({
|
|
193
193
|
displayName: "StyledTooltip",
|
|
194
194
|
componentId: "sc-gzzjq4-0"
|
package/dist/index.esm.js
CHANGED
|
@@ -70,7 +70,7 @@ function getArrowPosition(popperPlacement) {
|
|
|
70
70
|
const COMPONENT_ID$2 = 'tooltip.paragraph';
|
|
71
71
|
const StyledParagraph = styled.p.attrs({
|
|
72
72
|
'data-garden-id': COMPONENT_ID$2,
|
|
73
|
-
'data-garden-version': '8.69.
|
|
73
|
+
'data-garden-version': '8.69.3'
|
|
74
74
|
}).withConfig({
|
|
75
75
|
displayName: "StyledParagraph",
|
|
76
76
|
componentId: "sc-wuqkfc-0"
|
|
@@ -82,7 +82,7 @@ StyledParagraph.defaultProps = {
|
|
|
82
82
|
const COMPONENT_ID$1 = 'tooltip.title';
|
|
83
83
|
const StyledTitle = styled.strong.attrs({
|
|
84
84
|
'data-garden-id': COMPONENT_ID$1,
|
|
85
|
-
'data-garden-version': '8.69.
|
|
85
|
+
'data-garden-version': '8.69.3'
|
|
86
86
|
}).withConfig({
|
|
87
87
|
displayName: "StyledTitle",
|
|
88
88
|
componentId: "sc-vnjcvz-0"
|
|
@@ -179,7 +179,7 @@ const colorStyles = _ref2 => {
|
|
|
179
179
|
};
|
|
180
180
|
const StyledTooltip = styled.div.attrs({
|
|
181
181
|
'data-garden-id': COMPONENT_ID,
|
|
182
|
-
'data-garden-version': '8.69.
|
|
182
|
+
'data-garden-version': '8.69.3'
|
|
183
183
|
}).withConfig({
|
|
184
184
|
displayName: "StyledTooltip",
|
|
185
185
|
componentId: "sc-gzzjq4-0"
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
import React from 'react';
|
|
8
|
-
/**
|
|
9
|
-
* @extends HTMLAttributes<HTMLParagraphElement>
|
|
10
|
-
*/
|
|
11
|
-
export declare const Paragraph: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLParagraphElement> & React.RefAttributes<HTMLParagraphElement>>;
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
import React from 'react';
|
|
8
|
+
/**
|
|
9
|
+
* @extends HTMLAttributes<HTMLParagraphElement>
|
|
10
|
+
*/
|
|
11
|
+
export declare const Paragraph: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLParagraphElement> & React.RefAttributes<HTMLParagraphElement>>;
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
import React from 'react';
|
|
8
|
-
/**
|
|
9
|
-
* @extends HTMLAttributes<HTMLDivElement>
|
|
10
|
-
*/
|
|
11
|
-
export declare const Title: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
import React from 'react';
|
|
8
|
+
/**
|
|
9
|
+
* @extends HTMLAttributes<HTMLDivElement>
|
|
10
|
+
*/
|
|
11
|
+
export declare const Title: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
|
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
import React from 'react';
|
|
8
|
-
import PropTypes from 'prop-types';
|
|
9
|
-
import { ITooltipProps } from '../types';
|
|
10
|
-
/**
|
|
11
|
-
* @extends HTMLAttributes<HTMLDivElement>
|
|
12
|
-
*/
|
|
13
|
-
export declare const Tooltip: {
|
|
14
|
-
({ id, delayMS, isInitialVisible, content, refKey, placement, eventsEnabled, popperModifiers, children, hasArrow, size, type, appendToNode, zIndex, isVisible: externalIsVisible, ...otherProps }: ITooltipProps): React.JSX.Element;
|
|
15
|
-
displayName: string;
|
|
16
|
-
propTypes: {
|
|
17
|
-
appendToNode: PropTypes.Requireable<any>;
|
|
18
|
-
hasArrow: PropTypes.Requireable<boolean>;
|
|
19
|
-
delayMS: PropTypes.Requireable<number>;
|
|
20
|
-
eventsEnabled: PropTypes.Requireable<boolean>;
|
|
21
|
-
id: PropTypes.Requireable<string>;
|
|
22
|
-
content: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
|
|
23
|
-
placement: PropTypes.Requireable<"auto" | "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "end" | "end-top" | "end-bottom" | "start" | "start-top" | "start-bottom">;
|
|
24
|
-
popperModifiers: PropTypes.Requireable<any>;
|
|
25
|
-
size: PropTypes.Requireable<"small" | "medium" | "large" | "extra-large">;
|
|
26
|
-
type: PropTypes.Requireable<"light" | "dark">;
|
|
27
|
-
zIndex: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
|
|
28
|
-
isInitialVisible: PropTypes.Requireable<boolean>;
|
|
29
|
-
refKey: PropTypes.Requireable<string>;
|
|
30
|
-
};
|
|
31
|
-
defaultProps: {
|
|
32
|
-
hasArrow: boolean;
|
|
33
|
-
eventsEnabled: boolean;
|
|
34
|
-
type: string;
|
|
35
|
-
placement: string;
|
|
36
|
-
delayMS: number;
|
|
37
|
-
refKey: string;
|
|
38
|
-
};
|
|
39
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
import React from 'react';
|
|
8
|
+
import PropTypes from 'prop-types';
|
|
9
|
+
import { ITooltipProps } from '../types';
|
|
10
|
+
/**
|
|
11
|
+
* @extends HTMLAttributes<HTMLDivElement>
|
|
12
|
+
*/
|
|
13
|
+
export declare const Tooltip: {
|
|
14
|
+
({ id, delayMS, isInitialVisible, content, refKey, placement, eventsEnabled, popperModifiers, children, hasArrow, size, type, appendToNode, zIndex, isVisible: externalIsVisible, ...otherProps }: ITooltipProps): React.JSX.Element;
|
|
15
|
+
displayName: string;
|
|
16
|
+
propTypes: {
|
|
17
|
+
appendToNode: PropTypes.Requireable<any>;
|
|
18
|
+
hasArrow: PropTypes.Requireable<boolean>;
|
|
19
|
+
delayMS: PropTypes.Requireable<number>;
|
|
20
|
+
eventsEnabled: PropTypes.Requireable<boolean>;
|
|
21
|
+
id: PropTypes.Requireable<string>;
|
|
22
|
+
content: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
|
|
23
|
+
placement: PropTypes.Requireable<"auto" | "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "end" | "end-top" | "end-bottom" | "start" | "start-top" | "start-bottom">;
|
|
24
|
+
popperModifiers: PropTypes.Requireable<any>;
|
|
25
|
+
size: PropTypes.Requireable<"small" | "medium" | "large" | "extra-large">;
|
|
26
|
+
type: PropTypes.Requireable<"light" | "dark">;
|
|
27
|
+
zIndex: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
|
|
28
|
+
isInitialVisible: PropTypes.Requireable<boolean>;
|
|
29
|
+
refKey: PropTypes.Requireable<string>;
|
|
30
|
+
};
|
|
31
|
+
defaultProps: {
|
|
32
|
+
hasArrow: boolean;
|
|
33
|
+
eventsEnabled: boolean;
|
|
34
|
+
type: string;
|
|
35
|
+
placement: string;
|
|
36
|
+
delayMS: number;
|
|
37
|
+
refKey: string;
|
|
38
|
+
};
|
|
39
|
+
};
|
package/dist/typings/index.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
export { Tooltip } from './elements/Tooltip';
|
|
8
|
-
export { Paragraph } from './elements/Paragraph';
|
|
9
|
-
export { Title } from './elements/Title';
|
|
10
|
-
export type { ITooltipProps } from './types';
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
export { Tooltip } from './elements/Tooltip';
|
|
8
|
+
export { Paragraph } from './elements/Paragraph';
|
|
9
|
+
export { Title } from './elements/Title';
|
|
10
|
+
export type { ITooltipProps } from './types';
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
/**
|
|
8
|
-
* Accepts all `<p>` props
|
|
9
|
-
*/
|
|
10
|
-
export declare const StyledParagraph: import("styled-components").StyledComponent<"p", import("styled-components").DefaultTheme, {
|
|
11
|
-
'data-garden-id': string;
|
|
12
|
-
'data-garden-version': string;
|
|
13
|
-
}, "data-garden-id" | "data-garden-version">;
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Accepts all `<p>` props
|
|
9
|
+
*/
|
|
10
|
+
export declare const StyledParagraph: import("styled-components").StyledComponent<"p", import("styled-components").DefaultTheme, {
|
|
11
|
+
'data-garden-id': string;
|
|
12
|
+
'data-garden-version': string;
|
|
13
|
+
}, "data-garden-id" | "data-garden-version">;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
/**
|
|
8
|
-
* Accepts all `<div>` props
|
|
9
|
-
*/
|
|
10
|
-
export declare const StyledTitle: import("styled-components").StyledComponent<"strong", import("styled-components").DefaultTheme, {
|
|
11
|
-
'data-garden-id': string;
|
|
12
|
-
'data-garden-version': string;
|
|
13
|
-
}, "data-garden-id" | "data-garden-version">;
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Accepts all `<div>` props
|
|
9
|
+
*/
|
|
10
|
+
export declare const StyledTitle: import("styled-components").StyledComponent<"strong", import("styled-components").DefaultTheme, {
|
|
11
|
+
'data-garden-id': string;
|
|
12
|
+
'data-garden-version': string;
|
|
13
|
+
}, "data-garden-id" | "data-garden-version">;
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
import { DefaultTheme } from 'styled-components';
|
|
8
|
-
import { ITooltipProps, POPPER_PLACEMENT } from '../types';
|
|
9
|
-
interface IStyledTooltipProps extends Pick<ITooltipProps, 'hasArrow' | 'size' | 'zIndex'> {
|
|
10
|
-
/** All valid [Popper.JS Placements](https://popper.js.org/popper-documentation.html#Popper.placements) */
|
|
11
|
-
placement: (typeof POPPER_PLACEMENT)[number];
|
|
12
|
-
type: NonNullable<ITooltipProps['type']>;
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* Accepts all `<div>` props
|
|
16
|
-
*/
|
|
17
|
-
export declare const StyledTooltip: import("styled-components").StyledComponent<"div", DefaultTheme, IStyledTooltipProps, never>;
|
|
18
|
-
export {};
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
import { DefaultTheme } from 'styled-components';
|
|
8
|
+
import { ITooltipProps, POPPER_PLACEMENT } from '../types';
|
|
9
|
+
interface IStyledTooltipProps extends Pick<ITooltipProps, 'hasArrow' | 'size' | 'zIndex'> {
|
|
10
|
+
/** All valid [Popper.JS Placements](https://popper.js.org/popper-documentation.html#Popper.placements) */
|
|
11
|
+
placement: (typeof POPPER_PLACEMENT)[number];
|
|
12
|
+
type: NonNullable<ITooltipProps['type']>;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Accepts all `<div>` props
|
|
16
|
+
*/
|
|
17
|
+
export declare const StyledTooltip: import("styled-components").StyledComponent<"div", DefaultTheme, IStyledTooltipProps, never>;
|
|
18
|
+
export {};
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
/**
|
|
8
|
-
* This wrapper allows the StyledTooltip to retain it's relative positioning.
|
|
9
|
-
* Without this container Popper would apply absolute positioning directly to
|
|
10
|
-
* the StyledTooltip which impacts arrow styling.
|
|
11
|
-
*
|
|
12
|
-
* 1. This wrapper also includes an opacity transition. It allows Popper to
|
|
13
|
-
* reposition the tooltip without having a visible shift. The transition
|
|
14
|
-
* is fast enough that it should not be perceptible.
|
|
15
|
-
*/
|
|
16
|
-
export declare const StyledTooltipWrapper: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {
|
|
17
|
-
zIndex?: string | number | undefined;
|
|
18
|
-
}, never>;
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* This wrapper allows the StyledTooltip to retain it's relative positioning.
|
|
9
|
+
* Without this container Popper would apply absolute positioning directly to
|
|
10
|
+
* the StyledTooltip which impacts arrow styling.
|
|
11
|
+
*
|
|
12
|
+
* 1. This wrapper also includes an opacity transition. It allows Popper to
|
|
13
|
+
* reposition the tooltip without having a visible shift. The transition
|
|
14
|
+
* is fast enough that it should not be perceptible.
|
|
15
|
+
*/
|
|
16
|
+
export declare const StyledTooltipWrapper: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {
|
|
17
|
+
zIndex?: string | number | undefined;
|
|
18
|
+
}, never>;
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
export { StyledParagraph } from './StyledParagraph';
|
|
8
|
-
export { StyledTitle } from './StyledTitle';
|
|
9
|
-
export { StyledTooltip } from './StyledTooltip';
|
|
10
|
-
export { StyledTooltipWrapper } from './StyledTooltipWrapper';
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
export { StyledParagraph } from './StyledParagraph';
|
|
8
|
+
export { StyledTitle } from './StyledTitle';
|
|
9
|
+
export { StyledTooltip } from './StyledTooltip';
|
|
10
|
+
export { StyledTooltipWrapper } from './StyledTooltipWrapper';
|
|
@@ -1,46 +1,46 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
import { HTMLAttributes, ReactElement, ReactNode } from 'react';
|
|
8
|
-
import { Modifiers } from 'popper.js';
|
|
9
|
-
export declare const PLACEMENT: readonly ["auto", "top", "top-start", "top-end", "bottom", "bottom-start", "bottom-end", "end", "end-top", "end-bottom", "start", "start-top", "start-bottom"];
|
|
10
|
-
export declare const POPPER_PLACEMENT: readonly ["auto", "top", "top-start", "top-end", "bottom", "bottom-start", "bottom-end", "right", "right-start", "right-end", "left", "left-start", "left-end"];
|
|
11
|
-
export declare const SIZE: readonly ["small", "medium", "large", "extra-large"];
|
|
12
|
-
export declare const TYPE: readonly ["light", "dark"];
|
|
13
|
-
export type GardenPlacement = (typeof PLACEMENT)[number];
|
|
14
|
-
export type PopperPlacement = (typeof POPPER_PLACEMENT)[number];
|
|
15
|
-
export interface ITooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'content'> {
|
|
16
|
-
/** Appends the tooltip to the element provided */
|
|
17
|
-
appendToNode?: Element;
|
|
18
|
-
/** Adds an arrow to the tooltip */
|
|
19
|
-
hasArrow?: boolean;
|
|
20
|
-
/** Adds milliseconds of delay to the opening and closing of the tooltip */
|
|
21
|
-
delayMS?: number;
|
|
22
|
-
/** Allows the tooltip to reposition during browser resize events */
|
|
23
|
-
eventsEnabled?: boolean;
|
|
24
|
-
/** Defines the content of the tooltip */
|
|
25
|
-
content: ReactNode;
|
|
26
|
-
/**
|
|
27
|
-
* Adjusts the placement of the tooltip
|
|
28
|
-
**/
|
|
29
|
-
placement?: GardenPlacement;
|
|
30
|
-
/** Passes configurations to the [Popper instance](https://popper.js.org/docs/v2/modifiers/) */
|
|
31
|
-
popperModifiers?: Modifiers;
|
|
32
|
-
/** Adjusts the padding and font size */
|
|
33
|
-
size?: (typeof SIZE)[number];
|
|
34
|
-
/** Specifies the tooltip type */
|
|
35
|
-
type?: (typeof TYPE)[number];
|
|
36
|
-
/** Sets the `z-index` of the tooltip */
|
|
37
|
-
zIndex?: number | string;
|
|
38
|
-
/** Displays the tooltip on initial render */
|
|
39
|
-
isInitialVisible?: boolean;
|
|
40
|
-
/** Displays the tooltip */
|
|
41
|
-
isVisible?: boolean;
|
|
42
|
-
/** @ignore ReactNode override */
|
|
43
|
-
children: ReactElement;
|
|
44
|
-
/** Defines the ref key used to position the tooltip */
|
|
45
|
-
refKey?: string;
|
|
46
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
import { HTMLAttributes, ReactElement, ReactNode } from 'react';
|
|
8
|
+
import { Modifiers } from 'popper.js';
|
|
9
|
+
export declare const PLACEMENT: readonly ["auto", "top", "top-start", "top-end", "bottom", "bottom-start", "bottom-end", "end", "end-top", "end-bottom", "start", "start-top", "start-bottom"];
|
|
10
|
+
export declare const POPPER_PLACEMENT: readonly ["auto", "top", "top-start", "top-end", "bottom", "bottom-start", "bottom-end", "right", "right-start", "right-end", "left", "left-start", "left-end"];
|
|
11
|
+
export declare const SIZE: readonly ["small", "medium", "large", "extra-large"];
|
|
12
|
+
export declare const TYPE: readonly ["light", "dark"];
|
|
13
|
+
export type GardenPlacement = (typeof PLACEMENT)[number];
|
|
14
|
+
export type PopperPlacement = (typeof POPPER_PLACEMENT)[number];
|
|
15
|
+
export interface ITooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'content'> {
|
|
16
|
+
/** Appends the tooltip to the element provided */
|
|
17
|
+
appendToNode?: Element;
|
|
18
|
+
/** Adds an arrow to the tooltip */
|
|
19
|
+
hasArrow?: boolean;
|
|
20
|
+
/** Adds milliseconds of delay to the opening and closing of the tooltip */
|
|
21
|
+
delayMS?: number;
|
|
22
|
+
/** Allows the tooltip to reposition during browser resize events */
|
|
23
|
+
eventsEnabled?: boolean;
|
|
24
|
+
/** Defines the content of the tooltip */
|
|
25
|
+
content: ReactNode;
|
|
26
|
+
/**
|
|
27
|
+
* Adjusts the placement of the tooltip
|
|
28
|
+
**/
|
|
29
|
+
placement?: GardenPlacement;
|
|
30
|
+
/** Passes configurations to the [Popper instance](https://popper.js.org/docs/v2/modifiers/) */
|
|
31
|
+
popperModifiers?: Modifiers;
|
|
32
|
+
/** Adjusts the padding and font size */
|
|
33
|
+
size?: (typeof SIZE)[number];
|
|
34
|
+
/** Specifies the tooltip type */
|
|
35
|
+
type?: (typeof TYPE)[number];
|
|
36
|
+
/** Sets the `z-index` of the tooltip */
|
|
37
|
+
zIndex?: number | string;
|
|
38
|
+
/** Displays the tooltip on initial render */
|
|
39
|
+
isInitialVisible?: boolean;
|
|
40
|
+
/** Displays the tooltip */
|
|
41
|
+
isVisible?: boolean;
|
|
42
|
+
/** @ignore ReactNode override */
|
|
43
|
+
children: ReactElement;
|
|
44
|
+
/** Defines the ref key used to position the tooltip */
|
|
45
|
+
refKey?: string;
|
|
46
|
+
}
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright Zendesk, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
-
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
-
*/
|
|
7
|
-
import { GardenPlacement, PopperPlacement } from '../types';
|
|
8
|
-
/**
|
|
9
|
-
* Convert Garden RTL aware placement to Popper.JS valid placement
|
|
10
|
-
* @param {String} gardenPlacement
|
|
11
|
-
*/
|
|
12
|
-
export declare function getPopperPlacement(gardenPlacement: GardenPlacement): "auto" | "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end";
|
|
13
|
-
/**
|
|
14
|
-
* Convert Garden RTL aware placement to RTL equivalent Popper.JS placement
|
|
15
|
-
* @param {String} gardenPlacement
|
|
16
|
-
*/
|
|
17
|
-
export declare function getRtlPopperPlacement(gardenPlacement: GardenPlacement): "auto" | "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end";
|
|
18
|
-
/**
|
|
19
|
-
* Convert Popper.JS placement to corresponding arrow position
|
|
20
|
-
* @param {String} popperPlacement
|
|
21
|
-
*/
|
|
22
|
-
export declare function getArrowPosition(popperPlacement: PopperPlacement): "top" | "bottom" | "right" | "left" | "top-left" | "top-right" | "right-top" | "right-bottom" | "bottom-left" | "bottom-right" | "left-top" | "left-bottom";
|
|
1
|
+
/**
|
|
2
|
+
* Copyright Zendesk, Inc.
|
|
3
|
+
*
|
|
4
|
+
* Use of this source code is governed under the Apache License, Version 2.0
|
|
5
|
+
* found at http://www.apache.org/licenses/LICENSE-2.0.
|
|
6
|
+
*/
|
|
7
|
+
import { GardenPlacement, PopperPlacement } from '../types';
|
|
8
|
+
/**
|
|
9
|
+
* Convert Garden RTL aware placement to Popper.JS valid placement
|
|
10
|
+
* @param {String} gardenPlacement
|
|
11
|
+
*/
|
|
12
|
+
export declare function getPopperPlacement(gardenPlacement: GardenPlacement): "auto" | "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end";
|
|
13
|
+
/**
|
|
14
|
+
* Convert Garden RTL aware placement to RTL equivalent Popper.JS placement
|
|
15
|
+
* @param {String} gardenPlacement
|
|
16
|
+
*/
|
|
17
|
+
export declare function getRtlPopperPlacement(gardenPlacement: GardenPlacement): "auto" | "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end";
|
|
18
|
+
/**
|
|
19
|
+
* Convert Popper.JS placement to corresponding arrow position
|
|
20
|
+
* @param {String} popperPlacement
|
|
21
|
+
*/
|
|
22
|
+
export declare function getArrowPosition(popperPlacement: PopperPlacement): "top" | "bottom" | "right" | "left" | "top-left" | "top-right" | "right-top" | "right-bottom" | "bottom-left" | "bottom-right" | "left-top" | "left-bottom";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zendeskgarden/react-tooltips",
|
|
3
|
-
"version": "8.69.
|
|
3
|
+
"version": "8.69.3",
|
|
4
4
|
"description": "Collection of components and render prop containers relating to Tooltips in the Garden Design System",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "Zendesk Garden <garden@zendesk.com>",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"styled-components": "^4.2.0 || ^5.0.0"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@zendeskgarden/react-theming": "^8.69.
|
|
38
|
+
"@zendeskgarden/react-theming": "^8.69.3"
|
|
39
39
|
},
|
|
40
40
|
"keywords": [
|
|
41
41
|
"components",
|
|
@@ -47,5 +47,5 @@
|
|
|
47
47
|
"access": "public"
|
|
48
48
|
},
|
|
49
49
|
"zendeskgarden:src": "src/index.ts",
|
|
50
|
-
"gitHead": "
|
|
50
|
+
"gitHead": "c861fbeb70120b66b05d2ce3a26ccf3047659aa0"
|
|
51
51
|
}
|