Spinner

An indicator that shows a loading state.

Uploading dataset…24 MB
import * as stylex from "@stylexjs/stylex"
import { Spinner } from "@/components/ui/spinner"
import { HStack } from "@/components/ui/stack"
import { color, leading, radius, text, width } from "@/theme/tokens.stylex"

const styles = stylex.create({
  row: {
    width: "100%",
    maxWidth: width.xs,
    borderRadius: radius.xl,
    backgroundColor: color.muted,
    fontSize: text.sm,
    lineHeight: leading.sm,
  },
  size: { marginInlineStart: "auto", fontVariantNumeric: "tabular-nums" },
})

export default function SpinnerDemo() {
  return (
    <HStack align="center" gap={3} padding={4} xstyle={styles.row}>
      <Spinner />
      <span>Uploading dataset…</span>
      <span {...stylex.props(styles.size)}>24 MB</span>
    </HStack>
  )
}

Installation

pnpm dlx shadcn@latest add @arene/spinner

Needs the arene setup first.

Usage

import { Spinner } from "@/components/ui/spinner"
<Spinner />

The spinner keeps turning under prefers-reduced-motion: reduce, because a stopped spinner looks like a stalled one.

Variants

default turns a glyph. ring is a ring with one bright head and a tail that fades behind it. dots lights three dots one after another. All three take the same size and colour, and all keep moving under reduced motion.

import * as stylex from "@stylexjs/stylex"
import { Spinner } from "@/components/ui/spinner"
import { HStack } from "@/components/ui/stack"
import { space } from "@/theme/tokens.stylex"

const styles = stylex.create({
  spinner: { width: space.s6, height: space.s6 },
})

export default function SpinnerVariants() {
  return (
    <HStack align="center" gap={8}>
      <Spinner xstyle={styles.spinner} />
      <Spinner variant="ring" xstyle={styles.spinner} />
      <Spinner variant="dots" xstyle={styles.spinner} />
    </HStack>
  )
}

Size

A spinner takes its size from --arene-icon-size, the property a control sets for its icons, so a spinner inside a small button or a badge shrinks with the icons beside it. Give a standalone spinner a width and height through xstyle.

import * as stylex from "@stylexjs/stylex"
import { Spinner } from "@/components/ui/spinner"
import { HStack } from "@/components/ui/stack"
import { space } from "@/theme/tokens.stylex"

const styles = stylex.create({
  xs: { width: space.s3, height: space.s3 },
  sm: { width: space.s4, height: space.s4 },
  md: { width: space.s6, height: space.s6 },
  lg: { width: space.s8, height: space.s8 },
})

export default function SpinnerSize() {
  return (
    <HStack align="center" gap={6}>
      <Spinner xstyle={styles.xs} />
      <Spinner xstyle={styles.sm} />
      <Spinner xstyle={styles.md} />
      <Spinner xstyle={styles.lg} />
    </HStack>
  )
}

Custom icon

Spread spinnerStyles.base onto any icon to give it the spinner's size and rotation. Add role="status" and aria-label yourself; only Spinner sets them for you.

import * as stylex from "@stylexjs/stylex"
import { spinnerStyles } from "@/components/ui/spinner"
import { HStack } from "@/components/ui/stack"
import { SpinnerIcon } from "@phosphor-icons/react/dist/csr/Spinner"
import { SpinnerGapIcon } from "@phosphor-icons/react/dist/csr/SpinnerGap"
import { ArrowsClockwiseIcon } from "@phosphor-icons/react/dist/csr/ArrowsClockwise"

export default function SpinnerCustom() {
  return (
    <HStack align="center" gap={6}>
      <SpinnerIcon role="status" aria-label="Loading" {...stylex.props(spinnerStyles.base)} />
      <SpinnerGapIcon role="status" aria-label="Loading" {...stylex.props(spinnerStyles.base)} />
      <ArrowsClockwiseIcon
        role="status"
        aria-label="Loading"
        {...stylex.props(spinnerStyles.base)}
      />
    </HStack>
  )
}

Button

Place the spinner before the label with iconPosition="start", or after it with iconPosition="end".

import { Button } from "@/components/ui/button"
import { Spinner } from "@/components/ui/spinner"
import { HStack } from "@/components/ui/stack"

export default function SpinnerButton() {
  return (
    <HStack align="center" gap={2} wrap="wrap">
      <Button size="sm" disabled iconPosition="start">
        <Spinner aria-hidden="true" />
        Loading...
      </Button>
      <Button variant="outline" size="sm" disabled iconPosition="start">
        <Spinner aria-hidden="true" />
        Please wait
      </Button>
      <Button variant="outline" size="sm" disabled iconPosition="end">
        Processing
        <Spinner aria-hidden="true" />
      </Button>
    </HStack>
  )
}

Badge

Place the spinner before the label with iconPosition="start", or after it with iconPosition="end".

BuildingDeployingIndexing
import { Badge } from "@/components/ui/badge"
import { Spinner } from "@/components/ui/spinner"
import { HStack } from "@/components/ui/stack"

export default function SpinnerBadge() {
  return (
    <HStack align="center" gap={2} wrap="wrap">
      <Badge iconPosition="start">
        <Spinner aria-hidden="true" />
        Building
      </Badge>
      <Badge variant="secondary" iconPosition="start">
        <Spinner aria-hidden="true" />
        Deploying
      </Badge>
      <Badge variant="outline" iconPosition="end">
        Indexing
        <Spinner aria-hidden="true" />
      </Badge>
    </HStack>
  )
}

Input group

Put the spinner in an InputGroupAddon and position it with the addon's align.

Sending…
import * as stylex from "@stylexjs/stylex"
import { Input } from "@/components/ui/input"
import { InputGroup, InputGroupAddon, InputGroupButton, InputGroupText } from "@/components/ui/input-group"
import { Spinner } from "@/components/ui/spinner"
import { VStack } from "@/components/ui/stack"
import { Textarea, textareaStyles } from "@/components/ui/textarea"
import { ArrowUpIcon } from "@phosphor-icons/react/dist/csr/ArrowUp"
import { widths } from "@/theme/widths"

const styles = stylex.create({
  send: { marginInlineStart: "auto" },
})

export default function SpinnerInputGroup() {
  return (
    <VStack gap={4} xstyle={widths.sm}>
      <InputGroup disabled>
        <Input placeholder="Write a reply" aria-label="Message" />
        <InputGroupAddon align="inline-end">
          <Spinner />
        </InputGroupAddon>
      </InputGroup>
      <InputGroup disabled>
        <Textarea
          placeholder="Write a reply"
          aria-label="Message"
          data-slot="input-group-control"
          xstyle={textareaStyles.inGroup}
        />
        <InputGroupAddon align="block-end">
          <Spinner aria-hidden="true" />
          <InputGroupText>Sending…</InputGroupText>
          <InputGroupButton variant="default" size="icon-xs" aria-label="Send" xstyle={styles.send}>
            <ArrowUpIcon aria-hidden="true" />
          </InputGroupButton>
        </InputGroupAddon>
      </InputGroup>
    </VStack>
  )
}

Spinner renders role="status" with aria-label="Loading", so a screen reader announces it on its own. Pass aria-hidden when the text beside it already says the same thing, such as a button labelled "Loading...".

API reference

Pass render to replace a part's element or compose it with another component.

Spinner renders an <svg> for default and a <span> for ring and dots, and accepts every attribute of its element. Anything you pass overrides its own defaults, including role and aria-label.

Spinner

PropTypeDefault
variant"default" | "ring" | "dots""default"
xstyleStyleXStyles—
classNamestring—
rolestring"status"
aria-labelstring"Loading"

spinnerStyles

The style map behind the component. Spread it onto any element.

KeyWhat it is
baseThe inherited icon size and the rotation
variantsThe ring's mask and the dots' row, by name
dotOne dot and its blink
dotDelaysThe second and third dots' offsets, in order

Data attributes

AttributeOnEffect
data-slot="spinner"the spinnerTargets the glyph from a parent
data-variantthe spinnerMirrors the variant prop