Follow Button
Overview
A follow button that morphs its width, fill, and label between states.
This action component is intended for interfaces that need a follow button that morphs its width, fill, and label between states, SaaS workflows, and onboarding flows. Its implementation is provided as editable source so the final behavior and styling stay inside your project.
Technologies
Detected package dependencies: framer-motion, lucide-react.
Arihant Jain
@arihantcodes
2,847followers
Installation
Usage
import { FollowButton } from "@/components/spectrumui/follow-button"<FollowButton onFollowingChange={(following) => console.log(following)} />API Reference
FollowButton
Renders a single button element with aria-pressed reflecting the following state. Pass following to control it from outside, or defaultFollowing to let it manage its own state.
| Prop | Type | Default | Description |
|---|---|---|---|
following | boolean | - | Controlled following state. Leave undefined for uncontrolled usage |
defaultFollowing | boolean | false | Initial following state when uncontrolled |
onFollowingChange | (following: boolean) => void | - | Fires with the next following state on every toggle |
followLabel | string | "Follow" | Label of the idle call-to-action pill |
followingLabel | string | "Following" | Label shown while followed |
unfollowLabel | string | "Unfollow" | Label revealed on hover or focus while followed |
size | "sm" | "md" | "lg" | "md" | Visual size of the button |
disabled | boolean | false | Disables pointer and keyboard interaction |
className | string | - | Additional classes merged with the default button styles |
Examples
Sizes and custom labels
Use cases
- interfaces that need a follow button that morphs its width, fill, and label between states
- SaaS workflows
- onboarding flows
Features
- Copy-paste source that remains in your repository
- TypeScript source included with the component
- Tailwind CSS classes editable in the component source
- Animation implemented with Motion
- Responsive Tailwind variants present in the source
- Reduced-motion handling present in the source
Accessibility
- The source includes ARIA attributes or roles; preserve them when customizing the component.
- The source checks reduced-motion preferences or includes motion-reduce styles.
- Test focus order, keyboard operation, labels, contrast, and screen-reader output in the final application context.
Customization
- Edit the Tailwind utility classes in the copied source to match your spacing, color, and typography tokens.
- Use the documented className surface for local layout adjustments, then edit the source for structural changes.
- Adjust Motion transitions in the source and keep the reduced-motion behavior aligned with the final interaction.
Related components
Topic guides
See how this component fits into broader interface patterns, implementation decisions, and working examples.
Follow Button FAQ
Is Follow Button free to use in commercial projects?
Yes. The public Follow Button source is available under the Apache License 2.0, including for commercial use, subject to the LICENSE terms.
How do I install Follow Button?
Run npx shadcn@latest add @spectrumui/follow-button. The page also exposes the source for manual installation.
Does Follow Button require Motion?
Yes. Motion usage was detected in the documented source or registry dependencies for Follow Button.
Does Follow Button use shadcn/ui or Radix UI?
No shadcn/ui or Radix UI dependency was detected in the documented Follow Button source.
Can I use Follow Button in Next.js?
The documented React source is used in this Next.js application. Keep its use client directive when copying it into the App Router. Install the detected dependencies and verify any application-specific data or image configuration.
What accessibility checks should I run for Follow Button?
The source includes ARIA markup, reduced-motion handling. Test the finished interface with keyboard and screen-reader workflows.