Skip to content

feat(animated-theme-toggler): add new shape variants and examples #947

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Yeom-JinHo merged 10 commits into from
Apr 23, 2026
Merged

feat(animated-theme-toggler): add new shape variants and examples #947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
74e9b33
feat(animated-theme-toggler): add new shape variants and examples
chishiyac Apr 11, 2026
edcd884
feat(animated-theme-toggler): enhance component with new shape varian…
chishiyac Apr 12, 2026
c9fd215
Merge remote-tracking branch 'origin/main' into feat/issue-946-animat…
chishiyac Apr 12, 2026
35a3a14
fix(package.json): add missing newline at end of file
chishiyac Apr 12, 2026
49e960b
fix(docs): update props table formatting for animated theme toggler
chishiyac Apr 12, 2026
5d60d1d
feat(animated-theme-toggler): add triangle shape variant and enchance…
chishiyac Apr 16, 2026
b5de1b8
fix(docs): improve props table formatting for animated theme toggler
chishiyac Apr 17, 2026
ae8a38b
Merge branch 'main' into feat/issue-946-animated-theme-toggler-shape-…
chishiyac Apr 23, 2026
4101064
fix(animated-theme-toggler): scope view-transition CSS to theme toggle
Yeom-JinHo Apr 23, 2026
7a1404a
docs(animated-theme-toggler): expose square variant with demo
Yeom-JinHo Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 57 additions & 6 deletions apps/www/content/docs/components/animated-theme-toggler.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Theme Toggler
date: 2025-08-17
description: An Animated theme toggler component, fully customizable using Tailwind CSS.
description: Animated theme toggle using the View Transitions API with configurable clip-path shapes and origin.
author: Nazam Kalsi
published: true
---
Expand Down Expand Up @@ -36,12 +36,19 @@ npx shadcn@latest add @magicui/animated-theme-toggler

<Step>Add the required CSS into your global CSS file</Step>

The component sets `--magicui-theme-toggle-vt-duration` and a `data-magicui-theme-vt="active"` flag on `<html>` only while a toggle is in flight, so the clip-path animation stays in sync with the view-transition group **without affecting any other view transitions in your app** (e.g. Next.js navigation transitions).

```css title="app/globals.css" showLineNumbers
::view-transition-old(root),
::view-transition-new(root) {
animation: none;
mix-blend-mode: normal;
}

/* Scoped to AnimatedThemeToggler — the toggler sets the data-attribute and the variable only during a theme toggle. */
html[data-magicui-theme-vt="active"]::view-transition-group(root) {
animation-duration: var(--magicui-theme-toggle-vt-duration);
}
```

</Steps>
Expand All @@ -60,13 +67,57 @@ import { AnimatedThemeToggler } from "@/components/ui/animated-theme-toggler"
<AnimatedThemeToggler />
```

Use `variant` to change the clip-path shape of the view transition (`circle`, `square`, `triangle`, `diamond`, `rectangle`, `hexagon`, or `star`):

```tsx showLineNumbers
<AnimatedThemeToggler variant="star" />
```

Expand from the viewport center instead of the button with `fromCenter`:

```tsx showLineNumbers
<AnimatedThemeToggler variant="hexagon" duration={600} fromCenter />
```

## Examples

The preview at the top of this page uses the default **circle** reveal. Below, each variant has its own isolated preview so you can test one shape at a time.

### Square

<ComponentPreview name="animated-theme-toggler-square-demo" />

### Diamond

<ComponentPreview name="animated-theme-toggler-diamond-demo" />

### Rectangle

<ComponentPreview name="animated-theme-toggler-rectangle-demo" />

### Hexagon

<ComponentPreview name="animated-theme-toggler-hexagon-demo" />

### Triangle

<ComponentPreview name="animated-theme-toggler-triangle-demo" />

### Star

<ComponentPreview name="animated-theme-toggler-star-demo" />

## Props

| Prop | Type | Default | Description |
| ----------- | -------- | ------- | ---------------------------------------------------------- |
| `className` | `String` | " " | Additional classes to be added to the component |
| `duration` | `Number` | `400` | Duration of the theme transition animation in milliseconds |
| Prop | Type | Default | Description |
| ------------ | ------------------- | ---------- | ------------------------------------------------------------------------ |
| `className` | `string` | — | Additional classes for the button |
| `duration` | `number` | `400` | Duration of the theme transition animation in milliseconds |
| `variant` | `TransitionVariant` | `"circle"` | Shape used for the view-transition clip-path reveal |
| `fromCenter` | `boolean` | `false` | If true, the clip expands from the viewport center instead of the button |

Export `TransitionVariant` from the same module when you need typed props or menus.

## Credits

- Credit to [Nazam Kalsi](https://nazam-kalsi-portfolio.vercel.app)
- Credit to [Nazam Kalsi](https://nazam-kalsi-portfolio.vercel.app), [chishiyac](https://github.com/chishiyac), [dikshantgulekar20-oss](https://github.com/dikshantgulekar20-oss)
2 changes: 1 addition & 1 deletion apps/www/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,4 @@
"prettier-plugin-tailwindcss"
]
}
}
}
Loading
Loading