Skip to content

chore: add link component #16156

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 2 commits into from
Jan 15, 2025
Merged

chore: add link component #16156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16b3366
chore: add link component
BrunoQuaresma Jan 15, 2025
ca9f337
Apply minor style improvements
BrunoQuaresma Jan 15, 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
33 changes: 33 additions & 0 deletions site/src/components/Link/Link.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import type { Meta, StoryObj } from "@storybook/react";
import { Link } from "./Link";

const meta: Meta<typeof Link> = {
title: "components/Link",
component: Link,
args: {
children: "Learn more",
},
};

export default meta;
type Story = StoryObj<typeof Link>;

export const Large: Story = {};

export const Small: Story = {
args: {
size: "sm",
},
};

export const InlineUsage: Story = {
render: () => {
return (
<p className="text-sm">
A <Link>workspace</Link> is your personal, customized development
environment. It's based on a <Link>template</Link> that configures your
workspace using Terraform.
</p>
);
},
};
46 changes: 46 additions & 0 deletions site/src/components/Link/Link.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { Slot } from "@radix-ui/react-slot";
import { type VariantProps, cva } from "class-variance-authority";
import { SquareArrowOutUpRightIcon } from "lucide-react";
import { forwardRef } from "react";
import { cn } from "utils/cn";

export const linkVariants = cva(
`relative inline-flex items-center no-underline font-medium text-content-link hover:cursor-pointer
after:hover:content-[''] after:hover:absolute after:hover:left-0 after:hover:w-full after:hover:h-[1px] after:hover:bg-current after:hover:bottom-px
focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-content-link
focus-visible:ring-offset-2 focus-visible:ring-offset-surface-primary focus-visible:rounded-sm
visited:text-content-link pl-[2px]`, //pl-[2px] adjusts the underline spacing to align with the icon on the right.
{
variants: {
size: {
lg: "text-sm gap-[2px] [&_svg]:size-icon-sm [&_svg]:p-[2px] leading-6",
sm: "text-xs gap-1 [&_svg]:size-icon-xs [&_svg]:p-[1px] leading-[18px]",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why use p-[1px] instead of p-px?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know p-px was a thing.

},
},
defaultVariants: {
size: "lg",
},
},
);

export interface LinkProps
extends React.AnchorHTMLAttributes<HTMLAnchorElement>,
VariantProps<typeof linkVariants> {
asChild?: boolean;
}

export const Link = forwardRef<HTMLAnchorElement, LinkProps>(
({ className, children, size, asChild, ...props }, ref) => {
const Comp = asChild ? Slot : "a";
return (
<Comp
className={cn(linkVariants({ size }), className)}
ref={ref}
{...props}
>
{children}
<SquareArrowOutUpRightIcon aria-hidden="true" />
</Comp>
);
},
);
Loading