Start typing to search components and docs…
↵ select ↑ ↓ navigate ESC close

All buttons

This page is an example on how to document your button components, most of the copy was written by AI so don’t take it very seriously.

Find the code for this page in the src/pages/components/buttons.md file.

<button class="btn-primary btn-normal">Primary</button>
<button class="btn-secondary btn-normal">Secondary</button>
<button class="btn-tertiary btn-normal">Tertiary</button>
<button class="btn-text btn-sm">Text</button>
<button class="btn-tag btn-xs">Tag Name</button>
<button class="btn-primary btn-normal rounded-full">Primary</button>
<button class="btn-secondary btn-normal rounded-full">Secondary</button>
<button class="btn-tertiary btn-normal rounded-full">Tertiary</button>
<button class="btn-text btn-sm rounded-full">Text</button>
<button class="btn-tag btn-xs rounded-full">Tag Name</button>

Primary button <button>

We use the primary button for main actions like saving a form or creating a new item.

<button class="btn-primary btn-normal">Primary</button>
<button class="btn-primary btn-sm">Primary</button>
<button class="btn-primary btn-xs">Primary</button>

Secondary button

Secondary buttons accompany primary buttons to provide additional actions. For example, cancel buttons are secondary buttons.

<button class="btn-secondary btn-normal">Secondary</button>
<button class="btn-secondary btn-sm">Secondary</button>
<button class="btn-secondary btn-xs">Secondary</button>

Text button

Text buttons are used for actions that do not require a primary or secondary button.

<button class="btn-text btn-normal">Text button</button>
<button class="btn-tertiary btn-normal">Tertiary</button>
<button class="btn-tertiary btn-sm">Tertiary</button>
<button class="btn-tertiary btn-xs">Tertiary</button>

Tertiary with icon

<a href="#" class="btn-tertiary btn-normal">
Read more
<span class="i-la-arrow-right ml-2 text-2xl -my-1 -mr-1" aria-hidden="true"></span>
</a>
<a href="#" class="btn-tertiary btn-sm">
Read more
<span class="i-la-arrow-right ml-2 text-2xl -my-1 -mr-1" aria-hidden="true"></span>
</a>
<a href="#" class="btn-tertiary btn-xs px-5">
Read more
<span class="i-la-arrow-right ml-2 text-2xl -my-1 -mr-1" aria-hidden="true"></span>
</a>

Rounded button

Rounded edges — add rounded prop, or rounded-full class for raw HTML.

<button class="btn-primary btn-normal rounded-full">Primary</button>
<button class="btn-secondary btn-normal rounded-full">Secondary</button>
<button class="btn-tertiary btn-normal rounded-full">Tertiary</button>
<button class="btn-text btn-normal rounded-full">Text</button>
<button class="btn-tag btn-normal rounded-full">Tag Name</button>

Outline button

Outlined variants of the three button styles.

<button class="btn-primary-outline btn-normal" title="Title">Text button</button>
<button class="btn-primary-outline btn-normal rounded-full" title="Title">Text button</button>
<button class="btn-secondary-outline btn-normal" title="Title">Text button</button>
<button class="btn-secondary-outline btn-normal rounded-full" title="Title">Text button</button>
<button class="btn-tertiary-outline btn-normal btn-medium-hover" title="Title">Text button</button>
<button class="btn-tertiary-outline btn-normal btn-medium-hover rounded-full" title="Title">Text button</button>
<button class="btn-tertiary-outline btn-normal btn-medium-hover border-2" title="Title">Text button</button>

Outline button - custom hover

A hover modifier replaces a button’s own hover colours, text and background together, in both colour schemes, so the pair stays readable (WCAG 1.4.3).

<button class="btn-tertiary-outline btn-normal btn-light-hover rounded-full" title="Title">Text button</button>
<button class="btn-tertiary-outline btn-normal btn-medium-hover rounded-full" title="Title">Text button</button>
<button class="btn-tertiary-outline btn-normal btn-dark-hover rounded-full" title="Title">Text button</button>
<button class="btn-tertiary-outline btn-normal btn-white-hover rounded-full" title="Title">Text button</button>

Passing href renders the button as an <a> element — same styling, anchor semantics.

<a href="#" class="btn-primary btn-normal" title="Title">Text button</a>

Circle button

Circle buttons are perfect for icon-only actions, maintaining equal width and height.

<button class="btn-primary btn-normal btn-circle" aria-label="Next">
<span class="i-la-arrow-right" aria-hidden="true"></span>
</button>
<button class="btn-secondary btn-normal btn-circle" aria-label="Next">
<span class="i-la-arrow-right" aria-hidden="true"></span>
</button>
<button class="btn-tertiary btn-normal btn-circle" aria-label="Next">
<span class="i-la-arrow-right" aria-hidden="true"></span>
</button>
<!-- Size modifiers: btn-sm (medium), btn-xs (small) -->
<button class="btn-primary btn-sm btn-circle" aria-label="Next">
<span class="i-la-arrow-right text-xl" aria-hidden="true"></span>
</button>
<button class="btn-primary btn-xs btn-circle" aria-label="Next">
<span class="i-la-arrow-right text-lg" aria-hidden="true"></span>
</button>

Circle outline buttons

<button class="btn-primary-outline btn-normal btn-circle" aria-label="Next">
<span class="i-la-arrow-right text-2xl" aria-hidden="true"></span>
</button>
<button class="btn-secondary-outline btn-normal btn-circle" aria-label="Next">
<span class="i-la-arrow-right text-2xl" aria-hidden="true"></span>
</button>
<button class="btn-tertiary-outline btn-normal btn-medium-hover btn-circle" aria-label="Next">
<span class="i-la-arrow-right text-2xl" aria-hidden="true"></span>
</button>

CSS Class Reference

All variants in one place — copy any combination into plain HTML. Size modifiers: btn-normal (default), btn-sm (medium), btn-xs (small).

<!-- Solid variants -->
<button class="btn-primary btn-normal">Primary</button>
<button class="btn-secondary btn-normal">Secondary</button>
<button class="btn-tertiary btn-normal">Tertiary</button>

<!-- Outline variants -->
<button class="btn-primary-outline btn-normal">Primary outline</button>
<button class="btn-secondary-outline btn-normal">Secondary outline</button>
<button class="btn-tertiary-outline btn-normal">Tertiary outline</button>

<!-- Sizes -->
<button class="btn-primary btn-normal">Large</button>
<button class="btn-primary btn-sm">Medium</button>
<button class="btn-primary btn-xs">Small</button>

<!-- Rounded -->
<button class="btn-primary btn-normal rounded-full">Rounded</button>

<!-- Circle (icon-only) -->
<button class="btn-primary btn-normal btn-circle" aria-label="Next">
  <span class="i-la-arrow-right" aria-hidden="true"></span>
</button>

<!-- Link rendered as <a> -->
<a href="/path" class="btn-primary btn-normal">Link button</a>

<!-- Tag / pill -->
<button class="btn-tag">Tag label</button>

Props Reference

Props of Button
PropTypeDefaultDescription
hrefstring—Renders as <a> when provided
titlestring—Native title attribute
primarybooleanfalsePrimary solid button style
primaryOutlinebooleanfalsePrimary outline variant
secondarybooleanfalseSecondary solid button style
secondaryOutlinebooleanfalseSecondary outline variant
tertiarybooleanfalseTertiary / ghost button style
tertiaryOutlinebooleanfalseTertiary outline variant
textbooleanfalseUnderline-on-hover text button
tagbooleanfalsePill-shaped tag button
smallbooleanfalseExtra-small size (btn-xs)
mediumbooleanfalseMedium size (btn-sm)
roundedbooleanfalseLegacy no-op — all SDS buttons are rounded by default via shortcut. Use sharp to opt out.
sharpbooleanfalseOpt-out — forces sharp corners with !rounded-none
whiteHoverbooleanfalseWhite hover state (btn-white-hover)
lightHoverbooleanfalseLight hover state (btn-light-hover)
mediumHoverbooleanfalseMedium hover state (btn-medium-hover); applied by default to tertiaryOutline without another hover prop
darkHoverbooleanfalseDark hover state (btn-dark-hover)
circlebooleanfalseEqual width/height circle — for icon-only buttons. Always pass an aria-label too

Source: src/components/Button.vue