### Clone LiftKit Template Project Source: https://github.com/chainlift/liftkit/blob/main/README.md Clones the LiftKit template project to quickly set up a Next.js environment with LiftKit Core's config files pre-installed. This is the fastest way to get started. ```bash git clone https://github.com/Chainlift/liftkit-template.git cd liftkit-template npm install # Install components as needed # Import LiftKit's CSS into your app's globals.css: # @import url("@/lib/css/index.css"); ``` -------------------------------- ### Initialize LiftKit CLI Source: https://context7.com/chainlift/liftkit/llms.txt Commands to install the LiftKit CLI, initialize the project configuration, and add UI components to your Next.js application. ```bash npm install @chainlift/liftkit --save-dev npx liftkit init npm run add all npm run add button npm run add card npm run add badge ``` -------------------------------- ### TextInput Component Examples (React/TypeScript) Source: https://context7.com/chainlift/liftkit/llms.txt Demonstrates the TextInput component for creating input fields with label positioning options, help text, and icon support. Includes examples for floating labels and custom background colors. ```tsx import TextInput from "@/registry/nextjs/components/text-input"; // Basic input // Label on input (floating label style) // With help text // Custom end icon // With background color for floating label ``` -------------------------------- ### Grid Component Examples (React/TypeScript) Source: https://context7.com/chainlift/liftkit/llms.txt Illustrates the responsive Grid component for creating layouts with configurable columns and gap spacing. Supports auto-responsiveness and custom class overrides. ```tsx import Grid from "@/registry/nextjs/components/grid"; // Basic 2-column grid
Item 1
Item 2
Item 3
Item 4
// Multi-column with gap Card 1 Card 2 Card 3 // Auto-responsive grid {items.map(item => {item.name})} // Custom grid with className override
Wide item
Normal item
``` -------------------------------- ### Apply CSS Utility Classes Source: https://context7.com/chainlift/liftkit/llms.txt Examples of applying LiftKit utility classes for background colors, text colors, margins, shadows, overflow, and flexbox layouts. ```tsx
Primary background
Primary text
Vertical margins
Subtle shadow
Horizontal flex
``` -------------------------------- ### Add LiftKit to Existing Next.js Project Source: https://github.com/chainlift/liftkit/blob/main/README.md Installs LiftKit CLI as a dev dependency and initializes LiftKit in an existing Next.js project. This process adds necessary configuration files like `components.json` and `tailwind.config.ts`. ```bash npm install @chainlift/liftkit --save-dev npx liftkit init # If prompted, add an 'add' script to package.json and install shadcn # Install components as needed # Import LiftKit's CSS into your app's globals.css: # @import url("@/lib/css/index.css"); ``` -------------------------------- ### Use Button Component Source: https://context7.com/chainlift/liftkit/llms.txt Examples of the Button component showing support for variants, sizes, semantic colors, and Lucide icon integration. ```tsx import Button from "@/registry/nextjs/components/button"; ); } ``` -------------------------------- ### Grid Component Source: https://context7.com/chainlift/liftkit/llms.txt A responsive CSS grid layout component with configurable columns and gaps. ```APIDOC ## Grid Component ### Description A responsive CSS grid component with configurable columns and gap spacing. ### Usage ```tsx import Grid from "@/registry/nextjs/components/grid";
Item 1
``` ``` -------------------------------- ### ThemeProvider API Source: https://context7.com/chainlift/liftkit/llms.txt The ThemeProvider component manages dynamic Material Design 3 theming, providing context for color modes and palette generation. ```APIDOC ## ThemeProvider Context API ### Description The ThemeProvider wraps the application to manage light/dark modes and dynamic color palettes based on Material Design 3 specifications. ### Parameters #### Hook: useTheme() - **theme** (object) - Current theme colors (light/dark). - **palette** (object) - Current source palette colors. - **setPalette** (function) - Updates the current palette. - **colorMode** (string) - Current mode: "light" | "dark". - **setColorMode** (function) - Toggles between light and dark modes. - **updateTheme** (function) - Regenerates theme from current palette. - **updateThemeFromMaster** (function) - Generates a full palette from a single hex code. ### Response Example { "colorMode": "light", "theme": { "primary": "#6750A4", "surface": "#FEF7FF" } } ``` -------------------------------- ### Icon Component Source: https://context7.com/chainlift/liftkit/llms.txt Renders Lucide icons with theme-aware colors and font-based sizing. ```APIDOC ## Icon Component ### Description Renders Lucide icons with automatic sizing based on font class and theme-aware colors. ### Usage ```tsx import Icon from "@/registry/nextjs/components/icon"; ``` ``` -------------------------------- ### Text and Heading Components Source: https://context7.com/chainlift/liftkit/llms.txt Typography components supporting LiftKit font classes and color tokens. ```APIDOC ## Text and Heading Components ### Description Typography components with LiftKit font classes and color tokens. ### Usage ```tsx import Heading from "@/registry/nextjs/components/heading"; Main Title ``` ``` -------------------------------- ### Row and Column Layout Components (React/TypeScript) Source: https://context7.com/chainlift/liftkit/llms.txt Demonstrates the Row and Column components for flexible horizontal and vertical layouts using Flexbox. Includes options for alignment, gap control, and wrapping children. ```tsx import Row from "@/registry/nextjs/components/row"; import Column from "@/registry/nextjs/components/column"; // Basic row layout