Component
Download Button
A direct download with progress feedback. Fires `onDownload` (wire to a real fetch/blob), surfaces a working state with a spinner, then a brief done state. Supports a `meta` line (e.g. "CSV · 2.4 MB").
- Component
- React
- TSX
- Tailwind CSS
- MIT
Preview
Live component
9:41 100%
devsnips.dev/library/react/components/buttons/download-button/ fluid · no fixed width 100%
Install
Add to your project
npx devsnips add React/Components/Buttons/download-button React/Components/Buttons/download-button import { useState } from "react";
import type { ButtonHTMLAttributes, ReactNode } from "react";
/* DevSnips React — DownloadButton
* Direct download with progress feedback. Fires onDownload; shows a
* spinner + "Downloading…" while pending, then a brief done state.
*/
export type ButtonSize = "xs" | "sm" | "md" | "lg" | "xl";
export type DownloadVariant = "outline" | "solid" | "secondary";
export interface DownloadButtonProps
extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, "onChange"> {
meta?: ReactNode;
href?: string;
variant?: DownloadVariant;
size?: ButtonSize;
onDownload?: () => void | Promise<void>;
}
function cx(...parts: Array<string | false | null | undefined>): string {
return parts.filter(Boolean).join(" ");
}
function Spinner() {
return (
<svg className="h-[1em] w-[1em] shrink-0 animate-spin motion-reduce:animate-none" viewBox="0 0 24 24" fill="none" aria-hidden="true">
<circle cx="12" cy="12" r="9" stroke="currentColor" strokeWidth="3" className="opacity-25" />
<path d="M21 12a9 9 0 0 0-9-9" stroke="currentColor" strokeWidth="3" strokeLinecap="round" />
</svg>
);
}
const SIZES: Record<ButtonSize, string> = {
xs: "h-7 gap-1 px-2 text-xs [&_svg]:size-[14px]",
sm: "h-8 gap-1.5 px-3 text-xs [&_svg]:size-[14px]",
md: "h-9 gap-2 px-3.5 text-[13px] [&_svg]:size-4",
lg: "h-10 gap-2 px-4 text-[13px] [&_svg]:size-[18px]",
xl: "h-11 gap-2 px-5 text-sm [&_svg]:size-5",
};
const VARIANTS: Record<DownloadVariant, string> = {
outline: "border-[var(--ds-color-border-strong)] bg-transparent text-[var(--ds-color-foreground)] hover:bg-[var(--ds-color-surface-hover)] active:bg-[var(--ds-color-surface-active)]",
solid: "border-transparent bg-[var(--ds-color-primary)] text-[var(--ds-color-primary-foreground)] hover:bg-[color-mix(in_srgb,var(--ds-color-primary)_88%,#000)] active:bg-[color-mix(in_srgb,var(--ds-color-primary)_80%,#000)]",
secondary: "border-[var(--ds-color-border)] bg-[var(--ds-color-secondary)] text-[var(--ds-color-secondary-foreground)] hover:bg-[var(--ds-color-surface-active)] active:bg-[var(--ds-color-surface-active)]",
};
export function DownloadButton({
children = "Download",
meta,
href,
variant = "outline",
size = "md",
onDownload,
className,
type = "button",
...rest
}: DownloadButtonProps) {
const [state, setState] = useState<"idle" | "working" | "done">("idle");
async function start(e: React.MouseEvent) {
if (state !== "idle") return;
setState("working");
try { await Promise.resolve(onDownload?.()); }
finally { setState("done"); setTimeout(() => setState("idle"), 1800); }
}
const label = state === "working" ? "Downloading…" : state === "done" ? "Downloaded" : children;
return (
<button
type={type}
className={cx("inline-flex select-none items-center justify-center whitespace-nowrap rounded-[var(--ds-radius-sm)] border font-medium leading-none transition-colors duration-150 ease-out motion-reduce:transition-none focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[var(--ds-color-focus-ring)] disabled:pointer-events-none disabled:opacity-50", VARIANTS[variant], SIZES[size], className)}
onClick={start}
disabled={state === "working"}
aria-busy={state === "working" || undefined}
{...rest}
>
{state === "working" ? <Spinner /> : (
<svg className="h-[1em] w-[1em] shrink-0" viewBox="0 0 24 24" fill="none" aria-hidden="true">
{state === "done"
? <path d="M20 6 9 17l-5-5" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" />
: <><path d="M21 15v4a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-4" /><path d="m7 10 5 5 5-5" /><path d="M12 15V3" /></>}
</svg>
)}
<span className="flex flex-col items-start leading-tight">
<span>{label}</span>
{meta && <span className="text-[11px] font-normal text-[var(--ds-color-muted-foreground)]">{meta}</span>}
</span>
</button>
);
}
export default DownloadButton; /* DevSnips React — JavaScript parity build.
* Same API, behavior, and classes as code.tsx; TypeScript types removed.
* Regenerated from code.tsx — edit code.tsx and re-run the generator.
*/
import { useState } from "react";
function cx(...parts) {
return parts.filter(Boolean).join(" ");
}
function Spinner() {
return <svg className="h-[1em] w-[1em] shrink-0 animate-spin motion-reduce:animate-none" viewBox="0 0 24 24" fill="none" aria-hidden="true">
<circle cx="12" cy="12" r="9" stroke="currentColor" strokeWidth="3" className="opacity-25" />
<path d="M21 12a9 9 0 0 0-9-9" stroke="currentColor" strokeWidth="3" strokeLinecap="round" />
</svg>;
}
const SIZES = {
xs: "h-7 gap-1 px-2 text-xs [&_svg]:size-[14px]",
sm: "h-8 gap-1.5 px-3 text-xs [&_svg]:size-[14px]",
md: "h-9 gap-2 px-3.5 text-[13px] [&_svg]:size-4",
lg: "h-10 gap-2 px-4 text-[13px] [&_svg]:size-[18px]",
xl: "h-11 gap-2 px-5 text-sm [&_svg]:size-5"
};
const VARIANTS = {
outline: "border-[var(--ds-color-border-strong)] bg-transparent text-[var(--ds-color-foreground)] hover:bg-[var(--ds-color-surface-hover)] active:bg-[var(--ds-color-surface-active)]",
solid: "border-transparent bg-[var(--ds-color-primary)] text-[var(--ds-color-primary-foreground)] hover:bg-[color-mix(in_srgb,var(--ds-color-primary)_88%,#000)] active:bg-[color-mix(in_srgb,var(--ds-color-primary)_80%,#000)]",
secondary: "border-[var(--ds-color-border)] bg-[var(--ds-color-secondary)] text-[var(--ds-color-secondary-foreground)] hover:bg-[var(--ds-color-surface-active)] active:bg-[var(--ds-color-surface-active)]"
};
export function DownloadButton({
children = "Download",
meta,
href,
variant = "outline",
size = "md",
onDownload,
className,
type = "button",
...rest
}) {
const [state, setState] = useState("idle");
async function start(e) {
if (state !== "idle") return;
setState("working");
try {
await Promise.resolve(onDownload?.());
} finally {
setState("done");
setTimeout(() => setState("idle"), 1800);
}
}
const label = state === "working" ? "Downloading\u2026" : state === "done" ? "Downloaded" : children;
return <button
type={type}
className={cx("inline-flex select-none items-center justify-center whitespace-nowrap rounded-[var(--ds-radius-sm)] border font-medium leading-none transition-colors duration-150 ease-out motion-reduce:transition-none focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[var(--ds-color-focus-ring)] disabled:pointer-events-none disabled:opacity-50", VARIANTS[variant], SIZES[size], className)}
onClick={start}
disabled={state === "working"}
aria-busy={state === "working" || undefined}
{...rest}
>
{state === "working" ? <Spinner /> : <svg className="h-[1em] w-[1em] shrink-0" viewBox="0 0 24 24" fill="none" aria-hidden="true">
{state === "done" ? <path d="M20 6 9 17l-5-5" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" /> : <><path d="M21 15v4a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-4" /><path d="m7 10 5 5 5-5" /><path d="M12 15V3" /></>}
</svg>}
<span className="flex flex-col items-start leading-tight">
<span>{label}</span>
{meta && <span className="text-[11px] font-normal text-[var(--ds-color-muted-foreground)]">{meta}</span>}
</span>
</button>;
}
export default DownloadButton; # Download Button
A direct download with progress feedback. Fires `onDownload` (wire to a real fetch/blob), surfaces a working state with a spinner, then a brief done state. Supports a `meta` line (e.g. "CSV · 2.4 MB").
## Installation
This component requires **React** and **Tailwind CSS**. Drop `code.tsx` (or `code.jsx` for JavaScript projects) into your project. Tailwind utility classes are included directly in the component, so no separate CSS file is required.
The component consumes the DevSnips semantic design tokens through Tailwind arbitrary values (for example `bg-[var(--ds-color-primary)]`). Define the `--ds-*` tokens once in your theme — see [React/DESIGN_TOKENS.md](../../../DESIGN_TOKENS.md) for the full token spec.
## Usage
```tsx
<DownloadButton meta="CSV · 2.4 MB" onDownload={fetchCsv}>Download</DownloadButton>
```
## JavaScript
A `code.jsx` build is provided for projects that ship plain JSX. It exposes the same API and behavior as `code.tsx` — only the TypeScript types are removed.
## Props
| Prop | Type | Default |
|---|---|---|
| `children` | `ReactNode` | `"Download"` |
| `meta` | `ReactNode` | — (secondary line under the label) |
| `href` | `string` | — (if provided, native anchor download) |
| `variant` | `outline \| solid \| secondary` | `outline` |
| `size` | `ButtonSize` | `md` |
| `onDownload` | `() => void \| Promise<void>` | — |
Plus all native `ButtonHTMLAttributes<HTMLButtonElement>`.
## Variants
outline (default) · solid · secondary.
## Sizes
xs (28px) · sm (32px) · **md (36px, default)** · lg (40px) · xl (44px). Horizontal padding scales 8 → 20px; icons scale 14 → 20px.
## States
default · hover · focus-visible · working (spinner + `aria-busy`, disabled) · done (check icon) · disabled (reduced opacity).
## Accessibility
Renders a native `<button>`. Focus-visible ring uses `color.focus-ring`. Loading sets `aria-busy` and disables to prevent double-submit. Disabled never removes the affordance (reduced opacity, not hidden). Meets the 44px touch target at lg/xl. `aria-busy` reflects the working state. The label changes ("Downloading…") to convey progress beyond the spinner.
## Styling
Tailwind classes are included directly in the component and consume the DevSnips semantic design tokens (`--ds-*`) via arbitrary values. The button themes with the surface automatically in light and dark mode. No component-specific CSS file is needed.
## Design Tokens
See [React/DESIGN_TOKENS.md](../../../DESIGN_TOKENS.md) for the authoritative token specification. This button uses the semantic color, radius, and motion tokens; define them once in your project theme and every button in the family stays in sync.
## Notes
For multiple export targets, use ExportButton. DownloadButton is for a single file with progress feedback. 91 lines UTF-8 · LF · Spaces: 2
Continue browsing