Skip to content

UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.

[Feat]: New Component - Animated Scroll Progress (#177)

dipeshtamang07e1c6709491fa
diff --git a/__registry__/index.tsx b/__registry__/index.tsx
index 61d260c9..1f643b8c 100644
--- a/__registry__/index.tsx
+++ b/__registry__/index.tsx
@@ -18,6 +18,19 @@ export const Index: Record<string, any> = {
subcategory: "undefined",
chunks: [],
},
+ "scroll-progress": {
+ name: "scroll-progress",
+ type: "registry:ui",
+ registryDependencies: undefined,
+ files: ["registry/default/magicui/scroll-progress.tsx"],
+ component: React.lazy(
+ () => import("@/registry/default/magicui/scroll-progress.tsx"),
+ ),
+ source: "",
+ category: "undefined",
+ subcategory: "undefined",
+ chunks: [],
+ },
"neon-gradient-card": {
name: "neon-gradient-card",
type: "registry:ui",
@@ -763,6 +776,19 @@ export const Index: Record<string, any> = {
subcategory: "undefined",
chunks: [],
},
+ "scroll-progress-demo": {
+ name: "scroll-progress-demo",
+ type: "registry:example",
+ registryDependencies: ["scroll-progress"],
+ files: ["registry/default/example/scroll-progress-demo.tsx"],
+ component: React.lazy(
+ () => import("@/registry/default/example/scroll-progress-demo.tsx"),
+ ),
+ source: "",
+ category: "undefined",
+ subcategory: "undefined",
+ chunks: [],
+ },
"neon-gradient-card-demo": {
name: "neon-gradient-card-demo",
type: "registry:example",
diff --git a/config/docs.ts b/config/docs.ts
index 90b738d9..865ceff7 100644
--- a/config/docs.ts
+++ b/config/docs.ts
@@ -224,6 +224,12 @@ export const docsConfig: DocsConfig = {
items: [],
label: "",
},
+ {
+ title: "Scroll Progress",
+ href: `/docs/components/scroll-progress`,
+ items: [],
+ label: "New",
+ },
],
},
{
diff --git a/content/docs/components/scroll-progress.mdx b/content/docs/components/scroll-progress.mdx
new file mode 100644
index 00000000..c7bd85af
--- /dev/null
+++ b/content/docs/components/scroll-progress.mdx
@@ -0,0 +1,50 @@
+---
+title: Scroll Progress
+date: 2024-12-19
+description: Animated Scroll Progress for your pages
+author: dipesh_the_dev
+published: true
+---
+
+<ComponentPreview name="scroll-progress-demo" />
+
+## Installation
+
+<Tabs defaultValue="cli">
+<TabsList>
+ <TabsTrigger value="cli">CLI</TabsTrigger>
+ <TabsTrigger value="manual">Manual</TabsTrigger>
+</TabsList>
+<TabsContent value="cli">
+
+```bash
+npx shadcn@latest add "https://magicui.design/r/scroll-progress"
+```
+
+</TabsContent>
+
+<TabsContent value="manual">
+
+<Steps>
+
+<Step>Copy and paste the following code into your project.</Step>
+
+<ComponentSource name="scroll-progress" />
+
+</Steps>
+
+</TabsContent>
+
+</Tabs>
+
+## Props
+
+| Prop | Type | Description | Default |
+| --------- | ------ | --------------------------------------------- | ------- |
+| className | string | The class name to be applied to the component | - |
+
+The `ScrollProgress` component also accepts all properties of the `HTMLDivElement` type.
+
+## Credits
+
+- Credit to [dipesh_the_dev](https://twitter.com/dipesh_the_dev)
diff --git a/public/r/index.json b/public/r/index.json
index 95364329..acfa5057 100644
--- a/public/r/index.json
+++ b/public/r/index.json
@@ -12,6 +12,19 @@
}
]
},
+ {
+ "name": "scroll-progress",
+ "type": "registry:ui",
+ "dependencies": [
+ "framer-motion"
+ ],
+ "files": [
+ {
+ "path": "magicui/scroll-progress.tsx",
+ "type": "registry:ui"
+ }
+ ]
+ },
{
"name": "neon-gradient-card",
"type": "registry:ui",
diff --git a/public/r/styles/default/bento-grid.json b/public/r/styles/default/bento-grid.json
index 9626397f..3d64a53d 100644
--- a/public/r/styles/default/bento-grid.json
+++ b/public/r/styles/default/bento-grid.json
@@ -7,7 +7,7 @@
"files": [
{
"path": "magicui/bento-grid.tsx",
- "content": "import { ReactNode } from \"react\";\nimport { ArrowRightIcon } from \"@radix-ui/react-icons\";\n\nimport { cn } from \"@/lib/utils\";\nimport { Button } from \"@/components/ui/button\";\n\nconst BentoGrid = ({\n children,\n className,\n}: {\n children: ReactNode;\n className?: string;\n}) => {\n return (\n <div\n className={cn(\n \"grid w-full auto-rows-[22rem] grid-cols-3 gap-4\",\n className,\n )}\n >\n {children}\n </div>\n );\n};\n\nconst BentoCard = ({\n name,\n className,\n background,\n Icon,\n description,\n href,\n cta,\n}: {\n name: string;\n className: string;\n background: ReactNode;\n Icon: any;\n description: string;\n href: string;\n cta: string;\n}) => (\n <div\n key={name}\n className={cn(\n \"group relative col-span-3 flex flex-col justify-between overflow-hidden rounded-xl\",\n // light styles\n \"bg-white [box-shadow:0_0_0_1px_rgba(0,0,0,.03),0_2px_4px_rgba(0,0,0,.05),0_12px_24px_rgba(0,0,0,.05)]\",\n // dark styles\n \"transform-gpu dark:bg-black dark:[border:1px_solid_rgba(255,255,255,.1)] dark:[box-shadow:0_-20px_80px_-20px_#ffffff1f_inset]\",\n className,\n )}\n >\n <div>{background}</div>\n <div className=\"pointer-events-none z-10 flex transform-gpu flex-col gap-1 p-6 transition-all duration-300 group-hover:-translate-y-10\">\n <Icon className=\"h-12 w-12 origin-left transform-gpu text-neutral-700 transition-all duration-300 ease-in-out group-hover:scale-75\" />\n <h3 className=\"text-xl font-semibold text-neutral-700 dark:text-neutral-300\">\n {name}\n </h3>\n <p className=\"max-w-lg text-neutral-400\">{description}</p>\n </div>\n\n <div\n className={cn(\n \"pointer-events-none absolute bottom-0 flex w-full translate-y-10 transform-gpu flex-row items-center p-4 opacity-0 transition-all duration-300 group-hover:translate-y-0 group-hover:opacity-100\",\n )}\n >\n <Button variant=\"ghost\" asChild size=\"sm\" className=\"pointer-events-auto\">\n <a href={href}>\n {cta}\n <ArrowRightIcon className=\"ml-2 h-4 w-4\" />\n </a>\n </Button>\n </div>\n <div className=\"pointer-events-none absolute inset-0 transform-gpu transition-all duration-300 group-hover:bg-black/[.03] group-hover:dark:bg-neutral-800/10\" />\n </div>\n);\n\nexport { BentoCard, BentoGrid };\n",
+ "content": "import { ReactNode } from \"react\";\nimport { ArrowRightIcon } from \"@radix-ui/react-icons\";\n\nimport { cn } from \"@/lib/utils\";\nimport { Button } from \"@/components/ui/button\";\n\ntype BentoGridProps = {\n children: ReactNode;\n className?: string;\n};\n\ntype BentoCardProps = {\n name: string;\n className: string;\n background: ReactNode;\n Icon: any;\n description: string;\n href: string;\n cta: string;\n};\n\nconst BentoGrid = ({ children, className }: BentoGridProps) => {\n return (\n <div\n className={cn(\n \"grid w-full auto-rows-[22rem] grid-cols-3 gap-4\",\n className,\n )}\n >\n {children}\n </div>\n );\n};\n\nconst BentoCard = ({\n name,\n className,\n background,\n Icon,\n description,\n href,\n cta,\n}: BentoCardProps) => (\n <div\n key={name}\n className={cn(\n \"group relative col-span-3 flex flex-col justify-between overflow-hidden rounded-xl\",\n // light styles\n \"bg-white [box-shadow:0_0_0_1px_rgba(0,0,0,.03),0_2px_4px_rgba(0,0,0,.05),0_12px_24px_rgba(0,0,0,.05)]\",\n // dark styles\n \"transform-gpu dark:bg-black dark:[border:1px_solid_rgba(255,255,255,.1)] dark:[box-shadow:0_-20px_80px_-20px_#ffffff1f_inset]\",\n className,\n )}\n >\n <div>{background}</div>\n <div className=\"pointer-events-none z-10 flex transform-gpu flex-col gap-1 p-6 transition-all duration-300 group-hover:-translate-y-10\">\n <Icon className=\"h-12 w-12 origin-left transform-gpu text-neutral-700 transition-all duration-300 ease-in-out group-hover:scale-75\" />\n <h3 className=\"text-xl font-semibold text-neutral-700 dark:text-neutral-300\">\n {name}\n </h3>\n <p className=\"max-w-lg text-neutral-400\">{description}</p>\n </div>\n\n <div\n className={cn(\n \"pointer-events-none absolute bottom-0 flex w-full translate-y-10 transform-gpu flex-row items-center p-4 opacity-0 transition-all duration-300 group-hover:translate-y-0 group-hover:opacity-100\",\n )}\n >\n <Button variant=\"ghost\" asChild size=\"sm\" className=\"pointer-events-auto\">\n <a href={href}>\n {cta}\n <ArrowRightIcon className=\"ml-2 h-4 w-4\" />\n </a>\n </Button>\n </div>\n <div className=\"pointer-events-none absolute inset-0 transform-gpu transition-all duration-300 group-hover:bg-black/[.03] group-hover:dark:bg-neutral-800/10\" />\n </div>\n);\n\nexport { BentoCard, BentoGrid };\n",
"type": "registry:ui",
"target": ""
}
diff --git a/public/r/styles/default/scroll-progress.json b/public/r/styles/default/scroll-progress.json
new file mode 100644
index 00000000..25681683
--- /dev/null
+++ b/public/r/styles/default/scroll-progress.json
@@ -0,0 +1,15 @@
+{
+ "name": "scroll-progress",
+ "type": "registry:ui",
+ "dependencies": [
+ "framer-motion"
+ ],
+ "files": [
+ {
+ "path": "magicui/scroll-progress.tsx",
+ "content": "import { cn } from \"@/lib/utils\";\nimport { motion, useScroll, useSpring } from \"framer-motion\";\n\ninterface ScrollProgressProps {\n className?: string;\n}\n\nexport default function ScrollProgress({ className }: ScrollProgressProps) {\n const { scrollYProgress } = useScroll();\n\n const scaleX = useSpring(scrollYProgress, {\n stiffness: 200,\n damping: 50,\n restDelta: 0.001,\n });\n\n return (\n <motion.div\n className={cn(\n \"fixed inset-x-0 top-0 z-[1000] h-1 origin-left bg-gradient-to-r from-[#A97CF8] via-[#F38CB8] to-[#FDCC92]\",\n className,\n )}\n style={{\n scaleX,\n }}\n />\n );\n}\n",
+ "type": "registry:ui",
+ "target": ""
+ }
+ ]
+}
\ No newline at end of file
diff --git a/registry/default/example/scroll-progress-demo.tsx b/registry/default/example/scroll-progress-demo.tsx
new file mode 100644
index 00000000..cb05b66d
--- /dev/null
+++ b/registry/default/example/scroll-progress-demo.tsx
@@ -0,0 +1,20 @@
+import ScrollProgress from "@/registry/default/magicui/scroll-progress";
+
+const ScrollProgressDemo = () => {
+ return (
+ <div className="z-10 rounded-lg border border-gray-200 bg-white p-4">
+ <ScrollProgress className="top-[65px]" />
+ <h2 className="pb-4 font-bold">
+ Note: The scroll progress is shown below the navbar of the page.
+ </h2>
+ <p className="pb-4">
+ Magic UI is a collection of re-usable components that you can copy and
+ paste into your web apps. It primarily features components, blocks, and
+ templates geared towards creating landing pages and user-facing
+ marketing materials.
+ </p>
+ </div>
+ );
+};
+
+export default ScrollProgressDemo;
diff --git a/registry/default/magicui/scroll-progress.tsx b/registry/default/magicui/scroll-progress.tsx
new file mode 100644
index 00000000..2a24d632
--- /dev/null
+++ b/registry/default/magicui/scroll-progress.tsx
@@ -0,0 +1,28 @@
+import { cn } from "@/lib/utils";
+import { motion, useScroll, useSpring } from "framer-motion";
+
+interface ScrollProgressProps {
+ className?: string;
+}
+
+export default function ScrollProgress({ className }: ScrollProgressProps) {
+ const { scrollYProgress } = useScroll();
+
+ const scaleX = useSpring(scrollYProgress, {
+ stiffness: 200,
+ damping: 50,
+ restDelta: 0.001,
+ });
+
+ return (
+ <motion.div
+ className={cn(
+ "fixed inset-x-0 top-0 z-[1000] h-1 origin-left bg-gradient-to-r from-[#A97CF8] via-[#F38CB8] to-[#FDCC92]",
+ className,
+ )}
+ style={{
+ scaleX,
+ }}
+ />
+ );
+}
diff --git a/registry/registry-examples.ts b/registry/registry-examples.ts
index a837ce31..ae7a2098 100644
--- a/registry/registry-examples.ts
+++ b/registry/registry-examples.ts
@@ -7,6 +7,12 @@ export const examples: Registry = [
registryDependencies: ["magic-card"],
files: ["example/magic-card-demo.tsx"],
},
+ {
+ name: "scroll-progress-demo",
+ type: "registry:example",
+ registryDependencies: ["scroll-progress"],
+ files: ["example/scroll-progress-demo.tsx"],
+ },
{
name: "neon-gradient-card-demo",
type: "registry:example",
diff --git a/registry/registry-ui.ts b/registry/registry-ui.ts
index df307a5b..b9a2ed77 100644
--- a/registry/registry-ui.ts
+++ b/registry/registry-ui.ts
@@ -7,6 +7,12 @@ export const ui: Registry = [
dependencies: ["framer-motion"],
files: ["magicui/magic-card.tsx"],
},
+ {
+ name: "scroll-progress",
+ type: "registry:ui",
+ dependencies: ["framer-motion"],
+ files: ["magicui/scroll-progress.tsx"],
+ },
{
name: "neon-gradient-card",
type: "registry:ui",