Skip to content

chore: rename closeOnPress to shouldCloseOnPress #9337

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
devongovett merged 3 commits into from
Dec 11, 2025
+14 −14
Merged

chore: rename closeOnPress to shouldCloseOnPress #9337

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a2fb517
chore: rename closeOnPress to shouldCloseOnPress
yihuiliao Dec 11, 2025
4c4b038
fix test
yihuiliao Dec 11, 2025
02f268a
update doc example
LFDanLu Dec 11, 2025
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
6 changes: 3 additions & 3 deletions packages/@react-aria/tooltip/src/useTooltipTrigger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export function useTooltipTrigger(props: TooltipTriggerProps, state: TooltipTrig
let {
isDisabled,
trigger,
closeOnPress = true
shouldCloseOnPress = true
} = props;

let tooltipId = useId();
Expand Down Expand Up @@ -103,8 +103,8 @@ export function useTooltipTrigger(props: TooltipTriggerProps, state: TooltipTrig
};

let onPressStart = () => {
// if closeOnPress is false, we should not close the tooltip
if (!closeOnPress) {
// if shouldCloseOnPress is false, we should not close the tooltip
if (!shouldCloseOnPress) {
return;
}
// no matter how the trigger is pressed, we should close the tooltip
Expand Down
6 changes: 3 additions & 3 deletions packages/@react-spectrum/tooltip/src/TooltipTrigger.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {useTooltipTriggerState} from '@react-stately/tooltip';

const DEFAULT_OFFSET = -1; // Offset needed to reach 4px/5px (med/large) distance between tooltip and trigger button
const DEFAULT_CROSS_OFFSET = 0;
const DEFAULT_CLOSE_ON_PRESS = true; // Whether the tooltip should close when the trigger is pressed
const DEFAULT_SHOULD_CLOSE_ON_PRESS = true; // Whether the tooltip should close when the trigger is pressed

function TooltipTrigger(props: SpectrumTooltipTriggerProps) {
let {
Expand All @@ -31,7 +31,7 @@ function TooltipTrigger(props: SpectrumTooltipTriggerProps) {
isDisabled,
offset = DEFAULT_OFFSET,
trigger: triggerAction,
closeOnPress = DEFAULT_CLOSE_ON_PRESS
shouldCloseOnPress = DEFAULT_SHOULD_CLOSE_ON_PRESS
} = props;

let [trigger, tooltip] = React.Children.toArray(children) as [ReactElement, ReactElement];
Expand All @@ -43,7 +43,7 @@ function TooltipTrigger(props: SpectrumTooltipTriggerProps) {
let {triggerProps, tooltipProps} = useTooltipTrigger({
isDisabled,
trigger: triggerAction,
closeOnPress
shouldCloseOnPress
}, state, tooltipTriggerRef);

let [borderRadius, setBorderRadius] = useState(0);
Expand Down
4 changes: 2 additions & 2 deletions packages/@react-spectrum/tooltip/stories/TooltipTrigger.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ const argTypes = {
children: {
control: {disable: true}
},
closeOnPress: {
shouldCloseOnPress: {
control: 'boolean'
}
};
Expand Down Expand Up @@ -117,7 +117,7 @@ export default {
<Tooltip>Change Name</Tooltip>
],
onOpenChange: action('openChange'),
closeOnPress: true
shouldCloseOnPress: true
},
argTypes: argTypes
} as Meta<typeof TooltipTrigger>;
Expand Down
8 changes: 4 additions & 4 deletions packages/@react-spectrum/tooltip/test/TooltipTrigger.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,10 +330,10 @@ describe('TooltipTrigger', function () {
expect(queryByRole('tooltip')).toBeNull();
});

it('does not close if the trigger is clicked when closeOnPress is false', async () => {
it('does not close if the trigger is clicked when shouldCloseOnPress is false', async () => {
let {getByRole, getByLabelText} = render(
<Provider theme={theme}>
<TooltipTrigger onOpenChange={onOpenChange} delay={0} closeOnPress={false}>
<TooltipTrigger onOpenChange={onOpenChange} delay={0} shouldCloseOnPress={false}>
<ActionButton aria-label="trigger" />
<Tooltip>Helpful information.</Tooltip>
</TooltipTrigger>
Expand All @@ -351,10 +351,10 @@ describe('TooltipTrigger', function () {
expect(tooltip).toBeVisible();
});

it('does not close if the trigger is clicked with the keyboard when closeOnPress is false', async () => {
it('does not close if the trigger is clicked with the keyboard when shouldCloseOnPress is false', async () => {
let {getByRole, getByLabelText} = render(
<Provider theme={theme}>
<TooltipTrigger onOpenChange={onOpenChange} delay={0} closeOnPress={false}>
<TooltipTrigger onOpenChange={onOpenChange} delay={0} shouldCloseOnPress={false}>
<ActionButton aria-label="trigger" />
<Tooltip>Helpful information.</Tooltip>
</TooltipTrigger>
Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -42,7 +42,7 @@ export interface TooltipTriggerProps extends OverlayTriggerProps {
* Whether the tooltip should close when the trigger is pressed.
* @default true
*/
closeOnPress?: boolean
shouldCloseOnPress?: boolean
}

export interface SpectrumTooltipTriggerProps extends Omit<TooltipTriggerProps, 'closeDelay'>, PositionProps {
Expand Down