### Sidebar Documentation Source: https://ui.aceternity.com/components/sidebar Documentation for the Aceternity UI Sidebar component, including installation, examples, and props. ```APIDOC ## Aceternity UI Sidebar ### Description An expandable sidebar that expands on hover, with mobile responsiveness and dark mode support. ### Installation #### CLI ```bash npx shadcn@latest add @aceternity/sidebar ``` #### Manual ### Example #### Default sidebar open Use the prop `animate={false}` to disable the animation. ```jsx {/* Sidebar content */} ``` ### Props #### SidebarProvider Props | Prop Name | Type | Default | Description | |-----------|----------------------|---------|------------------------------------------------| | `children`| `React.ReactNode` | - | The content to be rendered inside the provider. | | `open` | `boolean` | `false` | Controls the open state of the sidebar. | | `setOpen` | `React.Dispatch>` | - | Function to set the open state of the sidebar. | #### Sidebar Props | Prop Name | Type | Default | Description | |-----------|----------------------|---------|------------------------------------------------| | `children`| `React.ReactNode` | - | The content to be rendered inside the sidebar. | | `open` | `boolean` | `false` | Controls the open state of the sidebar. | | `setOpen` | `React.Dispatch>` | - | Function to set the open state of the sidebar. | | `animate` | `boolean` | `true` | Controls the animation of the sidebar. | #### SidebarBody Props | Prop Name | Type | Default | Description | |-----------|----------------------|---------|------------------------------------------------| | `props` | `React.ComponentProps<'div'>` | - | Props to be passed to the `motion.div` component. | #### DesktopSidebar Props | Prop Name | Type | Default | Description | |-----------|----------------------|---------|------------------------------------------------| | `className`| `string` | - | Additional class names for styling. | | `children`| `React.ReactNode` | - | The content to be rendered inside the desktop sidebar. | | `props` | `React.ComponentProps<'div'>` | - | Props to be passed to the `motion.div` component. | #### MobileSidebar Props | Prop Name | Type | Default | Description | |-----------|----------------------|---------|------------------------------------------------| | `className`| `string` | - | Additional class names for styling. | | `children`| `React.ReactNode` | - | The content to be rendered inside the mobile sidebar. | | `props` | `React.ComponentProps<'div'>` | - | Props to be passed to the `div` component. | #### SidebarLink Props | Prop Name | Type | Default | Description | |-----------|----------------------|---------|------------------------------------------------| | `link` | `Links` | - | The link object containing label, href, and icon. | | `className`| `string` | - | Additional class names for styling. | | `props` | `LinkProps` | - | Props to be passed to the `Link` component. | ### Links Interface | Property | Type | Description | |----------|-----------------------------------|------------------------------------------------| | `label` | `string` | The text label for the link. | | `href` | `string` | The URL the link points to. | | `icon` | `React.JSX.Element | React.ReactNode` | The icon to be displayed alongside the link. | ### SidebarContextProps Interface | Property | Type | Description | |---|---|---| ``` -------------------------------- ### Install Aceternity Signup Form Demo with Shadcn CLI Source: https://ui.aceternity.com/components/signup-form This command installs the Aceternity signup form demo component using the Shadcn CLI. Ensure you have Node.js and npm/yarn installed. The command adds the necessary files and configurations to your project. ```bash npx shadcn@latest add @aceternity/signup-form-demo ``` -------------------------------- ### Install Tracing Beam with shadcn CLI Source: https://ui.aceternity.com/components/tracing-beam Installs the Tracing Beam component using the shadcn CLI. This command fetches and integrates the necessary files into your project for using the component. ```bash npx shadcn@latest add @aceternity/tracing-beam ``` -------------------------------- ### Install Aceternity UI Components via CLI Source: https://ui.aceternity.com/components/cards This command installs specific Aceternity UI card demo components using the shadcn CLI. Ensure you have Node.js and npm/yarn installed. This is a quick way to integrate pre-designed components into your project. ```bash npx shadcn@latest add @aceternity/cards-demo-1 @aceternity/cards-demo-2 @aceternity/cards-demo-3 ``` -------------------------------- ### Install Shooting Stars and Stars Background Component Source: https://ui.aceternity.com/components/shooting-stars-and-stars-background This snippet shows how to install the 'shooting-stars' and 'stars-background' component using the Aceternity CLI. Ensure you have Next.js and Tailwind CSS installed in your project. ```bash npx shadcn@latest add @aceternity/shooting-stars stars-background ``` -------------------------------- ### Install Spotlight Component using Shadcn CLI Source: https://ui.aceternity.com/components/spotlight This command installs the Spotlight component using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS configured in your project. ```bash npx shadcn@latest add @aceternity/spotlight ``` -------------------------------- ### Install Lamp Component using Shadcn CLI Source: https://ui.aceternity.com/components/lamp-effect This command installs the Aceternity Lamp component using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS installed in your project. The command adds the necessary package and configuration to your project. ```bash npx shadcn@latest add @aceternity/lamp ``` -------------------------------- ### Install Link Preview Component with shadcn-ui Source: https://ui.aceternity.com/components/link-preview This command installs the Link Preview component using the shadcn-ui CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/link-preview ``` -------------------------------- ### Layout Grid Installation Source: https://ui.aceternity.com/components/layout-grid Instructions for installing the Layout Grid component using the shadcn CLI. ```APIDOC ## Installation ### CLI Run the following command: ```bash npx shadcn@latest add @aceternity/layout-grid ``` ``` -------------------------------- ### Install Evervault Card using CLI Source: https://ui.aceternity.com/components/evervault-card This command installs the Evervault Card component using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/evervault-card ``` -------------------------------- ### Install Expandable Card Demo Components Source: https://ui.aceternity.com/components/expandable-card Install the standard and grid demo components for the Expandable Card using the Aceternity CLI. This command adds the necessary packages to your project. ```bash npx shadcn@latest add @aceternity/expandable-card-demo-standard @aceternity/expandable-card-demo-grid ``` -------------------------------- ### Install Compare Component (CLI) Source: https://ui.aceternity.com/components/compare Use the Aceternity UI CLI to add the Compare component and its dependency, Sparkles, to your project. This is the recommended installation method for quick integration. ```bash npx shadcn@latest add @aceternity/compare @aceternity/sparkles ``` -------------------------------- ### Install Animated Tooltip with Shadcn CLI Source: https://ui.aceternity.com/components/animated-tooltip This command installs the Animated Tooltip component from Aceternity UI using the shadcn/ui CLI. Ensure you have Node.js and npm/yarn installed. This is the recommended way to integrate the component into your project. ```bash npx shadcn@latest add @aceternity/animated-tooltip ``` -------------------------------- ### Install Dependencies with npm Source: https://ui.aceternity.com/components/add-utilities Installs necessary dependencies for Aceternity UI, including motion, clsx, and tailwind-merge. These libraries are essential for the UI components' functionality and styling. ```bash npm i motion clsx tailwind-merge Copy ``` -------------------------------- ### Install Aceternity Card Spotlight Component (CLI) Source: https://ui.aceternity.com/components/card-spotlight This command installs the 'card-spotlight' component from Aceternity UI using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS configured in your project. ```bash npx shadcn@latest add @aceternity/card-spotlight ``` -------------------------------- ### Install Wavy Background Component (CLI) Source: https://ui.aceternity.com/components/wavy-background Installs the Wavy Background component using the shadcn CLI. This component creates a dynamic wave effect using canvas. It requires Node.js and npm/yarn/pnpm to be installed. ```bash npx shadcn@latest add @aceternity/wavy-background ``` -------------------------------- ### Install Focus Cards Component (CLI) Source: https://ui.aceternity.com/components/focus-cards Install the Focus Cards component using the Aceternity UI CLI. This is the recommended method for quick integration into your Next.js project. ```bash npx shadcn@latest add @aceternity/focus-cards ``` -------------------------------- ### Install Tailwind CSS v3 with Next.js (Legacy) Source: https://ui.aceternity.com/components/install-tailwindcss Installs Tailwind CSS version 3 for a Next.js project. This is a legacy installation process that includes installing Tailwind CSS, PostCSS, and Autoprefixer, initializing the configuration files, and setting up the content paths. ```bash npx create-next-app@latest my-project --typescript --eslint cd my-project npm install -D tailwindcss postcss autoprefixer npx tailwindcss init -p ``` -------------------------------- ### Install Tailwind CSS v4 with Next.js Source: https://ui.aceternity.com/components/install-tailwindcss Installs Tailwind CSS version 4 for a Next.js project. Requires Node.js and npm/yarn. This process involves creating a new Next.js app, installing Tailwind CSS and its PostCSS plugin, configuring PostCSS, and starting the development server. ```bash npx create-next-app@latest my-project --typescript --eslint cd my-project npm install tailwindcss @tailwindcss/postcss @tailwindcss/cli ``` ```bash npm run dev ``` -------------------------------- ### Install Infinite Moving Cards using CLI Source: https://ui.aceternity.com/components/infinite-moving-cards This command installs the Infinite Moving Cards component for Aceternity UI. It requires Node.js and npm/npx to be installed. The command adds the necessary package to your project, enabling the use of the component. ```bash npx shadcn@latest add @aceternity/infinite-moving-cards ``` -------------------------------- ### Hover Border Gradient Component Source: https://ui.aceternity.com/components/hover-border-gradient Documentation for the Hover Border Gradient component, including installation, props, and examples. ```APIDOC ## POST /ui.aceternity.com/llmstxt ### Description This section details the Hover Border Gradient component from Aceternity UI. It describes how to install and use the component, along with its available props. ### Method GET ### Endpoint /ui.aceternity.com/llmstxt ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) This documentation section outlines the component's properties and how to integrate it. #### Response Example None ``` -------------------------------- ### Install GitHub Globe Component with shadcn-ui CLI Source: https://ui.aceternity.com/components/github-globe This command installs the GitHub Globe component using the shadcn-ui CLI. Ensure you have Next.js and Tailwind CSS installed in your project. The CLI will handle the necessary file additions. ```bash npx shadcn@latest add @aceternity/globe ``` -------------------------------- ### Install Navbar Menu Component using Shadcn CLI Source: https://ui.aceternity.com/components/navbar-menu This command installs the Navbar Menu component from Aceternity UI using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS installed in your project. ```bash npx shadcn@latest add @aceternity/navbar-menu ``` -------------------------------- ### Install Component from Aceternity UI Registry Source: https://ui.aceternity.com/components/cli Installs a specific Aceternity UI component directly from its registry URL using the Shadcn CLI. This allows for easy integration of pre-designed components into your project. ```bash npx shadcn@latest add https://ui.aceternity.com/registry/[component].json ``` -------------------------------- ### Install Aceternity Sidebar using CLI Source: https://ui.aceternity.com/components/sidebar This command uses the shadcn-ui CLI to add the Aceternity sidebar component to your project. Ensure you have Next.js and Tailwind CSS installed. ```bash npx shadcn@latest add @aceternity/sidebar ``` -------------------------------- ### Install Bento Grid Component with CLI Source: https://ui.aceternity.com/components/bento-grid This command installs the Bento Grid component from Aceternity UI using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/bento-grid ``` -------------------------------- ### Install World Map Component with shadcn-ui CLI Source: https://ui.aceternity.com/components/world-map Install the world map component using the shadcn-ui CLI. This command fetches and integrates the necessary package into your project. ```bash npx shadcn@latest add @aceternity/world-map ``` -------------------------------- ### Install Aceternity Tabs Component using Shadcn CLI Source: https://ui.aceternity.com/components/tabs This command installs the Aceternity Tabs component into your project using the Shadcn UI CLI. Ensure you have Next.js and Tailwind CSS set up. ```bash npx shadcn@latest add @aceternity/tabs ``` -------------------------------- ### Install Hero Highlight Component with Shadcn CLI Source: https://ui.aceternity.com/components/hero-highlight This command installs the Hero Highlight component from Aceternity UI using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/hero-highlight ``` -------------------------------- ### Install Hover Effect Component with Shadcn CLI Source: https://ui.aceternity.com/components/card-hover-effect This command installs the 'card-hover-effect' component from Aceternity UI using the Shadcn CLI. Ensure you have Shadcn CLI 3.0 or later installed and configured in your Next.js project. ```bash npx shadcn@latest add @aceternity/card-hover-effect ``` -------------------------------- ### Install Floating Dock Component (CLI) Source: https://ui.aceternity.com/components/floating-dock Installs the Aceternity UI floating dock component using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/floating-dock ``` -------------------------------- ### Install Hero Section Demo with Shadcn CLI Source: https://ui.aceternity.com/components/hero-sections This command installs a specific hero section demo component using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. This command is specific to the Aceternity UI project structure. ```bash npx shadcn@latest add @aceternity/hero-section-demo-1 ``` -------------------------------- ### Install Timeline Component via CLI Source: https://ui.aceternity.com/components/timeline This command uses the shadcn CLI to add the Aceternity timeline component to your project. Ensure you have Next.js and Tailwind CSS installed. ```bash npx shadcn@latest add @aceternity/timeline ``` -------------------------------- ### Install Background Lines Component with Shadcn CLI Source: https://ui.aceternity.com/components/background-lines This command installs the background-lines component from Aceternity UI using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS installed. The component adds animated SVG paths for hero section backgrounds. ```bash npx shadcn@latest add @aceternity/background-lines ``` -------------------------------- ### Install Sparkles Component using Shadcn CLI Source: https://ui.aceternity.com/components/sparkles This command installs the Sparkles component into your project using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up. ```bash npx shadcn@latest add @aceternity/sparkles ``` -------------------------------- ### Install Sticky Scroll Reveal Component (CLI) Source: https://ui.aceternity.com/components/sticky-scroll-reveal This command installs the 'sticky-scroll-reveal' component from Aceternity UI using the shadcn CLI. Ensure you have the shadcn CLI set up in your Next.js project. ```bash npx shadcn@latest add @aceternity/sticky-scroll-reveal ``` -------------------------------- ### Install Glowing Effect Component using CLI Source: https://ui.aceternity.com/components/glowing-effect This command installs the 'glowing-effect' component from Aceternity UI using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/glowing-effect ``` -------------------------------- ### Install Animated Testimonials using CLI Source: https://ui.aceternity.com/components/animated-testimonials This command installs the animated testimonials component using the Aceternity UI CLI. It's a straightforward way to add the component to your project, assuming you have Next.js and Tailwind CSS configured. ```bash npx shadcn@latest add @aceternity/animated-testimonials ``` -------------------------------- ### Install Layout Grid Component with Shadcn CLI Source: https://ui.aceternity.com/components/layout-grid This command installs the Layout Grid component into your project using the shadcn-ui CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/layout-grid ``` -------------------------------- ### Install Resizable Navbar with Shadcn CLI Source: https://ui.aceternity.com/components/resizable-navbar This command installs the Resizable Navbar component using the Shadcn UI CLI. Ensure you have Next.js and Tailwind CSS configured in your project. ```bash npx shadcn@latest add @aceternity/resizable-navbar ``` -------------------------------- ### Install Aurora Background Component (CLI) Source: https://ui.aceternity.com/components/aurora-background This command installs the Aurora Background component using the shadcn CLI. Ensure you have Next.js and Tailwind CSS configured in your project. ```bash npx shadcn@latest add @aceternity/aurora-background ``` -------------------------------- ### Install Lens Component with CLI Source: https://ui.aceternity.com/components/lens This snippet shows the command to add the Lens component to your project using the shadcn CLI. Ensure you have Next.js and Tailwind CSS installed. ```bash npx shadcn@latest add @aceternity/lens ``` -------------------------------- ### Install Multi Step Loader using Shadcn CLI Source: https://ui.aceternity.com/components/multi-step-loader This command installs the Multi Step Loader component into your project using the Shadcn UI CLI. Ensure you have Next.js and Tailwind CSS configured in your project. ```bash npx shadcn@latest add @aceternity/multi-step-loader ``` -------------------------------- ### Install Google Gemini Effect Component (CLI) Source: https://ui.aceternity.com/components/google-gemini-effect This command installs the Google Gemini Effect component using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/google-gemini-effect ``` -------------------------------- ### Grid Background Component Example Source: https://ui.aceternity.com/components/grid-and-dot-backgrounds An example of how to implement a grid background using Aceternity UI components. This snippet demonstrates the basic structure for applying a grid pattern to enhance visual appeal. ```javascript // Example for Grid Background ``` -------------------------------- ### Install Wobble Card Component with Shadcn CLI Source: https://ui.aceternity.com/components/wobble-card This command installs the Wobble Card component using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS configured in your project. ```bash npx shadcn@latest add @aceternity/wobble-card ``` -------------------------------- ### Animated Modal Component Documentation Source: https://ui.aceternity.com/components/animated-modal Documentation for the Animated Modal component, including installation, props, and usage. ```APIDOC ## Animated Modal A customizable, compound modal component with animated transitions and special utilities. ### Description This component provides a highly customizable modal with animated transitions, suitable for various UI needs. ### Method N/A (Component Documentation) ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example ```json { "example": "This is a placeholder for a request example, if applicable." } ``` ### Response #### Success Response (N/A) N/A #### Response Example ```json { "example": "This is a placeholder for a response example, if applicable." } ``` ## Installation ### CLI ```bash npx shadcn@latest add @aceternity/animated-modal ``` ### Manual (Manual installation steps would be detailed here if provided in the source text) ## Props ### ModalProvider Prop | Type | Description | |-----------|---------------------------------------------| | ReactNode | The content to be wrapped by the provider. | ### Modal Prop | Type | Description | |-----------|---------------------------------------------| | ReactNode | The content to be displayed inside the modal. | ### ModalTrigger Prop | Type | Description | |-----------|---------------------------------------------------| | ReactNode | The content to be displayed inside the trigger button. | | string? | Optional additional class names for the trigger button. | ### ModalBody Prop | Type | Description | |-----------|-------------------------------------------------| | ReactNode | The content to be displayed inside the modal body. | | string? | Optional additional class names for the modal body. | ### ModalContent Prop | Type | Description | |-----------|---------------------------------------------------| | ReactNode | The content to be displayed inside the modal content. | | string? | Optional additional class names for the modal content. | ### ModalFooter Prop | Type | Description | |-----------|-------------------------------------------------| | ReactNode | The content to be displayed inside the modal footer. | | string? | Optional additional class names for the modal footer. | ### Overlay Prop | Type | Description | |-----------|-----------------------------------------------| | string? | Optional additional class names for the overlay. | ### useOutsideClick Prop | Type | Description | |-------------------|------------------------------------------------------------| | `React.RefObject` | The reference to the element to detect outside clicks. | | `Function` | The callback function to be called when an outside click is detected. | ``` -------------------------------- ### Install Background Gradient Component (CLI) Source: https://ui.aceternity.com/components/background-gradient This command uses the Shadcn CLI to add the background gradient component to your project. Ensure you have Next.js and Tailwind CSS installed. ```bash npx shadcn@latest add @aceternity/background-gradient ``` -------------------------------- ### Install 3D Pin Component with shadcn CLI Source: https://ui.aceternity.com/components/3d-pin This command installs the 3D Pin component from Aceternity UI using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. This command adds the necessary package and configurations to your project. ```bash npx shadcn@latest add @aceternity/3d-pin ``` -------------------------------- ### Dot Background Component Example Source: https://ui.aceternity.com/components/grid-and-dot-backgrounds Demonstrates the implementation of a dot background using Aceternity UI. This example showcases how to apply a dotted pattern, adding a distinct aesthetic to web page sections. ```javascript // Example for Dot Background ``` -------------------------------- ### Install Vortex Background Component (CLI) Source: https://ui.aceternity.com/components/vortex This snippet shows how to install the Vortex Background component using the shadcn CLI. It requires a Next.js project with Tailwind CSS configured. ```bash npx shadcn@latest add @aceternity/vortex ``` -------------------------------- ### Install 3D Card Effect with CLI Source: https://ui.aceternity.com/components/3d-card-effect This command installs the @aceternity/3d-card package using the shadcn-ui CLI. Ensure you have Next.js and Tailwind CSS set up in your project before running this command. ```bash npx shadcn@latest add @aceternity/3d-card ``` -------------------------------- ### Install Background Gradient Animation using CLI Source: https://ui.aceternity.com/components/background-gradient-animation This command installs the background gradient animation component using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/background-gradient-animation ``` -------------------------------- ### Add Aceternity Component using Shadcn CLI Source: https://ui.aceternity.com/components/cli Installs a specific component from the Aceternity registry into your project using the Shadcn CLI. This command requires npm, yarn, or bun to be installed. ```bash npx shadcn@latest add @aceternity/[component] ``` ```bash npx shadcn@latest add @aceternity/3d-marquee ``` -------------------------------- ### Install Text Reveal Card using shadcn-ui CLI Source: https://ui.aceternity.com/components/text-reveal-card This command installs the Text Reveal Card component using the shadcn-ui CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/text-reveal-card ``` -------------------------------- ### Install Background Beams Component with Shadcn CLI Source: https://ui.aceternity.com/components/background-beams This command installs the 'background-beams' component from Aceternity UI using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/background-beams ``` -------------------------------- ### Standard Expandable Card Example Source: https://ui.aceternity.com/components/expandable-card A standard implementation of the Expandable Card component. This example demonstrates how to display cards that expand to reveal more content upon clicking. It includes placeholders for images and text content. ```jsx PreviewCode Copy promptOpen in Copy promptOpen in !["Summertime Sadness"](https://assets.aceternity.com/demos/lana-del-rey.jpeg) ### Summertime Sadness Lana Del Rey Play ![Mitran Di Chhatri](https://assets.aceternity.com/demos/babbu-maan.jpeg) ### Mitran Di Chhatri Babbu Maan Play ![For Whom The Bell Tolls](https://assets.aceternity.com/demos/metallica.jpeg) ### For Whom The Bell Tolls Metallica Play ![Stairway To Heaven](https://assets.aceternity.com/demos/led-zeppelin.jpeg) ### Stairway To Heaven Led Zeppelin Play ![Toh Phir Aao](https://assets.aceternity.com/demos/toh-phir-aao.jpeg) ### Toh Phir Aao Mustafa Zahid Play ``` -------------------------------- ### Expandable Sidebar Example (React) Source: https://ui.aceternity.com/components/sidebar Demonstrates the default usage of the expandable sidebar in a React application. This includes a basic structure with profile information and navigation links. ```jsx import { Sidebar } from "@aceternity/sidebar"; function App() { return ( {/* Sidebar content here */} }} /> }} /> }} /> }} /> {/* Desktop specific content */} {/* Mobile specific content */} ); } ``` -------------------------------- ### Install Following Pointer Component with Shadcn CLI Source: https://ui.aceternity.com/components/following-pointer This command installs the 'following-pointer' component from Aceternity UI using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. This component provides a custom pointer that follows the mouse cursor. ```bash npx shadcn@latest add @aceternity/following-pointer ``` -------------------------------- ### Install Carousel Component with shadcn-ui CLI Source: https://ui.aceternity.com/components/carousel This command installs the Aceternity UI Carousel component using the shadcn-ui CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/carousel ``` -------------------------------- ### Initialize Project with Shadcn CLI Source: https://ui.aceternity.com/components/cli Initializes a new project with Aceternity UI components using the Shadcn CLI. This command installs dependencies, adds the 'cn' utility, configures tailwind.config.js, and sets up CSS variables. It prompts for configuration choices like style and base color. ```bash npx shadcn@latest init ``` -------------------------------- ### Install Card Stack Component using shadcn/ui CLI Source: https://ui.aceternity.com/components/card-stack This command installs the 'card-stack' component using the shadcn/ui CLI. Ensure you have Next.js and Tailwind CSS set up in your project. This component is great for displaying testimonials or similar content with an engaging stacking effect. ```bash npx shadcn@latest add @aceternity/card-stack ``` -------------------------------- ### Install Moving Border Component with Shadcn CLI Source: https://ui.aceternity.com/components/moving-border This command installs the 'moving-border' component using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS set up. This command directly adds the necessary files to your project. ```bash npx shadcn@latest add @aceternity/moving-border ``` -------------------------------- ### Install Aceternity File Upload Component via CLI Source: https://ui.aceternity.com/components/file-upload This command installs the Aceternity UI file upload component into your project using the shadcn-ui CLI. Ensure you have Next.js and Tailwind CSS configured. ```bash npx shadcn@latest add @aceternity/file-upload ``` -------------------------------- ### Sparkles Component Usage Example Source: https://ui.aceternity.com/components/sparkles A basic example demonstrating how to use the Sparkles component in your React application. This snippet assumes you have the component installed and imported. ```jsx import { Sparkles } from "@aceternity/sparkles"; function MyComponent() { return (
{/* Your other content here */}

Welcome to Aceternity UI

); } ``` -------------------------------- ### Install Floating Navbar with Shadcn CLI Source: https://ui.aceternity.com/components/floating-navbar This command installs the Floating Navbar component using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS configured in your project before running this command. ```bash npx shadcn@latest add @aceternity/floating-navbar ``` -------------------------------- ### Install Apple Cards Carousel using CLI Source: https://ui.aceternity.com/components/apple-cards-carousel This command installs the Apple Cards Carousel component using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/apple-cards-carousel ``` -------------------------------- ### Install Canvas Reveal Effect with CLI Source: https://ui.aceternity.com/components/canvas-reveal-effect This command installs the Canvas Reveal Effect component using the shadcn-ui CLI. Ensure you have Next.js and Tailwind CSS set up in your project before running this command. ```bash npx shadcn@latest add @aceternity/canvas-reveal-effect ``` -------------------------------- ### Install Glare Card Component with Shadcn CLI Source: https://ui.aceternity.com/components/glare-card This command installs the Glare Card component using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. The command adds necessary dependencies and configuration for the component. ```bash npx shadcn@latest add @aceternity/glare-card ``` -------------------------------- ### Install Dependencies for Aceternity UI Backgrounds Source: https://ui.aceternity.com/components/grid-and-dot-backgrounds This snippet shows how to install the necessary npm packages for using Aceternity UI's background components. It includes motion, clsx, and tailwind-merge, which are essential for dynamic styling and utility class merging. ```bash npm i motion clsx tailwind-merge ``` -------------------------------- ### Install Next.js Project using Create Next App Source: https://ui.aceternity.com/components/install-nextjs This command initializes a new Next.js project with the latest version. It prompts the user for project name, TypeScript, ESLint, Tailwind CSS, src directory, App Router, and import alias configuration. ```bash npx create-next-app@latest ``` ```bash cd my-app npm run dev ``` -------------------------------- ### Shadcn CLI Options for Initialization Source: https://ui.aceternity.com/components/cli Lists available options for the 'shadcn init' command. These options control default settings, force overwrites, skip prompts, and specify the working directory for project initialization. ```bash Usage: shadcn init [options] [components...] initialize your project and install dependencies Arguments: components the components to add or a url to the component. Options: -d, --defaults use default values i.e new-york, zinc and css variables. (default: false) -f, --force force overwrite of existing components.json. (default: false) -y, --yes skip confirmation prompt. (default: false) -c, --cwd the working directory. defaults to the current directory. -h, --help display help for command ``` -------------------------------- ### Install Meteor Effect Component with Shadcn CLI Source: https://ui.aceternity.com/components/meteors Installs the Meteor Effect component into your project using the Shadcn CLI. Ensure you have Shadcn CLI v3.0 or later installed. ```bash npx shadcn@latest add @aceternity/meteors ``` -------------------------------- ### Install Animated Modal Component using shadcn/ui CLI Source: https://ui.aceternity.com/components/animated-modal This command installs the Animated Modal component from Aceternity UI into your Next.js project using the shadcn/ui CLI. Ensure you have Next.js and Tailwind CSS configured. ```bash npx shadcn@latest add @aceternity/animated-modal ``` -------------------------------- ### Install Text Hover Effect Component (CLI) Source: https://ui.aceternity.com/components/text-hover-effect This command installs the Text Hover Effect component using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/text-hover-effect ``` -------------------------------- ### Multi Step Loader Component Example Source: https://ui.aceternity.com/components/multi-step-loader Example of how to use the Multi Step Loader component in React. It takes an array of loading states, a boolean to control loading, and optional duration and loop props. ```jsx import { MultiStepLoader } from "@aceternity/ui"; const loadingStates = [ { text: "Step 1" }, { text: "Step 2" }, { text: "Step 3" }, ]; function MyComponent() { return (
); } ``` -------------------------------- ### 2 Column Grid Layout Example (React/JSX) Source: https://ui.aceternity.com/components/bento-grid A two-column grid layout example, likely for displaying content or features. This component appears to be part of the Aceternity UI library, offering a structured way to arrange elements. ```jsx import { Card, CardContent } from "@/components/ui/card"; import { BentoGrid, BentoGridItem } from "@/components/ui/bento-grid"; import { IconDeviceDesktop, IconTerminal2 } from "@tabler/icons-react"; const items = [ { title: "The Dawn of Innovation", description: "Explore the birth of groundbreaking ideas and inventions.", icon: , }, { title: "The Digital Revolution", description: "Dive into the transformative power of technology.", icon: , }, // ... more items ]; export function BentoGridSecondDemo() { return ( {items.map((item, i) => ( ))} ); } ``` -------------------------------- ### Install 3D Marquee Component using CLI Source: https://ui.aceternity.com/components/3d-marquee This command installs the 3D Marquee component from Aceternity UI using the shadcn-ui CLI. Ensure you have Next.js and Tailwind CSS set up in your project. This is the primary method for integrating Aceternity components. ```bash npx shadcn@latest add @aceternity/3d-marquee ``` -------------------------------- ### Grid Small Background Component Example Source: https://ui.aceternity.com/components/grid-and-dot-backgrounds This snippet provides an example for a smaller grid background variation within Aceternity UI. It's useful for creating more subtle grid patterns or for specific design elements. ```javascript // Example for Grid Small Background ``` -------------------------------- ### Install Typewriter Effect Component with shadcn-v3 CLI Source: https://ui.aceternity.com/components/typewriter-effect This command installs the Typewriter Effect component into your Next.js project using the shadcn-v3 CLI. Ensure you have Next.js and Tailwind CSS installed. ```bash npx shadcn@latest add @aceternity/typewriter-effect ``` -------------------------------- ### Install Dependencies for Aceternity UI Source: https://ui.aceternity.com/components/tailwindcss-buttons Installs necessary npm packages for using Aceternity UI components, including motion, clsx, and tailwind-merge. These are essential for animations, class manipulation, and merging Tailwind CSS classes. ```bash npm i motion clsx tailwind-merge react-element-to-jsx-string ``` -------------------------------- ### Install Hover Border Gradient Component (CLI) Source: https://ui.aceternity.com/components/hover-border-gradient This command installs the 'hover-border-gradient' component using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. This component adds a gradient border effect on hover. ```bash npx shadcn@latest add @aceternity/hover-border-gradient ``` -------------------------------- ### Install Text Generate Effect Component (CLI) Source: https://ui.aceternity.com/components/text-generate-effect This command installs the Text Generate Effect component using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. This is the quickest way to add the component to your project. ```bash npx shadcn@latest add @aceternity/text-generate-effect ``` -------------------------------- ### Install Flip Words Component with shadcn CLI Source: https://ui.aceternity.com/components/flip-words This command installs the Flip Words component into your Next.js project using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up. This will add the necessary component files and dependencies to your project. ```bash npx shadcn@latest add @aceternity/flip-words ``` -------------------------------- ### Install Aceternity Glowing Stars Card (Next.js) Source: https://ui.aceternity.com/components/glowing-stars-effect This command installs the 'glowing-stars' component from Aceternity UI Pro using the shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. The component adds an animated glowing stars background effect to cards. ```bash npx shadcn@latest add @aceternity/glowing-stars ``` -------------------------------- ### Bento Grid Component Example (React/JSX) Source: https://ui.aceternity.com/components/bento-grid An example of the Bento Grid component populated with header and content. This component is designed to create visually appealing skewed grid layouts. It takes an array of items, where each item can include a title, description, header, and icon. ```jsx import { BentoGrid, BentoGridItem } from "@/components/ui/bento-grid"; import { IconClipboardCopy, IconFile, IconGauge } from "@tabler/icons-react"; const items = [ { title: "The Dawn of Innovation", description: "Explore the birth of groundbreaking ideas and inventions.", header: , icon: , }, { title: "The Digital Revolution", description: "Dive into the transformative power of technology.", header: , icon: , }, { title: "The Art of Design", description: "Discover the beauty of thoughtful and functional design.", header: , icon: , }, // ... more items ]; export function BentoGridThirdDemo() { return ( {items.map((item, i) => ( ))} ); } // Dummy Skeleton components for the example function SkeletonOne() { return (
{/* Content */}
); } function SkeletonTwo() { return (
{/* Content */}
); } function SkeletonThree() { return (
{/* Content */}
); } ``` -------------------------------- ### GitHub Globe Component API Source: https://ui.aceternity.com/components/github-globe Documentation for the GitHub Globe component, detailing its installation and customizable properties. ```APIDOC ## GitHub Globe Component ### Description A globe animation as seen on GitHub's homepage. Interactive and customizable. ### Installation #### CLI Run the following command: ```bash npx shadcn@latest add @aceternity/globe ``` #### Manual Download the `globe.json` file from `https://ui.aceternity.com/data/globe.json` and paste it in your `data/globe.json`. ### Props #### `GlobeConfig` Props | Prop | Type | Description | |---|---|---| | `pointSize` | `number` | Optional. Size of the points on the globe. | | `globeColor` | `string` | Optional. Color of the globe. | | `showAtmosphere` | `boolean` | Optional. Whether to show the atmosphere layer. | | `atmosphereColor` | `string` | Optional. Color of the atmosphere. | | `atmosphereAltitude` | `number` | Optional. Altitude of the atmosphere layer. | | `emissive` | `string` | Optional. Emissive color of the globe material. | | `emissiveIntensity` | `number` | Optional. Intensity of the emissive color. | | `shininess` | `number` | Optional. Shininess of the globe material. | | `polygonColor` | `string` | Optional. Color of the polygons on the globe. | | `ambientLight` | `string` | Optional. Color of the ambient light in the scene. | | `directionalLeftLight` | `string` | Optional. Color of the directional light from the left. | | `directionalTopLight` | `string` | Optional. Color of the directional light from the top. | | `pointLight` | `string` | Optional. Color of the point light in the scene. | | `arcTime` | `number` | Optional. Animation time for the arcs. | | `arcLength` | `number` | Optional. Length of the dash in the arc animations. | | `rings` | `number` | Optional. Number of rings to display initially. | | `maxRings` | `number` | Optional. Maximum number of rings that can be displayed. | | `initialPosition` | `Object` | Optional. Initial position of the globe. Contains `lat` and `lng` fields. | | `autoRotate` | `boolean` | Optional. Whether the globe should auto-rotate. | | `autoRotateSpeed` | `number` | Optional. Speed of the auto-rotation. | #### `WorldProps` Props | Prop | Type | Description | |---|---|---| | `globeConfig` | `GlobeConfig` | Configuration options for the globe. | | `data` | `Position[]` | Array of positions to display arcs between. | #### `Position` Type | Prop | Type | Description | |---|---|---| | `order` | `number` | Order of the arc. | | `startLat` | `number` | Starting latitude of the arc. | | `startLng` | `number` | Starting longitude of the arc. | | `endLat` | `number` | Ending latitude of the arc. | | `endLng` | `number` | Ending longitude of the arc. | | `arcAlt` | `number` | Altitude of the arc. | | `color` | `string` | Color of the arc. | ### Example Usage ```javascript import Globe from '@aceternity/globe'; const GlobeComponent = () => { const globeConfig = { pointSize: 2, globeColor: '#333', showAtmosphere: true, atmosphereColor: '#9c8274', atmosphereAltitude: 0.1, emissive: '#000', emissiveIntensity: 1, shininess: 1, polygonColor: '#ffffff', ambientLight: '#382f27', directionalLeftLight: '#ffffff', directionalTopLight: '#ffffff', pointLight: '#ffffff', arcTime: 1, arcLength: 0.8, rings: 3, maxRings: 5, autoRotate: true, autoRotateSpeed: 0.5 }; const data = [ { order: 1, startLat: 20, startLng: 20, endLat: 2, endLng: 10, arcAlt: 1, color: '#9c8274' }, { order: 2, startLat: 10, startLng: -10, endLat: -5, endLng: -15, arcAlt: 1, color: '#9c8274' }, { order: 3, startLat: -20, startLng: 15, endLat: -10, endLng: 30, arcAlt: 2, color: '#9c8274' } ]; return ( ); }; export default GlobeComponent; ``` ``` -------------------------------- ### Install Parallax Scroll Component (CLI) Source: https://ui.aceternity.com/components/parallax-scroll Installs the @aceternity/parallax-scroll package using the shadcn CLI. This is the recommended way to add the component to your project. ```bash npx shadcn@latest add @aceternity/parallax-scroll parallax-scroll-2 ``` -------------------------------- ### View Aceternity Components from Registry using Shadcn CLI Source: https://ui.aceternity.com/components/cli Allows you to preview components from the Aceternity registry before installation. This command is useful for exploring available components and their structure. ```bash npx shadcn@latest view @aceternity ``` -------------------------------- ### List All Aceternity Components from Registry using Shadcn CLI Source: https://ui.aceternity.com/components/cli Lists all available components from the Aceternity registry. This provides a comprehensive overview of all components that can be added to your project. ```bash npx shadcn@latest list @aceternity ``` -------------------------------- ### Monorepo Initialization with Shadcn CLI Source: https://ui.aceternity.com/components/cli Initializes a project within a monorepo structure using the Shadcn CLI. The '-c' or '--cwd' option specifies the working directory for the monorepo workspace, ensuring correct configuration and dependency management. ```bash npx shadcn@latest init -c ./apps/www ``` -------------------------------- ### Install SVG Mask Effect Component Source: https://ui.aceternity.com/components/svg-mask-effect This command installs the SVG Mask Effect component using the Shadcn CLI. Ensure you have Next.js and Tailwind CSS set up in your project. ```bash npx shadcn@latest add @aceternity/svg-mask-effect ```