An open source design system that's fully customizable and agent ready
TypeScript
feat(Button): add href support for link-styled buttons (#935)
Cindy Zhang3366043d7dcf
diff --git a/apps/storybook/stories/Button.stories.tsx b/apps/storybook/stories/Button.stories.tsxindex 5fe4ba37cf..1dea8407b0 100644--- a/apps/storybook/stories/Button.stories.tsx+++ b/apps/storybook/stories/Button.stories.tsx@@ -241,6 +241,66 @@ export const AllVariants: Story = {),};+/**+ * Demonstrates button rendering as a link when `href` is provided.+ * Right-click to verify native browser link context menu (open in new tab, etc.).+ * Disabled state falls back to `<button>` — disabled links are an a11y anti-pattern.+ */+export const LinkButton: Story = {+ render: () => (+ <div style={{display: 'flex', flexDirection: 'column', gap: '16px'}}>+ <div style={{display: 'flex', gap: '12px', alignItems: 'center'}}>+ <XDSButton+ label="Visit Example"+ href="https://example.com"+ variant="primary"+ />+ <XDSButton+ label="Open in new tab"+ href="https://example.com"+ target="_blank"+ rel="noopener noreferrer"+ variant="secondary"+ />+ <XDSButton+ label="Ghost link"+ href="https://example.com"+ variant="ghost"+ />+ </div>+ <div style={{display: 'flex', gap: '12px', alignItems: 'center'}}>+ <XDSButton+ label="Disabled link"+ href="https://example.com"+ variant="primary"+ isDisabled+ />+ <XDSButton+ label="Loading link"+ href="https://example.com"+ variant="primary"+ isLoading+ />+ </div>+ <div style={{display: 'flex', gap: '12px', alignItems: 'center'}}>+ <XDSButton+ label="Settings"+ href="https://example.com"+ variant="secondary"+ icon={<Cog6ToothIcon style={{width: 16, height: 16}} />}>+ Settings+ </XDSButton>+ <XDSButton+ label="Icon-only link"+ href="https://example.com"+ variant="ghost"+ icon={<Cog6ToothIcon style={{width: 16, height: 16}} />}+ />+ </div>+ </div>+ ),+};+/*** Demonstrates button text truncation in constrained containers.* When a button's container is narrower than the button's natural width,diff --git a/packages/core/src/Button/XDSButton.tsx b/packages/core/src/Button/XDSButton.tsxindex 1f42a00c2c..18fafdbde0 100644--- a/packages/core/src/Button/XDSButton.tsx+++ b/packages/core/src/Button/XDSButton.tsx@@ -12,7 +12,7 @@* - /packages/core/src/Button/index.ts (exports if types change)* - /apps/storybook/stories/Button.stories.tsx (storybook stories)*- * Last synced props: label, variant, size, isDisabled, isLoading, onClickAction, icon, children, tooltip, endContent+ * Last synced props: label, variant, size, isDisabled, isLoading, onClickAction, icon, children, tooltip, endContent, href, as, target, rel*/import {useRef, useTransition, type ReactNode} from 'react';@@ -33,6 +33,8 @@ import {XDSSpinner} from '../Spinner';import {edgeCompensation} from '../Layout/edgeCompensation.stylex';import {xdsClassName, mergeProps} from '../utils';+import {useXDSLinkComponent} from '../Link/useXDSLinkComponent';+import type {XDSLinkComponentType} from '../Link/types';/*** Base button styles@@ -116,6 +118,9 @@ const styles = stylex.create({whiteSpace: 'nowrap',borderWidth: 0,},+ link: {+ textDecoration: 'none',+ },});const sizeStyles = stylex.create({@@ -319,6 +324,26 @@ export interface XDSButtonProps extends XDSBaseProps<HTMLButtonElement> {* Tooltip text shown on hover.*/tooltip?: string;+ /**+ * When provided, renders the button as a link (`<a>` or custom component).+ * When the button is disabled, still renders as `<button>` regardless of href+ * (disabled links are an accessibility anti-pattern).+ */+ href?: string;+ /**+ * Custom link component to use when `href` is provided.+ * Overrides the provider-level default set by XDSLinkProvider.+ * Useful for Next.js `<Link>` or other router-aware components.+ */+ as?: XDSLinkComponentType;+ /**+ * HTML target attribute for the link. Only applies when `href` is provided.+ */+ target?: string;+ /**+ * HTML rel attribute for the link. Only applies when `href` is provided.+ */+ rel?: string;}/**@@ -363,6 +388,10 @@ const edgeCompStyles = stylex.create({* Wrap your app in <Theme> to apply a theme.* Themes can provide component-level variant overrides via theme.components.button.variants*+ * When `href` is provided (and the button is not disabled), renders as an `<a>`+ * element (or custom link component) with full button styling, enabling native+ * browser behaviors like right-click → open in new tab and Cmd+Click.+ ** @example* ```* <XDSButton label="Click me" />@@ -373,6 +402,8 @@ const edgeCompStyles = stylex.create({* <XDSButton label="Edit" icon={<PencilIcon />}>Edit</XDSButton>* <XDSButton label="Messages" endContent={<XDSBadge label={3} />} />* <XDSButton label="Edit" icon={<PencilIcon />} endContent={<XDSBadge label="New" />}>Edit</XDSButton>+ * <XDSButton label="Visit site" href="https://example.com" variant="primary" />+ * <XDSButton label="Open in new tab" href="https://example.com" target="_blank" rel="noopener noreferrer" />* ```*/export function XDSButton({@@ -387,6 +418,10 @@ export function XDSButton({children,endContent,tooltip,+ href,+ as,+ target,+ rel,xstyle,className,style,@@ -399,6 +434,11 @@ export function XDSButton({const buttonDisabled = isDisabled || isLoadingState;const useLightSpinner = variant === 'primary' || variant === 'destructive';const isIconOnly = icon != null && children == null;+ const LinkComponent = useXDSLinkComponent(as);++ // Render as link when href is provided and button is not disabled.+ // Disabled links are an accessibility anti-pattern — fall back to <button>.+ const renderAsLink = href != null && !buttonDisabled;// Use aria-disabled when tooltip is present so the button remains focusable// for keyboard users to reach the tooltip. Otherwise use native disabled.@@ -446,36 +486,30 @@ export function XDSButton({: edgeCompStyles.paddingInline3: null;- const button = (- <button- ref={ref}- type={type}- disabled={useAriaDisabled ? undefined : buttonDisabled}- {...mergeProps(- xdsClassName('button', {variant, size}),- stylex.props(- styles.base,- sizeStyles[size],- variants[variant],- isIconOnly && styles.iconOnly,- buttonDisabled && styles.disabled,- useAriaDisabled && styles.ariaDisabled,- isLoadingState && loadingStyles.loading,- edgePaddingSignal,- edgeCompStyle,- xstyle,- ),- className,- style,- )}- {...props}- {...((isIconOnly && label !== '') || (isLoadingState && !isIconOnly)- ? {'aria-label': label}- : null)}- aria-busy={isLoadingState || undefined}- aria-disabled={useAriaDisabled || undefined}- onClick={handleClick}- {...(handleKeyDown ? {onKeyDown: handleKeyDown} : null)}>+ // Shared StyleX props for both button and link rendering+ const sharedStylexProps = stylex.props(+ styles.base,+ sizeStyles[size],+ variants[variant],+ isIconOnly && styles.iconOnly,+ buttonDisabled && styles.disabled,+ useAriaDisabled && styles.ariaDisabled,+ isLoadingState && loadingStyles.loading,+ edgePaddingSignal,+ edgeCompStyle,+ renderAsLink && styles.link,+ xstyle,+ );++ const sharedMergedProps = mergeProps(+ xdsClassName('button', {variant, size}),+ sharedStylexProps,+ className,+ style,+ );++ const buttonContent = (+ <>{isLoadingState && (<span{...stylex.props(loadingStyles.spinnerOverlay)}@@ -504,18 +538,57 @@ export function XDSButton({aria-live="polite">{isLoadingState ? 'Loading' : ''}</span>- </button>+ </>);+ const ariaLabelProp =+ (isIconOnly && label !== '') || (isLoadingState && !isIconOnly)+ ? {'aria-label': label}+ : null;++ let element: ReactNode;++ if (renderAsLink) {+ element = (+ <LinkComponent+ ref={ref as React.Ref<HTMLAnchorElement>}+ href={href}+ target={target}+ rel={rel}+ {...sharedMergedProps}+ {...props}+ {...ariaLabelProp}+ onClick={handleClick}>+ {buttonContent}+ </LinkComponent>+ );+ } else {+ element = (+ <button+ ref={ref}+ type={type}+ disabled={useAriaDisabled ? undefined : buttonDisabled}+ {...sharedMergedProps}+ {...props}+ {...ariaLabelProp}+ aria-busy={isLoadingState || undefined}+ aria-disabled={useAriaDisabled || undefined}+ onClick={handleClick}+ {...(handleKeyDown ? {onKeyDown: handleKeyDown} : null)}>+ {buttonContent}+ </button>+ );+ }+if (tooltip) {return (<XDSTooltip content={tooltip} placement="above">- {button}+ {element}</XDSTooltip>);}- return button;+ return element;}XDSButton.displayName = 'XDSButton';