Skip to content

Commit be5e3c3

Browse files
docs: mention attribute on deprecation warnings
1 parent 6742563 commit be5e3c3

File tree

8 files changed

+17
-17
lines changed

8 files changed

+17
-17
lines changed

Diff for: docs/docs/examples/provider-wrapper.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Using multiple anchors elements with a single ReactTooltip component.
88

99
:::danger
1010

11-
This has been deprecated. Use the `anchorSelect` tooltip prop instead. [Click here](./anchor-select.mdx) for some examples.
11+
This has been deprecated. Use the `data-tooltip-id` attribute, or the `anchorSelect` prop instead. [Click here](../getting-started.mdx) for more details.
1212

1313
:::
1414

@@ -104,7 +104,7 @@ import 'react-tooltip/dist/react-tooltip.css';
104104

105105
:::danger
106106

107-
Reminder that this has been deprecated. Use the `anchorSelect` tooltip prop instead. [Click here](./anchor-select.mdx) for some examples.
107+
Reminder that this has been deprecated. Use the `data-tooltip-id` attribute, or the `anchorSelect` prop instead. [Click here](../getting-started.mdx) for more details.
108108

109109
:::
110110

Diff for: docs/docs/getting-started.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ yarn add react-tooltip
5151

5252
:::info
5353

54-
If you've been using V5 for a while, you'll notice we've deprecated the `anchorId` prop in favor of the `anchorSelect` prop.
55-
For more info and more complex use cases, check [the examples](./examples/anchor-select.mdx).
54+
If you've been using V5 for a while, you'll notice we've deprecated the `anchorId` prop in favor of the `data-tooltip-it` attribute, or the `anchorSelect` prop.
55+
For more info and more complex use cases using `anchorSelect`, check [the examples](./examples/anchor-select.mdx).
5656

5757
:::
5858

Diff for: docs/docs/options.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ import 'react-tooltip/dist/react-tooltip.css'
104104
| `place` | `string` | no | `top` | `top` `right` `bottom` `left` | Position relative to the anchor element where the tooltip will be rendered (if possible) |
105105
| `offset` | `number` | no | `10` | any `number` | Space between the tooltip element and anchor element (arrow not included in calculation) |
106106
| `id` | `string` | no | | any `string` | The tooltip id. Must be set when using `data-tooltip-id` on the anchor element |
107-
| ~~`anchorId`~~ | ~~`string`~~ | ~~no~~ | | ~~any `string`~~ | ~~The id for the anchor element for the tooltip~~ <br/>**DEPRECATED**<br/>Use `anchorSelect` instead |
107+
| ~~`anchorId`~~ | ~~`string`~~ | ~~no~~ | | ~~any `string`~~ | ~~The id for the anchor element for the tooltip~~ <br/>**DEPRECATED**<br/>Use `data-tooltip-id` or `anchorSelect` instead |
108108
| `anchorSelect` | CSS selector | no | | any valid CSS selector | The selector for the anchor elements. Check [the examples](../examples/anchor-select.mdx) for more details |
109109
| `variant` | `string` | no | `dark` | `dark` `light` `success` `warning` `error` `info` | Change the tooltip style with default presets |
110110
| `wrapper` | HTML tag | no | `div` | `div` `span` `p` ... | Element wrapper for the tooltip container, can be `div`, `span`, `p` or any valid HTML tag |

Diff for: src/components/Tooltip/TooltipTypes.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ export interface ITooltip {
4343
id?: string
4444
variant?: VariantType
4545
/**
46-
* @deprecated Use `anchorSelect` instead.
47-
* See https://react-tooltip.com/docs/examples/anchor-select
46+
* @deprecated Use the `data-tooltip-id` attribute, or the `anchorSelect` prop instead.
47+
* See https://react-tooltip.com/docs/getting-started
4848
*/
4949
anchorId?: string
5050
anchorSelect?: string

Diff for: src/components/TooltipController/TooltipControllerTypes.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ export interface ITooltipController {
2121
id?: string
2222
variant?: VariantType
2323
/**
24-
* @deprecated Use `anchorSelect` instead.
25-
* See https://react-tooltip.com/docs/examples/anchor-select
24+
* @deprecated Use the `data-tooltip-id` attribute, or the `anchorSelect` prop instead.
25+
* See https://react-tooltip.com/docs/getting-started
2626
*/
2727
anchorId?: string
2828
anchorSelect?: string

Diff for: src/components/TooltipProvider/TooltipProvider.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ const DEFAULT_CONTEXT_DATA_WRAPPER: TooltipContextDataWrapper = {
3535
const TooltipContext = createContext<TooltipContextDataWrapper>(DEFAULT_CONTEXT_DATA_WRAPPER)
3636

3737
/**
38-
* @deprecated Use `anchorSelect` instead.
39-
* See https://react-tooltip.com/docs/examples/anchor-select
38+
* @deprecated Use the `data-tooltip-id` attribute, or the `anchorSelect` prop instead.
39+
* See https://react-tooltip.com/docs/getting-started
4040
*/
4141
const TooltipProvider: React.FC<PropsWithChildren> = ({ children }) => {
4242
const [anchorRefMap, setAnchorRefMap] = useState<Record<string, Set<AnchorRef>>>({

Diff for: src/components/TooltipProvider/TooltipProviderTypes.d.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ import type { ReactNode, RefObject } from 'react'
22
import type { ITooltipController } from 'components/TooltipController/TooltipControllerTypes'
33

44
/**
5-
* @deprecated Use `anchorSelect` instead.
6-
* See https://react-tooltip.com/docs/examples/anchor-select
5+
* @deprecated Use the `data-tooltip-id` attribute, or the `anchorSelect` prop instead.
6+
* See https://react-tooltip.com/docs/getting-started
77
*/
88
export type AnchorRef = RefObject<HTMLElement>
99

@@ -20,8 +20,8 @@ export interface TooltipContextDataWrapper {
2020
}
2121

2222
/**
23-
* @deprecated Use `anchorSelect` instead.
24-
* See https://react-tooltip.com/docs/examples/anchor-select
23+
* @deprecated Use the `data-tooltip-id` attribute, or the `anchorSelect` prop instead.
24+
* See https://react-tooltip.com/docs/getting-started
2525
*/
2626
export interface ITooltipWrapper {
2727
tooltipId?: string

Diff for: src/components/TooltipProvider/TooltipWrapper.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import { useTooltip } from './TooltipProvider'
44
import type { ITooltipWrapper } from './TooltipProviderTypes'
55

66
/**
7-
* @deprecated Use `anchorSelect` instead.
8-
* See https://react-tooltip.com/docs/examples/anchor-select
7+
* @deprecated Use the `data-tooltip-id` attribute, or the `anchorSelect` prop instead.
8+
* See https://react-tooltip.com/docs/getting-started
99
*/
1010
const TooltipWrapper = ({
1111
tooltipId,

0 commit comments

Comments
 (0)