Skip to content

Fix TooltipTrigger with DialogTrigger #5526

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
merged 4 commits into from
Dec 7, 2023
Merged

Fix TooltipTrigger with DialogTrigger #5526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e9f6df
fix tooltip trigger
devongovett Dec 1, 2023
1acc643
add story and fix test
devongovett Dec 5, 2023
f18f73a
Merge branch 'main' into tooltip-press
snowystinger Dec 6, 2023
e6b2522
Merge branch 'main' into tooltip-press
devongovett Dec 7, 2023
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
13 changes: 7 additions & 6 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 @@ -10,8 +10,8 @@
* governing permissions and limitations under the License.
*/

import {DOMAttributes, FocusableElement, FocusEvents} from '@react-types/shared';
import {getInteractionModality, HoverProps, isFocusVisible, PressProps, useHover, usePress} from '@react-aria/interactions';
import {DOMAttributes, FocusableElement} from '@react-types/shared';
import {getInteractionModality, isFocusVisible, useHover} from '@react-aria/interactions';
import {mergeProps, useId} from '@react-aria/utils';
import {RefObject, useEffect, useRef} from 'react';
import {TooltipTriggerProps} from '@react-types/tooltip';
Expand All @@ -22,7 +22,7 @@ export interface TooltipTriggerAria {
/**
* Props for the trigger element.
*/
triggerProps: DOMAttributes & PressProps & HoverProps & FocusEvents,
triggerProps: DOMAttributes,

/**
* Props for the overlay container element.
Expand Down Expand Up @@ -129,8 +129,6 @@ export function useTooltipTrigger(props: TooltipTriggerProps, state: TooltipTrig
onHoverEnd
});

let {pressProps} = usePress({onPressStart});

let {focusableProps} = useFocusable({
isDisabled,
onFocus,
Expand All @@ -140,7 +138,10 @@ export function useTooltipTrigger(props: TooltipTriggerProps, state: TooltipTrig
return {
triggerProps: {
'aria-describedby': state.isOpen ? tooltipId : undefined,
...mergeProps(focusableProps, hoverProps, pressProps)
...mergeProps(focusableProps, hoverProps, {
onPointerDown: onPressStart,
onKeyDown: onPressStart
})
},
tooltipProps: {
id: tooltipId
Expand Down
54 changes: 53 additions & 1 deletion packages/@react-spectrum/dialog/stories/DialogTrigger.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,9 +473,61 @@ export const WithTooltip = () => (
);

WithTooltip.story = {
name: 'withTooltip'
name: 'with tooltip inside'
};

export const WithTooltipTrigger = () => (
<Flex direction="row" gap={10}>
<DialogTrigger>
<ActionButton>DialogTrigger only</ActionButton>
{close => <CustomDialog close={close} />}
</DialogTrigger>

<TooltipTrigger>
<ActionButton>TooltipTrigger only</ActionButton>
<Tooltip>This is a tooltip</Tooltip>
</TooltipTrigger>

<TooltipTrigger>
<ActionButton isDisabled>TooltipTrigger only</ActionButton>
<Tooltip>This is a tooltip</Tooltip>
</TooltipTrigger>

<DialogTrigger>
<TooltipTrigger>
<ActionButton>DialogTrigger + TooltipTrigger</ActionButton>
<Tooltip>This is a tooltip</Tooltip>
</TooltipTrigger>
{close => <CustomDialog close={close} />}
</DialogTrigger>

<DialogTrigger>
<TooltipTrigger>
<ActionButton isDisabled>DialogTrigger + TooltipTrigger</ActionButton>
<Tooltip>This is a tooltip</Tooltip>
</TooltipTrigger>
{close => <CustomDialog close={close} />}
</DialogTrigger>
</Flex>
);

WithTooltipTrigger.story = {
name: 'with tooltip wrapper'
};

function CustomDialog({close}) {
return (
<Dialog>
<Content>
Dialog content
</Content>
<ButtonGroup>
<Button variant="cta" onPress={close}>Close</Button>
</ButtonGroup>
</Dialog>
);
}

export const WithTranslations = () => <TranslateDialog />;

WithTranslations.story = {
Expand Down
4 changes: 2 additions & 2 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 @@ -10,7 +10,7 @@
* governing permissions and limitations under the License.
*/

import {act, fireEvent, pointerMap, render, triggerPress} from '@react-spectrum/test-utils';
import {act, fireEvent, pointerMap, render} from '@react-spectrum/test-utils';
import {ActionButton} from '@react-spectrum/button';
import {Provider} from '@react-spectrum/provider';
import React from 'react';
Expand Down Expand Up @@ -282,7 +282,7 @@ describe('TooltipTrigger', function () {
expect(onOpenChange).toHaveBeenCalledWith(true);
let tooltip = getByRole('tooltip');
expect(tooltip).toBeVisible();
triggerPress(button);
await user.click(button);
expect(onOpenChange).toHaveBeenCalledWith(false);
act(() => {
jest.advanceTimersByTime(CLOSE_TIME);
Expand Down