Using FloatingUI with Tooltips #1311
There are no files selected for viewing
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,58 +4,192 @@ | |
| *--------------------------------------------------------------------------------------------*/ | ||
| import * as React from 'react'; | ||
| import cx from 'classnames'; | ||
| import { | ||
| useMergeRefs, | ||
| useFloating, | ||
| autoUpdate, | ||
| offset, | ||
| flip, | ||
| shift, | ||
| useHover, | ||
| useFocus, | ||
| useDismiss, | ||
| useRole, | ||
| useInteractions, | ||
| useClick, | ||
| FloatingPortal, | ||
| } from '@floating-ui/react'; | ||
| import type { Placement } from '@floating-ui/react'; | ||
| import { Box, type PolymorphicForwardRefComponent } from '../utils/index.js'; | ||
| import { ThemeContext } from '../ThemeProvider/ThemeContext.js'; | ||
| import ReactDOM from 'react-dom'; | ||
|
|
||
| type TooltipOptions = { | ||
| /** | ||
| * Placement of the Tooltip | ||
| * @default 'top' | ||
| */ | ||
| placement?: Placement; | ||
| /** | ||
| * Property for manual visibility control | ||
| */ | ||
| visible?: boolean; | ||
| /** | ||
| * Function that allows users to control Tooltip visibility | ||
| */ | ||
| toggleVisible?: (open: boolean) => void; | ||
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /** | ||
| * Use this if you want Tooltip to follow moving trigger element | ||
| * @default false; | ||
| */ | ||
| followTrigger?: boolean; | ||
| }; | ||
|
|
||
| type TooltipOwnProps = { | ||
| /** | ||
| * Content of the tooltip. | ||
| */ | ||
| content?: React.ReactNode; | ||
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /** | ||
| * Element to have tooltip on. Has to be a valid JSX element and needs to forward its ref. | ||
| * If not specified, the `reference` prop should be used instead. | ||
| */ | ||
| children?: React.ReactNode; | ||
| /** | ||
| * Element to append tooltip to. | ||
| * Appends to ThemeProvider portalContainerRef by default. | ||
| */ | ||
| appendTo?: HTMLElement; | ||
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }; | ||
|
|
||
| const useTooltip = ({ | ||
| placement = 'top', | ||
| visible: controlledOpen, | ||
| toggleVisible: setControlledOpen, | ||
| followTrigger = false, | ||
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }: TooltipOptions = {}) => { | ||
| const [uncontrolledOpen, setUncontrolledOpen] = React.useState(false); | ||
|
|
||
| const open = controlledOpen ?? uncontrolledOpen; | ||
| const setOpen = setControlledOpen ?? setUncontrolledOpen; | ||
|
|
||
| const data = useFloating({ | ||
| placement, | ||
| open, | ||
| onOpenChange: setOpen, | ||
| whileElementsMounted: (referenceEl, floatingEl, update) => | ||
| autoUpdate(referenceEl, floatingEl, update, { | ||
| animationFrame: followTrigger, | ||
| }), | ||
| middleware: [offset(5), flip(), shift()], | ||
|
There was a problem hiding this comment. Allow users to customise middleware? There was a problem hiding this comment. yes. see iTwin/iTwinUI-react#783 and iTwin/iTwinUI-react#947 There was a problem hiding this comment. Maybe adding prop would be ok? middleware?: {
offset?: number;
flip?: boolean;
..etc;
}There was a problem hiding this comment. Yeah, lets control all the names now. Other option would be to allow user to pass any and all middleware, but then they might start doing weird things I also think it should be possible for the user to toggle There was a problem hiding this comment. autoUpdateOptions were added.
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }); | ||
|
|
||
| const context = data.context; | ||
|
|
||
| const hover = useHover(context); | ||
|
There was a problem hiding this comment. Should be allow users to customise interactions? eg. disable tooltip on focus. There was a problem hiding this comment. it would be nice to give control, but i fear that developers will start removing focus as trigger, making tooltips inaccessible There was a problem hiding this comment. Not giving control for now. We can add that later. There was a problem hiding this comment. hover should have some delay and also use There was a problem hiding this comment. also missing controlled There was a problem hiding this comment. Fixed this one. |
||
| const focus = useFocus(context, { | ||
| enabled: controlledOpen == null, | ||
| }); | ||
| const click = useClick(context); | ||
|
|
||
| const dismiss = useDismiss(context); | ||
| const role = useRole(context, { role: 'tooltip' }); | ||
|
|
||
| const interactions = useInteractions([hover, focus, click, dismiss, role]); | ||
|
|
||
| return React.useMemo( | ||
| () => ({ | ||
| open, | ||
| setOpen, | ||
| ...interactions, | ||
| ...data, | ||
| }), | ||
| [open, setOpen, interactions, data], | ||
| ); | ||
| }; | ||
|
|
||
| const TooltipContext = React.createContext< | ||
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| (ReturnType<typeof useTooltip> & TooltipOwnProps) | null | ||
| >(null); | ||
|
|
||
| const useTooltipContext = () => { | ||
| const context = React.useContext(TooltipContext); | ||
|
|
||
| if (context == null) { | ||
| throw new Error('Tooltip components must be wrapped in <Tooltip />'); | ||
| } | ||
|
|
||
| return context; | ||
| }; | ||
|
|
||
| const TooltipComponent = ({ | ||
| content, | ||
| children, | ||
| appendTo, | ||
| ...options | ||
| }: TooltipOwnProps & TooltipOptions) => { | ||
| const tooltip = useTooltip(options); | ||
| return ( | ||
| <TooltipContext.Provider value={{ ...tooltip, appendTo }}> | ||
| <TooltipTrigger>{children}</TooltipTrigger> | ||
| <TooltipContent>{content}</TooltipContent> | ||
| </TooltipContext.Provider> | ||
| ); | ||
| }; | ||
|
|
||
| const TooltipTrigger = React.forwardRef((props, propRef) => { | ||
| const { children, ...rest } = props; | ||
| const context = useTooltipContext(); | ||
| const ref = useMergeRefs([context.refs.setReference, propRef]); | ||
|
|
||
| return React.isValidElement(children) | ||
| ? React.cloneElement( | ||
| children, | ||
| context.getReferenceProps({ | ||
| ref, | ||
| ...rest, | ||
| ...children.props, | ||
| }), | ||
| ) | ||
| : null; | ||
| // eslint-disable-next-line @typescript-eslint/ban-types | ||
| }) as PolymorphicForwardRefComponent<'div', {}>; | ||
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| const TooltipContent = React.forwardRef((props, propRef) => { | ||
| const { children, className, ...rest } = props; | ||
| const context = useTooltipContext(); | ||
| const themeInfo = React.useContext(ThemeContext); | ||
| const ref = useMergeRefs([context.refs.setFloating, propRef]); | ||
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| const contentBox = ( | ||
| <Box | ||
| className={cx('iui-tooltip', className)} | ||
| ref={ref} | ||
| style={context.floatingStyles} | ||
| {...context.getFloatingProps(rest)} | ||
| > | ||
| {children} | ||
| </Box> | ||
| ); | ||
|
|
||
| if (!context.open) { | ||
| return null; | ||
| } | ||
|
|
||
| const portalRoot = context.appendTo ?? themeInfo?.portalContainerRef?.current; | ||
|
|
||
| return portalRoot ? ( | ||
| ReactDOM.createPortal(contentBox, portalRoot) | ||
| ) : ( | ||
| <FloatingPortal>{contentBox}</FloatingPortal> | ||
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ); | ||
| // eslint-disable-next-line @typescript-eslint/ban-types | ||
| }) as PolymorphicForwardRefComponent<'div', {}>; | ||
|
|
||
| /** | ||
| * Basic tooltip component to display informative content when an element is hovered or focused. | ||
| * Uses [FloatingUI](https://floating-ui.com/). | ||
| * @example | ||
| * <Tooltip content='tooltip text' placement='top'>Hover here</Tooltip> | ||
| */ | ||
| export const Tooltip = TooltipComponent; | ||
mayank99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this one is broken. We rely on
referenceprop from tippy to do this, so need an equivalent hereThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed the reference!