Skip to content

← All components

Actions and forms

Button

Primary, secondary, ghost, and danger actions.

Live example

Usage

Each example includes the complete adapter-specific parameter reference. Copy it as a starting point, then remove options your use case does not need.

React

tsx
import { Button } from "@cofob/design-system-react";

/**
 * Complete Button parameter reference.
 * @param variant
 *   type: "primary" | "secondary" | "ghost" | "danger"
 *   default: "primary" or component default
 *   example: "secondary"
 * @param size
 *   type: "sm" | "md" | "lg" (plus heading sizes)
 *   default: "md"
 *   example: "md"
 * @param loading
 *   type: boolean
 *   default: false
 *   example: true
 * @param leading/startIcon
 *   type: Snippet (Svelte) | LucideIcon or ReactNode (React)
 *   default: —
 *   example: leading snippet / startIcon={Save}
 * @param trailing/endIcon
 *   type: Snippet (Svelte) | LucideIcon or ReactNode (React)
 *   default: —
 *   example: trailing snippet / endIcon={ArrowRight}
 * @param button attributes
 *   type: native element attributes
 *   default: —
 *   example: class / style / aria-* / data-*
 * @param children
 *   type: ReactNode | Svelte Snippet | child HTML
 *   default: —
 *   example: children / snippet / child HTML
 */
export function ButtonExample() {
  return (
    <Button>Content</Button>
  );
}

Svelte

svelte
<script lang="ts">
  import { Button } from "@cofob/design-system-svelte";

  // Complete Button parameter reference.
  // variant
  //   type: "primary" | "secondary" | "ghost" | "danger"
  //   default: "primary" or component default
  //   example: "secondary"
  // size
  //   type: "sm" | "md" | "lg" (plus heading sizes)
  //   default: "md"
  //   example: "md"
  // tone
  //   type: "neutral" | "accent" | "info" | "success" | "warning" | "danger"
  //   default: "neutral"
  //   example: "success"
  // loading
  //   type: boolean
  //   default: false
  //   example: true
  // fullWidth
  //   type: boolean
  //   default: false
  //   example: true
  // leading/startIcon
  //   type: Snippet (Svelte) | LucideIcon or ReactNode (React)
  //   default: —
  //   example: leading snippet / startIcon={Save}
  // trailing/endIcon
  //   type: Snippet (Svelte) | LucideIcon or ReactNode (React)
  //   default: —
  //   example: trailing snippet / endIcon={ArrowRight}
  // button attributes
  //   type: native element attributes
  //   default: —
  //   example: class / style / aria-* / data-*
  // children
  //   type: ReactNode | Svelte Snippet | child HTML
  //   default: —
  //   example: children / snippet / child HTML
</script>

<Button>Content</Button>

HTML

html
<!--
  Complete Button parameter reference.
  variant
    type: "primary" | "secondary" | "ghost" | "danger"
    default: "primary" or component default
    example: "secondary"
  size
    type: "sm" | "md" | "lg" (plus heading sizes)
    default: "md"
    example: "md"
  tone
    type: "neutral" | "accent" | "info" | "success" | "warning" | "danger"
    default: "neutral"
    example: "success"
  loading
    type: boolean
    default: false
    example: true
  fullWidth
    type: boolean
    default: false
    example: true
  leading/startIcon
    type: Snippet (Svelte) | LucideIcon or ReactNode (React)
    default: —
    example: leading snippet / startIcon={Save}
  trailing/endIcon
    type: Snippet (Svelte) | LucideIcon or ReactNode (React)
    default: —
    example: trailing snippet / endIcon={ArrowRight}
  button attributes
    type: native element attributes
    default: —
    example: class / style / aria-* / data-*
  children
    type: ReactNode | Svelte Snippet | child HTML
    default: —
    example: children / snippet / child HTML
-->
<button class="cf-button" data-variant="primary">Save</button>

<script type="module">
  import { initDesignSystem } from "@cofob/design-system-css";

  const designSystem = initDesignSystem(document);
  window.addEventListener("pagehide", () => designSystem.destroy(), { once: true });
</script>

Parameters

Adapter differences are explicit. Native element attributes are forwarded in React and Svelte and can be written directly in HTML.

ParameterTypeDefaultAdaptersExampleDescription
variant"primary" | "secondary" | "ghost" | "danger""primary" or component defaultReact · Svelte · HTML"secondary"Selects the component's visual treatment.
size"sm" | "md" | "lg" (plus heading sizes)"md"React · Svelte · HTML"md"Applies a design-system size token.
tone"neutral" | "accent" | "info" | "success" | "warning" | "danger""neutral"Svelte · HTML"success"Applies semantic color intent without hard-coded colors.
loadingbooleanfalseReact · Svelte · HTMLtrueShows progress, preserves width, and disables repeated activation.
fullWidthbooleanfalseSvelte · HTMLtrueExpands the Svelte button to its container width.
leading/startIconSnippet (Svelte) | LucideIcon or ReactNode (React)React · Svelte · HTMLleading snippet / startIcon={Save}Supplies leading icon content using the adapter's composition API.
trailing/endIconSnippet (Svelte) | LucideIcon or ReactNode (React)React · Svelte · HTMLtrailing snippet / endIcon={ArrowRight}Supplies trailing icon content using the adapter's composition API.
button attributesnative element attributesReact · Svelte · HTMLclass / style / aria-* / data-*Forwards native class/style, accessibility, event, and data attributes to the root element.
childrenReactNode | Svelte Snippet | child HTMLReact · Svelte · HTMLchildren / snippet / child HTMLIdiomatic adapter composition content.