feat: LinkPreview component #10243
+1,125
−43
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| * Copyright 2024 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import {AriaLinkPreviewProps, useLinkPreviewTrigger} from 'react-aria/useLinkPreviewTrigger'; | ||
| import {FocusableElement} from '@react-types/shared'; | ||
| import {FocusableProvider} from 'react-aria/private/interactions/useFocusable'; | ||
| import {OverlayTriggerState} from 'react-stately/useOverlayTriggerState'; | ||
| import {OverlayTriggerStateContext} from './Dialog'; | ||
| import {PopoverContext} from './Popover'; | ||
| import {Provider} from './utils'; | ||
| import React, {JSX, ReactNode, useMemo, useRef} from 'react'; | ||
| import {useTooltipTriggerState} from 'react-stately/useTooltipTriggerState'; | ||
|
|
||
| export interface LinkPreviewProps extends AriaLinkPreviewProps { | ||
| /** The Link and Popover that make up the link preview. */ | ||
| children: ReactNode; | ||
| } | ||
|
|
||
| /** | ||
| * A LinkPreview wraps a Link and a Popover to display a non-modal preview of the link's content | ||
| * on hover, focus, or long press. Unlike a tooltip, the popover may contain interactive content. | ||
| */ | ||
| export function LinkPreview(props: LinkPreviewProps): JSX.Element { | ||
| let state = useTooltipTriggerState({ | ||
| ...props, | ||
| delay: props.delay ?? 600, | ||
| closeDelay: props.closeDelay ?? 200 | ||
| }); | ||
| let triggerRef = useRef<FocusableElement>(null); | ||
| let popoverRef = useRef<HTMLElement>(null); | ||
| let {triggerProps, popoverProps} = useLinkPreviewTrigger( | ||
| {...props, triggerRef, popoverRef}, | ||
| state | ||
| ); | ||
|
|
||
| // The Popover and usePopover expect an OverlayTriggerState. Adapt the TooltipTriggerState (which | ||
| // provides the warmup/cooldown delay behavior) to that interface. | ||
| let overlayState = useMemo<OverlayTriggerState>( | ||
| () => ({ | ||
| isOpen: state.isOpen, | ||
| open: () => state.open(), | ||
| close: () => state.close(), | ||
| setOpen: isOpen => (isOpen ? state.open() : state.close()), | ||
| toggle: () => (state.isOpen ? state.close() : state.open()) | ||
| }), | ||
| [state] | ||
| ); | ||
|
|
||
| return ( | ||
| <Provider | ||
| values={[ | ||
| [OverlayTriggerStateContext, overlayState], | ||
| [ | ||
| PopoverContext, | ||
| { | ||
| trigger: 'LinkPreview', | ||
| triggerRef, | ||
| ref: popoverRef, | ||
| isNonModal: true, | ||
| // Skip enter/exit animations when swapping between previews during the warmup period. | ||
| isInstant: state.isInstant, | ||
| ...popoverProps | ||
| } | ||
| ] | ||
| ]}> | ||
| <FocusableProvider {...triggerProps} ref={triggerRef}> | ||
| {props.children} | ||
| </FocusableProvider> | ||
| </Provider> | ||
| ); | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /* | ||
| * Copyright 2024 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import {Button} from 'vanilla-starter/Button'; | ||
| import {Link} from 'vanilla-starter/Link'; | ||
| import {LinkPreview} from '../src/LinkPreview'; | ||
| import {Meta, StoryObj} from '@storybook/react'; | ||
| import {Popover} from 'vanilla-starter/Popover'; | ||
| import React, {JSX, ReactNode} from 'react'; | ||
|
|
||
| export default { | ||
| title: 'React Aria Components/LinkPreview', | ||
| component: LinkPreview | ||
| } as Meta<typeof LinkPreview>; | ||
|
|
||
| export type LinkPreviewStory = StoryObj<typeof LinkPreview>; | ||
|
|
||
| interface PreviewLinkProps { | ||
| href: string; | ||
| title: string; | ||
| description: string; | ||
| children: ReactNode; | ||
| delay?: number; | ||
| closeDelay?: number; | ||
| } | ||
|
|
||
| function PreviewLink({ | ||
| href, | ||
| title, | ||
| description, | ||
| children, | ||
| delay, | ||
| closeDelay | ||
| }: PreviewLinkProps): JSX.Element { | ||
| return ( | ||
| <LinkPreview delay={delay} closeDelay={closeDelay}> | ||
| <Link href={href} target="_blank"> | ||
| {children} | ||
| </Link> | ||
| <Popover offset={4} style={{maxWidth: 260}}> | ||
| <div style={{display: 'flex', flexDirection: 'column', gap: 8, alignItems: 'start'}}> | ||
| <strong>{title}</strong> | ||
| <span style={{fontSize: 13}}>{description}</span> | ||
| <Button onPress={() => window.open(href, '_blank', 'noopener')}>Open</Button> | ||
| </div> | ||
| </Popover> | ||
| </LinkPreview> | ||
| ); | ||
| } | ||
|
|
||
| function Example(props: {delay?: number; closeDelay?: number}): JSX.Element { | ||
| let {delay, closeDelay} = props; | ||
| return ( | ||
| <p style={{maxWidth: 500}}> | ||
| The React Spectrum project includes{' '} | ||
| <PreviewLink | ||
| href="https://react-spectrum.adobe.com/react-aria/" | ||
| title="React Aria" | ||
| description="A library of unstyled React components and hooks that provides accessible UI primitives for your design system." | ||
| delay={delay} | ||
| closeDelay={closeDelay}> | ||
| React Aria | ||
| </PreviewLink> | ||
| ,{' '} | ||
| <PreviewLink | ||
| href="https://react-spectrum.adobe.com/react-spectrum/" | ||
| title="React Spectrum" | ||
| description="A React implementation of Spectrum, Adobe's design system." | ||
| delay={delay} | ||
| closeDelay={closeDelay}> | ||
| React Spectrum | ||
| </PreviewLink> | ||
| , and{' '} | ||
| <PreviewLink | ||
| href="https://react-spectrum.adobe.com/internationalized/" | ||
| title="Internationalized" | ||
| description="A collection of framework-agnostic libraries for handling dates, numbers, and strings across locales." | ||
| delay={delay} | ||
| closeDelay={closeDelay}> | ||
| Internationalized | ||
| </PreviewLink> | ||
| . Hover one preview, then quickly hover the next to see the shared warmup timer make | ||
| subsequent previews open instantly. | ||
| </p> | ||
| ); | ||
| } | ||
|
|
||
| export const Default: LinkPreviewStory = { | ||
| render: () => <Example /> | ||
| }; | ||
|
|
||
| export const WithDelays: LinkPreviewStory = { | ||
| render: args => <Example delay={args.delay} closeDelay={args.closeDelay} />, | ||
| args: { | ||
| delay: 700, | ||
| closeDelay: 500 | ||
| } | ||
| }; |
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.
Name? Should it be LinkPreviewTrigger to match other trigger components? Is this too specific to this one use case? Are there other use cases that this would cover?
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.
IMO it doesn't seem specific to links, could see this being used for cards/other pieces of content that may want to display meta data + actions/interactive content on hover or focus. That being said, I can't find an actual example of that so far haha
This is like HoverCard in Radix, so maybe something similar? PreviewTrigger?