refactor: [M3-8783] - Migrate /volumes to Tanstack Router #11154
There are no files selected for viewing
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 |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@linode/manager": Tech Stories | ||
| --- | ||
|
|
||
| Migrate `/volumes` to Tanstack router ([#11154](https://github.com/linode/manager/pull/11154)) |
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
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 |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| import React from 'react'; | ||
|
|
||
| import { TanstackLink } from './TanstackLinks'; | ||
|
|
||
| import type { TanstackLinkComponentProps } from './TanstackLinks'; | ||
| import type { Meta, StoryObj } from '@storybook/react'; | ||
|
|
||
| export const AsButtonPrimary: StoryObj<TanstackLinkComponentProps> = { | ||
| render: () => ( | ||
| <TanstackLink linkType="primary" to="/"> | ||
| Home | ||
| </TanstackLink> | ||
| ), | ||
| }; | ||
|
|
||
| export const AsButtonSecondary: StoryObj<TanstackLinkComponentProps> = { | ||
| render: () => ( | ||
| <TanstackLink linkType="secondary" to="/"> | ||
| Home | ||
| </TanstackLink> | ||
| ), | ||
| }; | ||
|
|
||
| export const AsLink: StoryObj<TanstackLinkComponentProps> = { | ||
| render: () => ( | ||
| <TanstackLink linkType="link" to="/"> | ||
| Home | ||
| </TanstackLink> | ||
| ), | ||
| }; | ||
|
|
||
| const meta: Meta<TanstackLinkComponentProps> = { | ||
| parameters: { | ||
| tanStackRouter: true, | ||
| }, | ||
| title: 'Foundations/Link/Tanstack Link', | ||
| }; | ||
| export default meta; |
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 |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| import { Button } from '@linode/ui'; | ||
| import { omitProps } from '@linode/ui'; | ||
| import { LinkComponent } from '@tanstack/react-router'; | ||
| import { createLink } from '@tanstack/react-router'; | ||
| import * as React from 'react'; | ||
|
|
||
| import { MenuItem } from 'src/components/MenuItem'; | ||
|
|
||
| import type { ButtonProps, ButtonType } from '@linode/ui'; | ||
| import type { LinkProps as TanStackLinkProps } from '@tanstack/react-router'; | ||
|
|
||
| export interface TanstackLinkComponentProps | ||
| extends Omit<ButtonProps, 'buttonType' | 'href'> { | ||
| linkType: 'link' | ButtonType; | ||
| tooltipAnalyticsEvent?: (() => void) | undefined; | ||
| tooltipText?: string; | ||
| } | ||
|
|
||
| export interface TanStackLinkRoutingProps { | ||
| linkType: TanstackLinkComponentProps['linkType']; | ||
| params?: TanStackLinkProps['params']; | ||
| preload?: TanStackLinkProps['preload']; | ||
| search?: TanStackLinkProps['search']; | ||
| to: TanStackLinkProps['to']; | ||
| } | ||
|
|
||
| const LinkComponent = React.forwardRef< | ||
| HTMLButtonElement, | ||
| TanstackLinkComponentProps | ||
| >((props, ref) => { | ||
| const _props = omitProps(props, ['linkType']); | ||
|
|
||
| return <Button component="a" ref={ref} {..._props} />; | ||
abailly-akamai marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }); | ||
|
|
||
| const MenuItemLinkComponent = React.forwardRef< | ||
| HTMLButtonElement, | ||
| TanstackLinkComponentProps | ||
| >((props, ref) => { | ||
| const _props = omitProps(props, ['linkType']); | ||
|
|
||
| return <MenuItem component="a" ref={ref} {..._props} />; | ||
| }); | ||
|
|
||
| const CreatedLinkComponent = createLink(LinkComponent); | ||
| const CreatedMenuItemLinkComponent = createLink(MenuItemLinkComponent); | ||
|
|
||
| /** | ||
| * @deprecated | ||
| * This is marked as deprecated to discourage usage until the migration is complete. | ||
| * While not technically deprecated, these components should not be used anywhere in the app. | ||
| * They will be replacing our Links eventually, but have only been introduced early to test their functionality. | ||
| */ | ||
| export const TanstackLink: LinkComponent<typeof LinkComponent> = (props) => { | ||
| return ( | ||
| <CreatedLinkComponent | ||
| {...props} | ||
| sx={(theme) => ({ | ||
| ...(props.linkType === 'link' && { | ||
| '&:hover': { | ||
| textDecoration: 'underline', | ||
| }, | ||
| fontFamily: theme.font.normal, | ||
| fontSize: '0.875rem', | ||
| minWidth: 'initial', | ||
| padding: 0, | ||
| }), | ||
| })} | ||
| /> | ||
| ); | ||
| }; | ||
|
|
||
| /** | ||
| * @deprecated | ||
| * This is marked as deprecated to discourage usage until the migration is complete. | ||
| * While not technically deprecated, these components should not be used anywhere in the app. | ||
| * They will be replacing our Links eventually, but have only been introduced early to test their functionality. | ||
| */ | ||
| export const TanstackMenuItemLink: LinkComponent< | ||
| typeof MenuItemLinkComponent | ||
| > = (props) => { | ||
| return <CreatedMenuItemLinkComponent {...props} />; | ||
| }; | ||
|
There was a problem hiding this comment. Note, this component is not in use in this PR - it was introduced while exploring prefetching, which is too early to do during the migration of some feature. I left it in here because it will be helpful in the near future. There was a problem hiding this comment. @coliu-akamai to answer your question above, both components in this file are marked as |
||
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
Oops, something went wrong.
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 allows routed components to render properly - should not be needed often