Skip to content

Update Tooltip docs to reflect correct default placement value #6721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yihuiliao merged 5 commits into from
Jul 17, 2024
Merged

Update Tooltip docs to reflect correct default placement value #6721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
38689a0
Update Tooltip docs to reflect correct default placement value
yihuiliao Jul 17, 2024
7224599
override placement
yihuiliao Jul 17, 2024
8e829c4
Update packages/@react-types/tooltip/src/index.d.ts
yihuiliao Jul 17, 2024
a3ee438
Update packages/react-aria-components/src/Tooltip.tsx
yihuiliao Jul 17, 2024
7a02e2a
Merge branch 'main' into update-placement-docs
yihuiliao Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/@react-types/tooltip/src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*/

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

export interface TooltipTriggerProps extends OverlayTriggerProps {
Expand Down Expand Up @@ -46,7 +46,12 @@ export interface SpectrumTooltipTriggerProps extends Omit<TooltipTriggerProps, '
* anchor element.
* @default 7
*/
offset?: number
offset?: number,
/**
* The placement of the tooltip with respect to the trigger.
* @default 'top'
*/
placement?: Placement
}

export interface TooltipProps {
Expand Down
9 changes: 7 additions & 2 deletions packages/react-aria-components/src/Tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*/

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

export interface TooltipRenderProps {
Expand Down