saturation/uisaturation/ui
DocsComponentsBlocksPagesEmails
GitHub

Sections

IntroductionComponentsInstallationMCPThemingDesign

Components

Components

General

AvatarBadgeButtonKbdProgressSeparatorSkeletonSpin ResolveSpinnerSync ButtonTypography

Forms & Inputs

Address LookupCalendar PickerCheckboxComboboxDate PickerEmoji PickerFavicon SearchFieldInputInput GroupInput OTPRadio GroupSelectSliderSwitchTextareaToggleToggle Group

Data Display

AccordionAlertCardChartComparison SliderCredit CardData TableEmptyItemSaturation Credit CardTableTree

Navigation

BreadcrumbCommandMenubarNavigation MenuPaginationTabs

Overlays

CollapsibleContext MenuDialogDropdown MenuSheet

Layout

Button GroupFont ProviderWizard Split Layout

Feedback

Sonner

Animation & Effects

Animated GroupAnimated ListAnimated NumberBeamBlur FadeBorder TrailGlow EffectLiquid MetalLoading StateParallaxPixelProgressive BlurRippleSpotlightText EffectText Shimmer

Productivity

Agent ChatAI Chat InputCoding AgentFiltersFull CalendarKanbanNovel Editor
Docs/Components/Sync Button

Sync Button

A button that triggers an async sync action with a spinning icon animation. Supports icon-only and labeled variants, an animated keyboard shortcut chip, and a controlled syncing state.

Loading...

Installation

pnpm dlx shadcn@latest add @saturation-ui/sync-button

Tailwind v4 — Source Scanning

The public shadcn registry installs component source into your project. If Tailwind v4 isn't scanning your components directory, add this to your CSS entry file:

@source "../components";

This ensures all utility classes in CVA variants and data attribute selectors are included in your build.

Examples

Update All

Loading...
Labeled variant with an animated keyboard shortcut that collapses while syncing.

API Reference

PropTypeDefaultDescription
onSync() => Promise<void>—Async function called when the button is clicked. The button spins until the promise resolves.
labelstring—Text label. Omit for icon-only mode.
shortcutstring—Single character keyboard shortcut shown as a Kbd chip when idle, hidden while syncing.
syncingboolean—Controlled syncing state — use when the parent manages the loading state externally.
PreviousSwitchNextTable

On This Page

  • Installation
  • Examples
  • Update All
  • API Reference