Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

Design System: Improve icon button example accessibility (#50783)

Gildas Garcia93a032c90dbe
diff --git a/apps/design-system/content/docs/components/button.mdx b/apps/design-system/content/docs/components/button.mdx
index d4535fc407f..88b9355511f 100644
--- a/apps/design-system/content/docs/components/button.mdx
+++ b/apps/design-system/content/docs/components/button.mdx
@@ -100,13 +100,17 @@ Used for actions that are not as important as the primary action, or for actions
<ComponentPreview name="button-link" />
-### Only an icon
+### Icon-only
-Displaying only an Icon in a button.
+Render an [icon](./icons) in a button without accompanying text. Ensure the button is accessible by:
-<Admonition type="note" title="This feature requires more support" className="mt-3">
- We should update the button component to support this use case better.
-</Admonition>
+- Wrapping it in a [Tooltip](./tooltip) for sighted users.
+- Adding an `aria-label` prop for screen readers.
+- Setting its `aria-describedby` prop to `undefined` when the tooltip content repeats the label. Otherwise screen readers read the label twice.
+
+Consider also squaring off the button container as shown in the example below. For the default `tiny` size (`h-[26px]`), use `w-6.5` so the button is square.
+
+Compact icon-only buttons may also benefit from the `hit-area` utility. This increases their tap target slightly each side without changing the visual layout. See the [Table](./table#actions) component for more information.
<ComponentPreview name="button-icon" />
diff --git a/apps/design-system/registry/default/example/button-icon.tsx b/apps/design-system/registry/default/example/button-icon.tsx
index e9cac7c1660..89600f1cce1 100644
--- a/apps/design-system/registry/default/example/button-icon.tsx
+++ b/apps/design-system/registry/default/example/button-icon.tsx
@@ -1,6 +1,21 @@
-import { ChevronRight } from 'lucide-react'
-import { Button } from 'ui'
+import { ExternalLink } from 'lucide-react'
+import { Button, Tooltip, TooltipContent, TooltipTrigger } from 'ui'
export default function ButtonIcon() {
- return <Button variant="outline" icon={<ChevronRight className="h-4 w-4" />}></Button>
+ return (
+ <Tooltip>
+ <TooltipTrigger asChild>
+ <Button
+ variant="outline"
+ icon={<ExternalLink />}
+ // Match tooltip content for screen readers
+ aria-label="View logs"
+ // Tooltip repeats the label; clear describedby so screen readers don't hear it twice
+ // Skip this if the tooltip adds information beyond the label
+ aria-describedby={undefined}
+ ></Button>
+ </TooltipTrigger>
+ <TooltipContent>View logs</TooltipContent>
+ </Tooltip>
+ )
}
diff --git a/packages/ui/src/components/Button/Button.tsx b/packages/ui/src/components/Button/Button.tsx
index cfba89ea915..ea4e7844d0a 100644
--- a/packages/ui/src/components/Button/Button.tsx
+++ b/packages/ui/src/components/Button/Button.tsx
@@ -119,6 +119,9 @@ const buttonVariants = cva(
rounded: {
true: 'rounded-full',
},
+ iconOnly: {
+ true: 'hit-area-1 w-6.5',
+ },
},
// Match <Button size="tiny"> so raw buttonVariants({ variant }) keeps sizing.
// Fixed icon shells that omit size must override padding (e.g. px-0 with h/w-[30px]).
@@ -182,7 +185,7 @@ export interface ButtonProps
extends
React.ButtonHTMLAttributes<HTMLButtonElement>,
// omit 'disabled' as it is included in HTMLButtonElement
- Omit<ButtonVariantProps, 'disabled'>,
+ Omit<ButtonVariantProps, 'disabled' | 'iconOnly'>,
LoadingVariantProps {
asChild?: boolean
variant?: ButtonVariantProps['variant']
@@ -266,6 +269,7 @@ const Button = forwardRef<HTMLButtonElement, ButtonProps>(
focusableWhenDisabled,
block,
rounded,
+ iconOnly: children == null || children === false,
}),
className
)}