Skip to content

Color Theme Selector

Choose a color palette without changing the appearance.

Preview

Color theme

Examples

Theme transition

A slide transition declared on this control. Duration is 500 milliseconds. Other controls keep their own settings.

Color theme

Shadow borders

Use a prominent ambient shadow and inset edge in place of a solid border.

Color theme

When to use

  • Let people choose an app palette without changing light or dark appearance.

  • Show readable labels for the palette keys configured on the provider.

  • Use the floating menu in headers, toolbars, and compact layouts.

When not to use

  • People are choosing light, dark, or system. Use Theme Selector.
  • You need a free-form color picker. This control selects registered palette keys.

Installation

Set up uitheme-web in an existing Tailwind app. Then install the component.

Tailwind version
Source language
npx uitheme-cli add color-theme-selector --base base-ui --tailwind 4 --language ts

To install with shadcn, first add the UI-Theme registry to components.json. The style in components.json selects Radix or Base UI.

npx shadcn@latest add @uitheme/color-theme-selector

Usage

Use the component inside your theme provider. Use import paths that match your app’s component directory.

example.tsx
'use client';

import { UIThemeProvider } from 'uitheme-web/react';
import { ColorThemeSelector } from '@/components/ui/color-theme-selector';

export function Example() {
  return (
    <UIThemeProvider colorThemes={['default', 'caffeine']}>
      <ColorThemeSelector />
    </UIThemeProvider>
  );
}

For inline choices, install Color Theme Disclosure. The floating selector does not install disclosure code.

API reference

These props belong to the installed local control. Configure theme options on the provider.

PropTypeBehavior
labelstringOverride the readable accessible label.
borderStyle'solid' | 'shadow'Use the default solid border or prominent shadow borders. Both use the same space and theme tokens.
classNamestringExtend the root styles. Your classes replace default classes through the local merge helper.
classesobjectStyle root, trigger, content, item, and label parts.
disabledbooleanDisable interaction. Preference controls also wait for the provider to mount.
animationTypeThemeAnimationTypeOverride the UI theme transition for this control. Defaults to the provider setting.
durationnumberUI theme transition duration in milliseconds. Defaults to the provider setting.
slideDirectionSlideDirectionValid only with animationType set to ThemeAnimationType.SLIDE. Other animation types do not accept this prop.
options{ value, label }[]Change palette labels. Values must already exist in the provider’s colorThemes.

Keyboard

KeyAction
Enter / SpaceOpen the selector or confirm the focused palette.
Arrow keysMove between palette options.
EscapeClose the menu and return focus to the trigger.

Accessibility

  • Use readable option labels instead of relying on color swatches alone.
  • Use option values from colorThemes. Custom labels do not register new palettes.

Theme behavior

  • The control calls switchColorTheme. The appearance preference does not change.
  • Register each palette key on the provider. Define its light and dark CSS variables. Selecting a key does not create its colors.

AI Agent notes

Use this checklist when a coding agent adds the control.

  • Use uitheme-web/react for the runtime. Import the control from its installed local file. The runtime does not export styled controls.
  • For Next.js, use NextUIThemeProvider from uitheme-web/next. For TanStack Start, follow the server bootstrap guide. Create server state for each request.
  • Before installation, select the framework, primitive base, Tailwind major version, and language. Run the CLI inside the app or pass --cwd.
  • Preview changes with --dry-run. Keep edited local files. Review the differences before using --overwrite.
  • Keep appearance and colorTheme separate. Use the palette action to change colors.
  • Check that the selected palette changes the computed semantic colors in light and dark appearance. A changed label alone does not confirm this.
  • Check keyboard controls in the running app. Check that appearance and palette choices survive a reload. Check reduced motion.

Source

The CLI reuses your shared cn utility. If it is missing, installation creates it at the configured utils path. Existing utilities are checked before a replacement is offered.

These are the files the CLI installs. The component source stays in your app.

'use client';

import * as React from 'react';
import { useUITheme } from 'uitheme-web/react';
import { cn } from '@/lib/utils';
import type { ThemeControlTransitionProps } from 'uitheme-web/react';
import { CheckIcon, ChevronDownIcon } from 'lucide-react';
import { Select } from '@base-ui/react/select';

export type ColorThemeOption = {
  value: string;
  label: string;
};

export type ColorThemeSelectorClasses = {
  root?: string;
  trigger?: string;
  content?: string;
  item?: string;
  label?: string;
};

export type ColorThemeSelectorProps = ThemeControlTransitionProps & {
  borderStyle?: 'solid' | 'shadow';
  className?: string;
  classes?: ColorThemeSelectorClasses;
  label?: string;
  options?: ColorThemeOption[];
  disabled?: boolean;
};

export const ColorThemeSelector = React.forwardRef<
  HTMLButtonElement,
  ColorThemeSelectorProps
>(function ColorThemeSelector(
  {
    animationType,
    duration,
    slideDirection,
    borderStyle = 'solid',
    className,
    classes,
    label = 'Color theme',
    options: optionOverrides,
    disabled = false,
  }: ColorThemeSelectorProps,
  forwardedRef
) {
  const { colorTheme, colorThemes, mounted, switchColorTheme } = useUITheme();
  const triggerRef = React.useRef<HTMLButtonElement>(null);
  const selected = colorTheme;

  const options: {
    value: string;
    label: string;
  }[] =
    optionOverrides ??
    colorThemes.map((value) => ({
      value,
      label: value
        .replaceAll('-', ' ')
        .replace(/\b\w/g, (letter) => letter.toUpperCase()),
    }));

  React.useImperativeHandle(forwardedRef, () => triggerRef.current!);

  const change = (
    value: string,
    element: HTMLElement | null = triggerRef.current
  ) =>
    switchColorTheme(value, {
      element,
      animationType,
      duration,
      slideDirection,
    });

  return (
    <div className={cn('flex flex-col gap-2', classes?.root, className)}>
      <Select.Root
        items={options}
        value={selected}
        disabled={disabled || !mounted}
        onValueChange={(next) => next && void change(next)}
      >
        <Select.Label
          className={cn('text-sm font-medium text-foreground', classes?.label)}
        >
          {label}
        </Select.Label>
        <Select.Trigger
          ref={triggerRef}
          disabled={disabled || !mounted}
          className={cn(
            'flex h-10 w-full min-w-0 items-center justify-between gap-2 rounded-[var(--radius)] border border-border bg-background px-3 py-2 text-sm text-foreground outline-none transition-[color,box-shadow,border-color] hover:bg-accent/40 focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50 disabled:cursor-not-allowed disabled:opacity-50 motion-reduce:transition-none',
            'data-[border-style=shadow]:[--shadow-border-edge:theme(colors.border)] data-[border-style=shadow]:[--shadow-border-focus:theme(colors.ring)] data-[border-style=shadow]:border-transparent data-[border-style=shadow]:focus-visible:border-transparent data-[border-style=shadow]:ring-0 data-[border-style=shadow]:focus-visible:ring-0 data-[border-style=shadow]:shadow-[0_0_4px_rgb(0_0_0_/_0.25),inset_0_0_0_1px_var(--shadow-border-edge)] data-[border-style=shadow]:forced-colors:outline data-[border-style=shadow]:forced-colors:outline-1 data-[border-style=shadow]:forced-colors:outline-[CanvasText] data-[border-style=shadow]:forced-colors:focus-visible:outline-2 data-[border-style=shadow]:forced-colors:focus-visible:outline-[Highlight] data-[border-style=shadow]:hover:shadow-[0_0_4px_rgb(0_0_0_/_0.25),inset_0_0_0_1px_color-mix(in_oklch,var(--shadow-border-focus)_55%,transparent)] data-[border-style=shadow]:focus-visible:shadow-[0_0_12px_color-mix(in_oklch,var(--shadow-border-focus)_18%,transparent),0_1px_3px_rgb(0_0_0_/_0.1),inset_0_0_0_2px_color-mix(in_oklch,var(--shadow-border-focus)_55%,transparent)]',
            classes?.trigger
          )}
          data-border-style={borderStyle}
        >
          <Select.Value className="min-w-0 truncate text-left" />
          <ChevronDownIcon
            aria-hidden="true"
            className="size-4 shrink-0 text-muted-foreground"
          />
        </Select.Trigger>
        <Select.Portal>
          <Select.Positioner
            alignItemWithTrigger={false}
            sideOffset={6}
            align="start"
          >
            <Select.Popup
              className={cn(
                'z-50 min-w-[var(--anchor-width)] max-h-[min(20rem,var(--available-height,20rem))] overflow-y-auto overscroll-contain rounded-[var(--radius)] border border-border bg-popover p-1 text-popover-foreground shadow-md outline-none [scrollbar-width:thin]',
                'data-[border-style=shadow]:[--shadow-border-edge:theme(colors.border)] data-[border-style=shadow]:[--shadow-border-focus:theme(colors.ring)] data-[border-style=shadow]:border-transparent data-[border-style=shadow]:focus-visible:border-transparent data-[border-style=shadow]:ring-0 data-[border-style=shadow]:focus-visible:ring-0 data-[border-style=shadow]:shadow-[0_0_4px_rgb(0_0_0_/_0.25),inset_0_0_0_1px_var(--shadow-border-edge)] data-[border-style=shadow]:forced-colors:outline data-[border-style=shadow]:forced-colors:outline-1 data-[border-style=shadow]:forced-colors:outline-[CanvasText] data-[border-style=shadow]:forced-colors:focus-visible:outline-2 data-[border-style=shadow]:forced-colors:focus-visible:outline-[Highlight]',
                classes?.content
              )}
              data-border-style={borderStyle}
            >
              <Select.List>
                {options.map((option) => (
                  <Select.Item
                    key={option.value}
                    value={option.value}
                    className={cn(
                      'relative flex min-h-9 w-full cursor-default select-none items-center gap-2 rounded-[max(0px,calc(var(--radius)-4px))] py-2 pl-3 pr-9 text-sm outline-none data-[highlighted]:bg-accent data-[highlighted]:text-accent-foreground data-[selected]:bg-accent/60 data-[state=checked]:bg-accent/60 data-[disabled]:pointer-events-none data-[disabled]:opacity-50',
                      classes?.item
                    )}
                  >
                    <Select.ItemText>{option.label}</Select.ItemText>
                    <Select.ItemIndicator className="absolute right-3 flex size-4 items-center justify-center">
                      <CheckIcon aria-hidden="true" className="size-4" />
                    </Select.ItemIndicator>
                  </Select.Item>
                ))}
              </Select.List>
            </Select.Popup>
          </Select.Positioner>
        </Select.Portal>
      </Select.Root>
    </div>
  );
});

Dependencies: @base-ui/react, lucide-react

Customization

Use borderStyle="shadow" in React or border-style="shadow" in Vue for prominent shadow borders. The default is solid.

Use slideDirection only when animationType is ThemeAnimationType.SLIDE. Set both props on the control when you need a slide direction override.

Pass animationType, duration, and slideDirection to set this control's palette transition. These props override the provider settings for this action only.

Keyboard focus shows the theme’s focus ring.

Edit the installed source. Use className in React or class in Vue to style the root. Use the classes prop to style individual parts. Use label props to change the visible text.