Getting Started
Components
Special Effects
Animations
Text Animations
Backgrounds
A macOS-style dock component with smooth magnification animation on hover, inspired by the macOS dock.
motion-sv
Dock
preview.svelte
<script lang="ts"> import MailIcon from "@lucide/svelte/icons/mail"; import HomeIcon from "@lucide/svelte/icons/house"; import PencilIcon from "@lucide/svelte/icons/pencil";
import { type Snippet } from "svelte"; import { Separator } from "$lib/components/ui/separator/index.js"; import * as Tooltip from "$lib/components/ui/tooltip/index.js";
import { Dock, DockIcon, type DockIconProps, type DockProps, } from "$lib/components/magic/dock/index.js"; import { cn } from "$lib/utils.js"; import { Button } from "$lib/components/ui/button/index.js";
const DATA = { navbar: [ { href: "#", icon: HomeIcon, label: "Home" }, { href: "#", icon: PencilIcon, label: "Blog" }, ], contact: { social: { GitHub: { name: "GitHub", url: "#", icon: githubLogo, }, LinkedIn: { name: "LinkedIn", url: "#", icon: linkedInLogo, }, X: { name: "X", url: "#", icon: xLogo, }, // email: { // name: "Send Email", // url: "#", // icon: , // }, }, }, };</script>
<div class="flex flex-col items-center justify-center"> <span class="pointer-events-none bg-linear-to-b from-black to-gray-300/80 bg-clip-text text-center text-8xl leading-none font-semibold whitespace-pre-wrap text-transparent dark:from-white dark:to-slate-900/10" > Dock </span> <Tooltip.Provider> <Dock direction="middle"> <!-- {DATA.navbar.map((item) => ( --> {#each DATA.navbar as item} <DockIcon> <Tooltip.Root> <Tooltip.Trigger> <Button href={item.href} aria-label={item.label} variant="ghost" size="icon" class={cn("size-12 rounded-full")} > <item.icon class="size-4" /> </Button> </Tooltip.Trigger> <Tooltip.Content> <p>{item.label}</p> </Tooltip.Content> </Tooltip.Root> </DockIcon> {/each}
<Separator orientation="vertical" class="h-full" /> <!-- {Object.entries(DATA.contact.social).map(([name, social]) => ( --> {#each Object.entries(DATA.contact.social) as [name, social]} {@const socialIcon = social.icon} <DockIcon> <Tooltip.Root> <Tooltip.Trigger> <Button href={social.url} aria-label={social.name} variant="ghost" size="icon" class={cn("size-12 rounded-full")} > <!-- <SocialIcon /> --> {@render socialIcon()} </Button> </Tooltip.Trigger> <Tooltip.Content> <p>{name}</p> </Tooltip.Content> </Tooltip.Root> </DockIcon> {/each} </Dock> </Tooltip.Provider></div>
<!-- All Logo Snippets -->
{#snippet githubLogo()} <svg viewBox="0 0 438.549 438.549"> <path fill="currentColor" d="M409.132 114.573c-19.608-33.596-46.205-60.194-79.798-79.8-33.598-19.607-70.277-29.408-110.063-29.408-39.781 0-76.472 9.804-110.063 29.408-33.596 19.605-60.192 46.204-79.8 79.8C9.803 148.168 0 184.854 0 224.63c0 47.78 13.94 90.745 41.827 128.906 27.884 38.164 63.906 64.572 108.063 79.227 5.14.954 8.945.283 11.419-1.996 2.475-2.282 3.711-5.14 3.711-8.562 0-.571-.049-5.708-.144-15.417a2549.81 2549.81 0 01-.144-25.406l-6.567 1.136c-4.187.767-9.469 1.092-15.846 1-6.374-.089-12.991-.757-19.842-1.999-6.854-1.231-13.229-4.086-19.13-8.559-5.898-4.473-10.085-10.328-12.56-17.556l-2.855-6.57c-1.903-4.374-4.899-9.233-8.992-14.559-4.093-5.331-8.232-8.945-12.419-10.848l-1.999-1.431c-1.332-.951-2.568-2.098-3.711-3.429-1.142-1.331-1.997-2.663-2.568-3.997-.572-1.335-.098-2.43 1.427-3.289 1.525-.859 4.281-1.276 8.28-1.276l5.708.853c3.807.763 8.516 3.042 14.133 6.851 5.614 3.806 10.229 8.754 13.846 14.842 4.38 7.806 9.657 13.754 15.846 17.847 6.184 4.093 12.419 6.136 18.699 6.136 6.28 0 11.704-.476 16.274-1.423 4.565-.952 8.848-2.383 12.847-4.285 1.713-12.758 6.377-22.559 13.988-29.41-10.848-1.14-20.601-2.857-29.264-5.14-8.658-2.286-17.605-5.996-26.835-11.14-9.235-5.137-16.896-11.516-22.985-19.126-6.09-7.614-11.088-17.61-14.987-29.979-3.901-12.374-5.852-26.648-5.852-42.826 0-23.035 7.52-42.637 22.557-58.817-7.044-17.318-6.379-36.732 1.997-58.24 5.52-1.715 13.706-.428 24.554 3.853 10.85 4.283 18.794 7.952 23.84 10.994 5.046 3.041 9.089 5.618 12.135 7.708 17.705-4.947 35.976-7.421 54.818-7.421s37.117 2.474 54.823 7.421l10.849-6.849c7.419-4.57 16.18-8.758 26.262-12.565 10.088-3.805 17.802-4.853 23.134-3.138 8.562 21.509 9.325 40.922 2.279 58.24 15.036 16.18 22.559 35.787 22.559 58.817 0 16.178-1.958 30.497-5.853 42.966-3.9 12.471-8.941 22.457-15.125 29.979-6.191 7.521-13.901 13.85-23.131 18.986-9.232 5.14-18.182 8.85-26.84 11.136-8.662 2.286-18.415 4.004-29.263 5.146 9.894 8.562 14.842 22.077 14.842 40.539v60.237c0 3.422 1.19 6.279 3.572 8.562 2.379 2.279 6.136 2.95 11.276 1.995 44.163-14.653 80.185-41.062 108.068-79.226 27.88-38.161 41.825-81.126 41.825-128.906-.01-39.771-9.818-76.454-29.414-110.049z" ></path> </svg>{/snippet}
{#snippet linkedInLogo()} <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"> <title>LinkedIn</title> <path fill="currentColor" d="M20.447 20.452h-3.554v-5.569c0-1.328-.027-3.037-1.852-3.037-1.853 0-2.136 1.445-2.136 2.939v5.667H9.351V9h3.414v1.561h.046c.477-.9 1.637-1.85 3.37-1.85 3.601 0 4.267 2.37 4.267 5.455v6.286zM5.337 7.433c-1.144 0-2.063-.926-2.063-2.065 0-1.138.92-2.063 2.063-2.063 1.14 0 2.064.925 2.064 2.063 0 1.139-.925 2.065-2.064 2.065zm1.782 13.019H3.555V9h3.564v11.452zM22.225 0H1.771C.792 0 0 .774 0 1.729v20.542C0 23.227.792 24 1.771 24h20.451C23.2 24 24 23.227 24 22.271V1.729C24 .774 23.2 0 22.222 0h.003z" /> </svg>{/snippet}
{#snippet xLogo()} <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"> <title>X</title> <path fill="currentColor" d="M18.901 1.153h3.68l-8.04 9.19L24 22.846h-7.406l-5.8-7.584-6.638 7.584H.474l8.6-9.83L0 1.154h7.594l5.243 6.932ZM17.61 20.644h2.039L6.486 3.24H4.298Z" /> </svg>{/snippet}
{#snippet youtubeLogo()} <svg width="32px" height="32px" viewBox="0 0 32 32" fill="currentColor" xmlns="http://www.w3.org/2000/svg" > <title>youtube</title> <path d="M29.41,9.26a3.5,3.5,0,0,0-2.47-2.47C24.76,6.2,16,6.2,16,6.2s-8.76,0-10.94.59A3.5,3.5,0,0,0,2.59,9.26,36.13,36.13,0,0,0,2,16a36.13,36.13,0,0,0,.59,6.74,3.5,3.5,0,0,0,2.47,2.47C7.24,25.8,16,25.8,16,25.8s8.76,0,10.94-.59a3.5,3.5,0,0,0,2.47-2.47A36.13,36.13,0,0,0,30,16,36.13,36.13,0,0,0,29.41,9.26ZM13.2,20.2V11.8L20.47,16Z" /> </svg>{/snippet}Installation
pnpm dlx shadcn-svelte@latest add https://sv-animations.vercel.app/r/dock.json
Install dependencies
Install the required packages for this component:
pnpm add motion-sv
Copy the Source Code
Copy and paste the following code into your project:
dock.svelte
<script lang="ts" module> import type { MotionValue } from "motion-sv"; import type { ClassValue } from "svelte/elements";
export interface DockProps { class?: ClassValue; iconSize?: number; iconMagnification?: number; disableMagnification?: boolean; iconDistance?: number; direction?: "top" | "middle" | "bottom"; children: Snippet; }
export interface DockContext { mouseX: MotionValue<number>; iconSize: number; iconMagnification: number; disableMagnification: boolean; iconDistance: number; }</script>
<script lang="ts"> import { motion, useMotionValue } from "motion-sv"; import { cn } from "#lib/utils.js"; import type { Snippet } from "svelte"; import { setContext } from "svelte";
const DEFAULT_SIZE = 40; const DEFAULT_MAGNIFICATION = 60; const DEFAULT_DISTANCE = 140;
let { class: className, children, iconSize = DEFAULT_SIZE, iconMagnification = DEFAULT_MAGNIFICATION, disableMagnification = false, iconDistance = DEFAULT_DISTANCE, direction = "middle", }: DockProps = $props();
// Use MotionValue for mouseX - this enables smooth reactive transforms const mouseX = useMotionValue(Infinity);
// Provide context to child DockIcon components setContext("dock", { mouseX, get iconSize() { return iconSize; }, get iconMagnification() { return iconMagnification; }, get disableMagnification() { return disableMagnification; }, get iconDistance() { return iconDistance; }, });</script>
<motion.div onmousemove={(e) => mouseX.set(e.pageX)} onmouseleave={() => mouseX.set(Infinity)} class={cn( "mx-auto mt-8 flex h-14 w-max items-center justify-center gap-2 rounded-2xl border p-2 backdrop-blur-md supports-backdrop-blur:bg-white/10 supports-backdrop-blur:dark:bg-black/10", { "items-start": direction === "top", "items-center": direction === "middle", "items-end": direction === "bottom", }, className )}> {@render children()}</motion.div> dock-icon.svelte
<script lang="ts" module> import type { ClassValue } from "svelte/elements";
export interface DockIconProps { class?: ClassValue; children: Snippet; }</script>
<script lang="ts"> import { motion, useMotionValue, useTransform, useSpring } from "motion-sv"; import { cn } from "#lib/utils.js"; import type { Snippet } from "svelte"; import { getContext } from "svelte"; import type { DockContext } from "./dock.svelte";
let { class: className, children }: DockIconProps = $props();
const DEFAULT_SIZE = 40; const DEFAULT_MAGNIFICATION = 60; const DEFAULT_DISTANCE = 140;
// Get context from parent Dock component const dockContext = getContext<DockContext>("dock");
let ref: HTMLDivElement | null = $state(null);
// Fallback motion value if no context const defaultMouseX = useMotionValue(Infinity); const mouseX = dockContext?.mouseX ?? defaultMouseX;
const size = $derived(dockContext?.iconSize ?? DEFAULT_SIZE); const magnification = $derived(dockContext?.iconMagnification ?? DEFAULT_MAGNIFICATION); const disableMagnification = $derived(dockContext?.disableMagnification ?? false); const distance = $derived(dockContext?.iconDistance ?? DEFAULT_DISTANCE); const padding = $derived(Math.max(6, size * 0.2));
// Transform mouseX to distance from this icon's center const distanceCalc = useTransform(mouseX, (val: number) => { const bounds = ref?.getBoundingClientRect() ?? { x: 0, width: 0 }; return val - bounds.x - bounds.width / 2; });
// Transform distance to size - magnify when mouse is close const sizeTransform = useTransform(distanceCalc, (dist: number) => { const targetSize = disableMagnification ? size : magnification; // Clamp distance to range and interpolate if (Math.abs(dist) >= distance) return size; // Linear interpolation based on distance const progress = 1 - Math.abs(dist) / distance; return size + (targetSize - size) * progress; });
// Apply spring physics for smooth animation const scaleSize = useSpring(sizeTransform, { mass: 0.1, stiffness: 150, damping: 12, });</script>
<motion.div bind:ref style={{ width: scaleSize, height: scaleSize, padding: `${padding}px` }} class={cn( "flex aspect-square cursor-pointer items-center justify-center rounded-full", disableMagnification && "hover:bg-muted-foreground transition-colors", className )}> <div> {@render children()} </div></motion.div> index.ts
export { default as Dock } from "./dock.svelte";export { default as DockIcon } from "./dock-icon.svelte";export type { DockProps, DockContext } from "./dock.svelte";export type { DockIconProps } from "./dock-icon.svelte";Folder Structure
Folder Structure
src/└── lib/ └── components/ └── magic/ └── dock/ ├── dock.svelte ├── dock-icon.svelte └── index.tsInstall and integrate the Svelte component documented below.https://sv-animations.vercel.app/magic/docs/components/dock/llms.txt
Follow the guide's installation and usage instructions.Match the project's existing structure, imports, and styles.Keep changes scoped to the component and verify it works.Reply with a short bullet list of completed changes.Usage
<script lang="ts"> import HomeIcon from "@lucide/svelte/icons/house"; import { Dock, DockIcon } from "#lib/components/magic/dock/index.js";</script>
<Dock> <DockIcon> <button type="button" aria-label="Home"> <HomeIcon class="size-5" /> </button> </DockIcon></Dock>Examples
Direction
Direction: Top
Direction: Middle (Default)
Direction: Bottom
direction.svelte
<script lang="ts"> import Home from "@lucide/svelte/icons/home"; import Search from "@lucide/svelte/icons/search"; import Settings from "@lucide/svelte/icons/settings"; import Bell from "@lucide/svelte/icons/bell";
import { Dock, DockIcon } from "$lib/components/magic/dock/index.js";</script>
<div class="flex flex-col gap-8"> <div class="flex flex-col items-center gap-2"> <span class="text-muted-foreground text-sm">Direction: Top</span> <Dock direction="top" class="mt-0"> <DockIcon class="bg-black/10 dark:bg-white/10"> <Home class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Search class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Bell class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Settings class="size-full" /> </DockIcon> </Dock> </div>
<div class="flex flex-col items-center gap-2"> <span class="text-muted-foreground text-sm">Direction: Middle (Default)</span> <Dock direction="middle" class="mt-0"> <DockIcon class="bg-black/10 dark:bg-white/10"> <Home class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Search class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Bell class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Settings class="size-full" /> </DockIcon> </Dock> </div>
<div class="flex flex-col items-center gap-2"> <span class="text-muted-foreground text-sm">Direction: Bottom</span> <Dock direction="bottom" class="mt-0"> <DockIcon class="bg-black/10 dark:bg-white/10"> <Home class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Search class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Bell class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Settings class="size-full" /> </DockIcon> </Dock> </div></div>Custom Magnification
custom-magnification.svelte
<script lang="ts"> import Cloud from "@lucide/svelte/icons/cloud"; import FileText from "@lucide/svelte/icons/file-text"; import MessageCircle from "@lucide/svelte/icons/message-circle"; import Music from "@lucide/svelte/icons/music";
import { GitHub } from "$lib/components/icons/index.js"; import { Dock, DockIcon } from "$lib/components/magic/dock/index.js";</script>
<div class="relative flex w-full items-center justify-center"> <Dock iconMagnification={60} iconDistance={100}> <DockIcon class="bg-black/10 dark:bg-white/10"> <GitHub class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Cloud class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <FileText class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <MessageCircle class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Music class="size-full" /> </DockIcon> </Dock></div>Colored Icons
colored-icons.svelte
<script lang="ts"> import { Facebook, Instagram, LinkedIn, Twitch, Twitter, YouTube, } from "$lib/components/icons/index.js"; import { Dock, DockIcon } from "$lib/components/magic/dock/index.js";</script>
<div class="relative flex w-full items-center justify-center"> <Dock iconMagnification={70} iconDistance={120}> <DockIcon class="bg-[#1DA1F2]/20 text-[#1DA1F2]"> <Twitter class="size-full" /> </DockIcon> <DockIcon class="bg-gradient-to-br from-[#833AB4]/20 via-[#FD1D1D]/20 to-[#F77737]/20 text-[#E1306C]" > <Instagram class="size-full" /> </DockIcon> <DockIcon class="bg-[#FF0000]/20 text-[#FF0000]"> <YouTube class="size-full" /> </DockIcon> <DockIcon class="bg-[#9146FF]/20 text-[#9146FF]"> <Twitch class="size-full" /> </DockIcon> <DockIcon class="bg-[#0077B5]/20 text-[#0077B5]"> <LinkedIn class="size-full" /> </DockIcon> <DockIcon class="bg-[#1877F2]/20 text-[#1877F2]"> <Facebook class="size-full" /> </DockIcon> </Dock></div>Disabled Magnification
disabled-magnification.svelte
<script lang="ts"> import Folder from "@lucide/svelte/icons/folder"; import Mail from "@lucide/svelte/icons/mail"; import Calendar from "@lucide/svelte/icons/calendar"; import Camera from "@lucide/svelte/icons/camera"; import Gamepad2 from "@lucide/svelte/icons/gamepad-2";
import { Dock, DockIcon } from "$lib/components/magic/dock/index.js";</script>
<div class="relative flex w-full items-center justify-center"> <Dock disableMagnification={true}> <DockIcon class="bg-black/10 dark:bg-white/10"> <Folder class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Mail class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Calendar class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Camera class="size-full" /> </DockIcon> <DockIcon class="bg-black/10 dark:bg-white/10"> <Gamepad2 class="size-full" /> </DockIcon> </Dock></div>Props
Dock
The main dock container that provides context and handles mouse tracking for magnification effects.
| Name | Type | Default | Description |
|---|---|---|---|
class | ClassValue | "" | Additional CSS classes to apply. |
iconSize | number | 40 | The base size of icons in pixels. |
iconMagnification | number | 60 | The magnified size of icons when hovered. |
disableMagnification | boolean | false | Disables the magnification effect on hover. |
iconDistance | number | 140 | The distance in pixels at which magnification starts to take effect. |
direction | "top" | "middle" | "bottom" | "middle" | The alignment direction of icons within the dock. |
children | Snippet | - | The dock icon children to render inside the dock. |
Dock Icon
Individual icon wrapper that responds to the dock's magnification context.
| Name | Type | Default | Description |
|---|---|---|---|
class | ClassValue | "" | Additional CSS classes to apply. |
children | Snippet | - | The icon content to render inside the dock icon. |