Floating Action Button
Expanding speed-dial FAB: a primary trigger that rotates open to stagger a stack of secondary actions on any side. Compound API.
Example
Installation
npx shadcn@latest add https://hirael.com/r/floating-action-button.jsonUsage
import {
FloatingActionButton,
FloatingActionButtonTrigger,
FloatingActionButtonList,
FloatingActionButtonItem,
} from "@/components/floating-action-button"Paths assume the default @/ alias from your components.json. The example above shows the parts composed.
API
<FloatingActionButton />
+ native element props| Prop | Type | Default |
|---|---|---|
open | boolean | none |
defaultOpen | boolean | none |
onOpenChange | ((open: boolean) => void) | none |
side | FabSide | 'top' |
<FloatingActionButtonTrigger />
+ native element propsNo props of its own; forwards everything to the underlying element.
<FloatingActionButtonList />
+ native element propsNo props of its own; forwards everything to the underlying element.
<FloatingActionButtonItem />
+ native element propsNo props of its own; forwards everything to the underlying element.
Component source
'use client';
import * as React from 'react';
import { type HTMLMotionProps, type Variants, MotionConfig, motion } from 'motion/react';
import { cn } from '@/lib/utils';
type FabSide = 'top' | 'bottom' | 'left' | 'right';
interface FabContextValue {
open: boolean;
setOpen: (open: boolean) => void;
side: FabSide;
}
const FabContext = React.createContext<FabContextValue | null>(null);
const useFab = () => {
const ctx = React.useContext(FabContext);
if (!ctx) {
throw new Error('FloatingActionButton parts must be used within <FloatingActionButton>');
}
return ctx;
};
const listSideClasses: Record<FabSide, string> = {
top: 'bottom-full left-1/2 mb-3 -translate-x-1/2 flex-col-reverse',
bottom: 'top-full left-1/2 mt-3 -translate-x-1/2 flex-col',
left: 'right-full top-1/2 me-3 -translate-y-1/2 flex-row-reverse',
right: 'left-full top-1/2 ms-3 -translate-y-1/2 flex-row',
};
const closedOffset: Record<FabSide, { x?: number; y?: number }> = {
top: { y: 12 },
bottom: { y: -12 },
left: { x: 12 },
right: { x: -12 },
};
const listVariants: Variants = {
open: { transition: { staggerChildren: 0.04, delayChildren: 0.02 } },
closed: { transition: { staggerChildren: 0.03, staggerDirection: -1 } },
};
interface FloatingActionButtonProps extends React.ComponentProps<'div'> {
open?: boolean;
defaultOpen?: boolean;
onOpenChange?: (open: boolean) => void;
side?: FabSide;
}
const FloatingActionButton = ({
open: openProp,
defaultOpen,
onOpenChange,
side = 'top',
className,
children,
...props
}: FloatingActionButtonProps) => {
const [uncontrolled, setUncontrolled] = React.useState(defaultOpen ?? false);
const open = openProp ?? uncontrolled;
const rootRef = React.useRef<HTMLDivElement>(null);
const setOpen = React.useCallback(
(next: boolean) => {
if (openProp === undefined) setUncontrolled(next);
onOpenChange?.(next);
},
[openProp, onOpenChange],
);
React.useEffect(() => {
if (!open) return;
const onPointerDown = (event: PointerEvent) => {
const root = rootRef.current;
if (root && event.target instanceof Node && !root.contains(event.target)) {
setOpen(false);
}
};
document.addEventListener('pointerdown', onPointerDown);
return () => document.removeEventListener('pointerdown', onPointerDown);
}, [open, setOpen]);
const onKeyDown = (event: React.KeyboardEvent<HTMLDivElement>) => {
if (event.key !== 'Escape' || !open) return;
event.stopPropagation();
setOpen(false);
rootRef.current?.querySelector<HTMLElement>('[data-slot="floating-action-button-trigger"]')?.focus();
};
const value = React.useMemo<FabContextValue>(() => ({ open, setOpen, side }), [open, setOpen, side]);
return (
<FabContext.Provider value={value}>
<MotionConfig reducedMotion="user">
<div
ref={rootRef}
data-slot="floating-action-button"
data-state={open ? 'open' : 'closed'}
onKeyDown={onKeyDown}
className={cn('relative inline-flex', className)}
{...props}
>
{children}
</div>
</MotionConfig>
</FabContext.Provider>
);
};
type FloatingActionButtonTriggerProps = HTMLMotionProps<'button'>;
const FloatingActionButtonTrigger = ({ className, children, ...props }: FloatingActionButtonTriggerProps) => {
const { open, setOpen } = useFab();
return (
<motion.button
type="button"
data-slot="floating-action-button-trigger"
data-state={open ? 'open' : 'closed'}
aria-expanded={open}
aria-haspopup="menu"
onClick={() => setOpen(!open)}
animate={{ rotate: open ? 45 : 0 }}
transition={{ duration: 0.2, ease: [0.22, 1, 0.36, 1] }}
className={cn(
'inline-flex size-12 items-center justify-center rounded-full bg-primary text-primary-foreground shadow-lg transition-colors hover:bg-primary/90 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 focus-visible:ring-offset-background [&_svg]:size-5',
className,
)}
{...props}
>
{children}
</motion.button>
);
};
type FloatingActionButtonListProps = HTMLMotionProps<'div'>;
const FloatingActionButtonList = ({ className, ...props }: FloatingActionButtonListProps) => {
const { open, side } = useFab();
const onKeyDown = (event: React.KeyboardEvent<HTMLDivElement>) => {
if (!open) return;
const horizontal = side === 'left' || side === 'right';
const rtl = getComputedStyle(event.currentTarget).direction === 'rtl';
const nextKey = horizontal ? (rtl ? 'ArrowLeft' : 'ArrowRight') : 'ArrowDown';
const prevKey = horizontal ? (rtl ? 'ArrowRight' : 'ArrowLeft') : 'ArrowUp';
if (event.key !== nextKey && event.key !== prevKey) return;
event.preventDefault();
const items = Array.from(
event.currentTarget.querySelectorAll<HTMLElement>('[data-slot="floating-action-button-item"]:not(:disabled)'),
);
if (items.length === 0) return;
let delta = event.key === nextKey ? 1 : -1;
if (side === 'top' || side === 'left') delta = -delta;
const index = items.indexOf(document.activeElement as HTMLElement);
const target = index === -1 ? items[0] : items[(index + delta + items.length) % items.length];
target?.focus();
};
return (
<motion.div
role="menu"
data-slot="floating-action-button-list"
data-state={open ? 'open' : 'closed'}
initial={false}
animate={open ? 'open' : 'closed'}
variants={listVariants}
onKeyDown={onKeyDown}
className={cn(
'absolute z-10 flex items-center gap-2',
listSideClasses[side],
!open && 'pointer-events-none',
className,
)}
{...props}
/>
);
};
type FloatingActionButtonItemProps = HTMLMotionProps<'button'>;
const FloatingActionButtonItem = ({ className, ...props }: FloatingActionButtonItemProps) => {
const { open, side } = useFab();
const itemVariants: Variants = {
open: { opacity: 1, x: 0, y: 0, visibility: 'visible' },
closed: {
opacity: 0,
...closedOffset[side],
transitionEnd: { visibility: 'hidden' },
},
};
return (
<motion.button
type="button"
role="menuitem"
tabIndex={open ? 0 : -1}
aria-hidden={open ? undefined : true}
data-slot="floating-action-button-item"
variants={itemVariants}
transition={{ type: 'spring', stiffness: 300, damping: 24 }}
className={cn(
'inline-flex size-10 items-center justify-center rounded-full border border-border bg-card text-foreground shadow-md transition-colors hover:bg-accent focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring [&_svg]:size-4',
className,
)}
{...props}
/>
);
};
export { FloatingActionButton, FloatingActionButtonTrigger, FloatingActionButtonList, FloatingActionButtonItem };
Dependencies
npm
motion