### Install Project Dependencies Source: https://github.com/pageai-pro/page-ui/blob/main/website/README.md Run this command to install all necessary project dependencies. ```bash npm i ``` -------------------------------- ### Example Usage: With Background Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/problem-solution.mdx An example demonstrating the LandingProductProblemSolution component with a background. ```APIDOC ## POST /api/example/background ### Description This endpoint shows how to use the LandingProductProblemSolution component with a background effect. ### Method POST ### Endpoint /api/example/background ### Request Body - **title** (string) - Required - The main title for the section. - **description** (string) - Required - Supporting text for the section. - **withBackground** (boolean) - Optional - Enables the background effect. Defaults to false. - **problems** (array) - Required - An array of problem objects, each with a `title`. - **solutions** (array) - Required - An array of solution objects, each with a `title`. ### Request Example ```json { "title": "Problems and Solutions", "description": "Addressing key customer pain points with innovative solutions", "withBackground": true, "problems": [ { "title": "Complex setup process" }, { "title": "Poor performance" } ], "solutions": [ { "title": "One-click installation" }, { "title": "Optimized performance" } ] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Component rendered successfully with background" } ``` ``` -------------------------------- ### LandingPricingPlan - With Discount Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/pricing-plan.mdx Example of using the LandingPricingPlan component with a discounted price. ```APIDOC ## LandingPricingPlan - With Discount ### Description This example demonstrates how to display a pricing plan with a regular price and a discounted price. ### Component Usage ```jsx import { LandingPricingPlan } from '@/components/landing/pricing/LandingPricingPlan';

Unlimited users

AI features

Priority support

``` ``` -------------------------------- ### Render Complete LandingBlogPost Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/blog-post.mdx This example demonstrates rendering a fully-featured blog post card with all available properties. Import `LandingBlogPost` before use. ```jsx import { LandingBlogPost } from '@/components/landing/blog/LandingBlogPost'; ``` -------------------------------- ### Example Usage: Basic Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/problem-solution.mdx A basic example of the LandingProductProblemSolution component with titles, descriptions, problems, and solutions. ```APIDOC ## POST /api/example ### Description This endpoint demonstrates a basic usage of the LandingProductProblemSolution component. ### Method POST ### Endpoint /api/example ### Request Body - **title** (string) - Required - The main title for the section. - **description** (string) - Required - Supporting text for the section. - **problemTitle** (string) - Optional - Heading for the problem column. - **solutionTitle** (string) - Optional - Heading for the solution column. - **problems** (array) - Required - An array of problem objects, each with a `title` and `description`. - **solutions** (array) - Required - An array of solution objects, each with a `title` and `description`. ### Request Example ```json { "title": "Before vs After", "description": "See the difference our product makes", "problemTitle": "Before", "solutionTitle": "After", "problems": [ { "title": "Manual process", "description": "Time-consuming and error-prone" }, { "title": "Manual process", "description": "Time-consuming and error-prone" } ], "solutions": [ { "title": "Automated workflow", "description": "Fast, accurate, and reliable" }, { "title": "Automated workflow", "description": "Fast, accurate, and reliable" } ] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Component rendered successfully" } ``` ``` -------------------------------- ### Start Development Server Source: https://github.com/pageai-pro/page-ui/blob/main/website/README.md Execute this command to launch the local development server. ```bash npm run dev ``` -------------------------------- ### Install Page UI Dependencies Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/installation/manual-reactjs.mdx Installs all required dependencies for Page UI and Tailwind CSS. Ensure you have Node.js and npm/yarn installed. ```bash npm install -D tailwindcss@3 postcss autoprefixer @tailwindcss/forms @tailwindcss/typography tailwindcss-animate embla-carousel-react class-variance-authority clsx tailwind-merge lucide-react @radix-ui/react-accordion @radix-ui/react-tabs @radix-ui/react-label ``` -------------------------------- ### Complete Example with Custom Stats Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/about.mdx An example demonstrating the usage of LandingAboutSection and LandingStatItem components together. ```APIDOC ## Complete example with custom stats ### Description This example shows how to use the `LandingAboutSection` and `LandingStatItem` components to create a landing page section with an about description and key statistics. ### Component Usage ```jsx import { LandingAboutSection } from '@/components/landing/about/LandingAboutSection'; import { LandingStatItem } from '@/components/landing/stats/LandingStatItem';

Key Statistics

``` ``` -------------------------------- ### Basic LandingBlogPost Usage Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/blog-post.mdx Render the LandingBlogPost component by passing a 'post' object containing essential details. This example shows a minimal setup. ```jsx ``` -------------------------------- ### Initialize Page UI CLI Source: https://github.com/pageai-pro/page-ui/blob/main/README.md Run the Page UI CLI to initialize the project. Ensure you have Node.js installed. ```bash npx @page-ui/wizard@latest init ``` -------------------------------- ### Example Usage: With Background Glow Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/problem-solution.mdx An example showcasing the LandingProductProblemSolution component with a background glow effect. ```APIDOC ## POST /api/example/background-glow ### Description This endpoint illustrates the usage of the LandingProductProblemSolution component with a background glow effect. ### Method POST ### Endpoint /api/example/background-glow ### Request Body - **title** (string) - Required - The main title for the section. - **withBackgroundGlow** (boolean) - Optional - Enables the background glow effect. Defaults to false. - **problems** (array) - Required - An array of problem objects, each with a `title`. - **solutions** (array) - Required - An array of solution objects, each with a `title`. ### Request Example ```json { "title": "Problems and Solutions", "withBackgroundGlow": true, "problems": [ { "title": "Complex setup process" }, { "title": "Poor performance" } ], "solutions": [ { "title": "One-click installation" }, { "title": "Optimized performance" } ] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Component rendered successfully with background glow" } ``` ``` -------------------------------- ### Basic Usage with Custom Styling Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/appstore-button.mdx Example of how to use the LandingAppStoreButton with custom styling applied via the className prop. ```APIDOC ## POST /pageai-pro/page-ui (Example Endpoint) ### Description This example demonstrates how to apply custom styling to the LandingAppStoreButton using the `className` prop. ### Method N/A (Component Usage Example) ### Endpoint N/A (Component Usage Example) ### Request Body #### Props - **appStore** (string) - Required - 'ios-appstore' - **className** (string) - Optional - 'shadow-lg hover:shadow-xl transition-shadow duration-300' ### Request Example ```jsx ``` ### Response (Component rendering, no specific API response) #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### Basic LandingBlogList Usage Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/blog-list.mdx A minimal example demonstrating how to use the LandingBlogList component with a single LandingBlogPost. This setup is useful for showcasing a single featured article or a simple list. ```jsx ``` -------------------------------- ### Minimal FAQ Section Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/faq.mdx A minimal example of the LandingFaqSection component, demonstrating its core functionality with a single FAQ item. This is useful for quick integration or when only a few questions need to be displayed. ```jsx ``` -------------------------------- ### Minimal LandingBlogPost Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/blog-post.mdx A basic example of the LandingBlogPost component using only the required 'slug', 'date', 'title', and 'summary' properties. ```jsx ``` -------------------------------- ### Example: LandingMarquee with Background and Icons Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/marquee.mdx Illustrates using LandingMarquee with a background, custom animation duration, and various icons. ```APIDOC ## LandingMarquee with Background and Icons ### Description This example showcases the LandingMarquee component with a background enabled, set to a secondary variant, and a specific animation duration. It displays a collection of icons. ### Component Usage ```jsx import { ChromeIcon, FigmaIcon, GithubIcon, FramerIcon, TwitchIcon, TwitterIcon, GitlabIcon, InstagramIcon, SlackIcon } from 'lucide-react'; import { LandingMarquee } from '@/components/landing/LandingMarquee'; ; ``` ``` -------------------------------- ### LandingFeatureList Component Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/feature-list.mdx Example usage of the LandingFeatureList component with background glow. ```APIDOC ## LandingFeatureList Component Example ### Description Example usage of the LandingFeatureList component with background glow. ### Method None ### Endpoint None ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```jsx import { SparklesIcon, LineChartIcon, LayersIcon } from 'lucide-react'; import { LandingFeatureList } from '@/components/landing/feature/LandingFeatureList'; const featureItems = [ { title: 'Automatic deployment to Vercel', description: 'Deploying the generated template to Vercel is as easy as clicking a button. ', icon: , }, { title: 'Dynamic Social Image', description: 'We generate an open graph image that will be visible when you share your site online.', icon: , }, { title: 'MDX blog, no server required', description: 'Shipixen comes with a fully featured MDX blog. ', icon: , }, ] ``` ### Response #### Success Response (200) None #### Response Example None ``` -------------------------------- ### Component Example: With background glow Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/newsletter.mdx Example demonstrating the LandingNewsletterSection component with the `withBackgroundGlow` prop enabled. ```APIDOC ## Component Example: With background glow ### Description This example shows how to use the `withBackgroundGlow` prop to add a glowing background effect to the newsletter section. ### Usage ```jsx ``` ``` -------------------------------- ### LandingPricingPlan - Sold Out Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/pricing-plan.mdx Example of using the LandingPricingPlan component to indicate a sold-out status. ```APIDOC ## LandingPricingPlan - Sold Out ### Description This example shows how to use the `soldOut` prop to indicate that a pricing plan is no longer available. ### Component Usage ```jsx import { LandingPricingPlan } from '@/components/landing/pricing/LandingPricingPlan';

Unlimited users

AI features

Priority support

``` ``` -------------------------------- ### Custom Product Cards Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/product-card.mdx This example shows how to implement custom content within product cards using `topComponent` and `bottomComponent` props. ```APIDOC ## Custom Product Cards Example ### Description This example demonstrates using the `topComponent` and `bottomComponent` props to add custom content to the product cards, allowing for flexible and rich card designs. ### Method N/A (Component Usage Example) ### Endpoint N/A (Component Usage Example) ### Parameters N/A (Component Usage Example) ### Request Example ```jsx New Arrival} actionComponent={} /> Bestseller} bottomComponent={
} actionComponent={} /> Limited Edition} bottomComponent={
In stock - ships in 24 hours
} actionComponent={} />
``` ### Response N/A (Component Usage Example) ``` -------------------------------- ### Install Project Dependencies Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/installation/reactjs.mdx Install essential development dependencies for Tailwind CSS, form and typography plugins, and various UI utility libraries. Ensure you are in your project's root directory. ```bash cd my-app npm install -D tailwindcss@3 postcss autoprefixer @tailwindcss/forms @tailwindcss/typography tailwindcss-animate embla-carousel-react class-variance-authority clsx tailwind-merge lucide-react @radix-ui/react-accordion @radix-ui/react-tabs @radix-ui/react-label ``` -------------------------------- ### Landing Page CTA and Social Proof Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/primary-image-cta.mdx Demonstrates a centered full example of a landing page with a primary CTA section and social proof elements. Includes imports for necessary components. ```jsx import { Button } from '@/components/shared/ui/button'; import { LandingPrimaryImageCtaSection } from '@/components/landing/cta/LandingPrimaryCta'; import { LandingDiscount } from '@/components/landing/discount/LandingDiscount'; import { LandingProductHuntAward } from '@/components/landing/social-proof/LandingProductHuntAward'; import { LandingSocialProof } from '@/components/landing/social-proof/LandingSocialProof'; import { LandingSocialProofBand } from '@/components/landing/social-proof/LandingSocialProofBand'; import { LandingSocialProofBandItem } from '@/components/landing/social-proof/LandingSocialProofBandItem'; 100% encrypted and secure 24/7 customer support 99% customer satisfaction } > ``` -------------------------------- ### Complete Landing Page Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/about.mdx Demonstrates a complete landing page section with an about us component and key statistics. Ensure necessary components are imported. ```jsx import { LandingAboutSection } from '@/components/landing/about/LandingAboutSection'; import { LandingStatItem } from '@/components/landing/stats/LandingStatItem';

Key Statistics

``` -------------------------------- ### Landing Product Tour Section Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/product-tour.mdx Demonstrates the structure and usage of the LandingProductTourSection component, including its title, description, default value, and nested content. ```jsx

Automatic deployment to Vercel

Deploying the generated template to Vercel is as easy as clicking a button.

MDX blog, no server required

Shipixen comes with a fully featured MDX blog.

Customizable themes

Choose from more than 30+ beautifully designed themes or create your own.

``` -------------------------------- ### LandingFeature Component Usage Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/feature.mdx Demonstrates how to use the LandingFeature component with its essential props. ```APIDOC ## Usage Example This example shows how to import and use the `LandingFeature` component with a title, description, and icon. ### Code ```jsx import { LandingFeature } from '@/components/landing/feature/LandingFeature'; import { SparklesIcon } from 'lucide-react'; } />; ``` ``` -------------------------------- ### Example: LandingMarquee with Images Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/marquee.mdx Demonstrates how to use the LandingMarquee component to display a scrolling list of avatars with images. ```APIDOC ## LandingMarquee with Images ### Description This example shows how to populate the LandingMarquee with a list of people's avatars, each featuring an image and a name. ### Component Usage ```jsx
{[ { imageSrc: '/static/images/people/1.webp', name: 'John Doe', }, { imageSrc: '/static/images/people/2.webp', name: 'Jane Doe', }, { imageSrc: '/static/images/people/3.webp', name: 'Alice Doe', }, { imageSrc: '/static/images/people/4.webp', name: 'Bob Doe', }, { imageSrc: '/static/images/people/5.webp', name: 'Eve Doe', }, ].map((person, index) => ( ))}
``` ``` -------------------------------- ### LandingRating Component Examples Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/rating.mdx Demonstrates various ways to use the LandingRating component with different configurations. ```APIDOC ## LandingRating Component Examples ### With Custom Rating ```jsx import { LandingRating } from '@/components/landing/rating/LandingRating'; ; ``` ### With Partial Rating ```jsx import { LandingRating } from '@/components/landing/rating/LandingRating'; ; ``` ### With Custom Size ```jsx import { LandingRating } from '@/components/landing/rating/LandingRating'; ; ``` ### With Custom Max Rating ```jsx import { LandingRating } from '@/components/landing/rating/LandingRating'; ; ``` ``` -------------------------------- ### Example: Blog Post with Clickable Tags Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/blog-post.mdx Demonstrates how to use the LandingBlogPost component to display a blog post with tags that link to other pages. ```APIDOC ## Example: Blog Post with Clickable Tags ### Description A blog post with tags that link to other pages when clicked. ### Component Usage ```jsx import { LandingBlogPost } from '@/components/landing/blog/LandingBlogPost'; ``` ``` -------------------------------- ### Basic LandingProblemAgitator Implementation Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/problem-agitator.mdx A basic example demonstrating the structure and content of the LandingProblemAgitator component. ```jsx

Problem 1

Problem 2

Pain point 1

Problem 3

``` -------------------------------- ### Component Usage Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/team.mdx Demonstrates how to use LandingTeamSection and LandingTeamMember components together, either by passing members as an array or as children. ```APIDOC ## Component-based Usage Alternatively, you can use individual `LandingTeamMember` components as children: ```jsx import { LandingTeamSection } from '@/components/landing/team/LandingTeamSection'; import { LandingTeamMember } from '@/components/landing/team/LandingTeamMember'; ``` ``` -------------------------------- ### Basic App Store Button Usage Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/appstore-button.mdx Example of rendering a single iOS App Store button. ```jsx ``` -------------------------------- ### LandingProductSteps with Video Features Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/product-steps.mdx Integrate video features into your product steps display. This example shows how to use LandingProductVideoFeature alongside LandingProductFeature. Ensure all necessary components are imported. ```jsx import { LandingProductSteps } from '@/components/landing/LandingProductSteps'; import { LandingProductFeature } from '@/components/landing/LandingProductFeature'; import { LandingProductVideoFeature } from '@/components/landing/LandingProductVideoFeature'; ``` -------------------------------- ### LandingProductVideoFeature with CTA Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/product-video-feature.mdx This example demonstrates using LandingProductVideoFeature with a paragraph description and a call to action button. Import Button and LandingProductFeature. ```jsx import { Button } from '@/components/shared/ui/button'; import { LandingProductFeature } from '@/components/landing/LandingProductFeature';

Receive personalized recommendations and insights tailored to your workflow and easily collaborate with team members and clients in real-time.

7 day free trial, no credit card required.

} /> ``` -------------------------------- ### LandingFeatureList Component with Background Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/feature-list.mdx Example of using the LandingFeatureList component with a background and secondary variant. Requires importing icons and the component. ```jsx import { SparklesIcon, LineChartIcon, LayersIcon } from 'lucide-react'; import { LandingFeatureList } from '@/components/landing/feature/LandingFeatureList'; const featureItems = [ { title: 'Deploy now', description: 'Deploying to Vercel with a click.', icon: , }, { title: 'SEO optimized', description: 'Shipixen is optimized for search engines.', icon: , }, { title: 'MDX blog ready', description: 'Shipixen comes with a fully featured MDX blog. ', icon: , }, ] ``` -------------------------------- ### Landing Price Comparison Section Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/pricing-comparison.mdx Use this component to create a feature comparison table. It accepts a title, description, and multiple columns, each containing comparison items. ```jsx ``` -------------------------------- ### Landing Page CTA and Social Proof Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/primary-image-cta.mdx Demonstrates the integration of a primary call-to-action section with social proof elements for a landing page. Ensure necessary components are imported. ```jsx import { Button } from '@/components/shared/ui/button'; import { LandingPrimaryImageCtaSection } from '@/components/landing/cta/LandingPrimaryCta'; import { LandingDiscount } from '@/components/landing/discount/LandingDiscount'; import { LandingProductHuntAward } from '@/components/landing/social-proof/LandingProductHuntAward'; import { LandingSocialProof } from '@/components/landing/social-proof/LandingSocialProof'; import { LandingSocialProofBand } from '@/components/landing/social-proof/LandingSocialProofBand'; import { LandingSocialProofBandItem } from '@/components/landing/social-proof/LandingSocialProofBandItem'; 100% encrypted and secure 24/7 customer support 99% customer satisfaction } > ``` -------------------------------- ### Build for Production Source: https://github.com/pageai-pro/page-ui/blob/main/website/README.md Use this command to create a production-ready build of the site. ```bash npm run build ``` -------------------------------- ### LandingProblemAgitator Example Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/landing-page-components/problem-agitator.mdx Example usage of the LandingProblemAgitator component with specific props and child items. ```APIDOC ## LandingProblemAgitator Example ### Description An example demonstrating how to use the LandingProblemAgitator component with its title, description, cliffhanger, and problem items. ### Component Usage ```jsx

Complex requirements

Limited resources

Technical constraints

``` ``` -------------------------------- ### Run Page UI CLI Initialization Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/installation/nextjs.mdx Navigate to your Next.js project directory and run the Page UI CLI to initialize the components. Ensure you replace 'my-app' if you used a different project name. ```bash cd my-app npx @page-ui/wizard@latest init ``` -------------------------------- ### Run Page UI CLI for Initialization Source: https://github.com/pageai-pro/page-ui/blob/main/website/data/docs/installation/reactjs.mdx Execute the Page UI wizard to initialize the project with the React template. This command sets up the necessary Page UI configurations. ```bash npx @page-ui/wizard@latest init --template react ``` -------------------------------- ### Page UI Init Command Options Source: https://github.com/pageai-pro/page-ui/blob/main/packages/cli/README.md Details the options available for the 'page-ui init' command. Use this to configure the Page UI setup, such as selecting a template or specifying the source directory. ```bash Usage: page-ui init [options] Setup Page UI: adds required files to your project Options: -t, --template