Skip to content

Commit a5744be

Browse files
Update Tooltip docs to reflect correct default placement value (#6721)
* Update Tooltip docs to reflect correct default placement value * override placement * Update packages/@react-types/tooltip/src/index.d.ts Co-authored-by: Devon Govett <[email protected]> * Update packages/react-aria-components/src/Tooltip.tsx Co-authored-by: Devon Govett <[email protected]> --------- Co-authored-by: Devon Govett <[email protected]>
1 parent b3cea47 commit a5744be

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

packages/@react-types/tooltip/src/index.d.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
*/
1212

1313
import {AriaLabelingProps, DOMProps, StyleProps} from '@react-types/shared';
14-
import {OverlayTriggerProps, PositionProps} from '@react-types/overlays';
14+
import {OverlayTriggerProps, Placement, PositionProps} from '@react-types/overlays';
1515
import {ReactElement, ReactNode} from 'react';
1616

1717
export interface TooltipTriggerProps extends OverlayTriggerProps {
@@ -46,7 +46,12 @@ export interface SpectrumTooltipTriggerProps extends Omit<TooltipTriggerProps, '
4646
* anchor element.
4747
* @default 7
4848
*/
49-
offset?: number
49+
offset?: number,
50+
/**
51+
* The placement of the tooltip with respect to the trigger.
52+
* @default 'top'
53+
*/
54+
placement?: Placement
5055
}
5156

5257
export interface TooltipProps {

packages/react-aria-components/src/Tooltip.tsx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
*/
1212

1313
import {AriaLabelingProps, FocusableElement, forwardRefType, RefObject} from '@react-types/shared';
14-
import {AriaPositionProps, mergeProps, OverlayContainer, PlacementAxis, PositionProps, useOverlayPosition, useTooltip, useTooltipTrigger} from 'react-aria';
14+
import {AriaPositionProps, mergeProps, OverlayContainer, Placement, PlacementAxis, PositionProps, useOverlayPosition, useTooltip, useTooltipTrigger} from 'react-aria';
1515
import {ContextValue, Provider, RenderProps, useContextProps, useEnterAnimation, useExitAnimation, useRenderProps} from './utils';
1616
import {FocusableProvider} from '@react-aria/focus';
1717
import {OverlayArrowContext} from './OverlayArrow';
@@ -42,7 +42,12 @@ export interface TooltipProps extends PositionProps, Pick<AriaPositionProps, 'ar
4242
* The container element in which the overlay portal will be placed. This may have unknown behavior depending on where it is portalled to.
4343
* @default document.body
4444
*/
45-
UNSTABLE_portalContainer?: Element
45+
UNSTABLE_portalContainer?: Element,
46+
/**
47+
* The placement of the tooltip with respect to the trigger.
48+
* @default 'top'
49+
*/
50+
placement?: Placement
4651
}
4752

4853
export interface TooltipRenderProps {

0 commit comments

Comments
 (0)