首頁  >  文章  >  web前端  >  如何將shadcn添加到現有項目中

如何將shadcn添加到現有項目中

WBOY
WBOY原創
2024-08-09 08:52:221044瀏覽

How to add shadcn to existing project

如果您是 Web 開發人員,您很可能聽說過 shadcn/ui,它是基於 Radix UI 的最受歡迎的元件庫之一。在這篇文章中,我們將探討如何將 shadcn 加入現有專案中。

根據您的專案設定方式以及您使用的框架,將 shadcn 新增至現有專案將會有所不同。當使用 shadcn 使用此程式庫時建議使用 Typescript。不過,JavaScript 版本也可用。

要先將 shadcn 新增到您的專案中,如果您的專案未使用 Tailwind CSS,則必須安裝它,因為 shadcn 元件是用它來設計樣式的。

要設定 Tailwind CSS,請按照其網站上的安裝說明進行操作。

Shadcn和框架

如果您使用 Next.js、Vite、Remix、Astro 或 Laravel,請執行 shadcn-ui 使用下列指令設定您的專案:

npx shadcn-ui@latest init

您必須回答幾個問題才能完成設置,具體取決於您的項目,例如選擇 Typescript 或 Javascript,無論您的專案使用什麼。

之後您將能夠安裝任何您想要的 shadcn 元件,例如新增按鈕:

npx shadcn-ui@latest add button

然後只需從 Components/ui 導入它即可在您的專案中使用它。

Shadcn手動安裝

要再次在 React 專案中手動安裝 shadcn,請確保正確安裝 Tailwind CSS。

然後新增依賴項:

npm install tailwindcss-animate class-variance-authority clsx tailwind-merge

新增圖示庫:

npm install lucide-react

設定路徑別名:

tsconfig.json

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["./*"]
    }
  }
}

設定 tailwind.config.js

const { fontFamily } = require("tailwindcss/defaultTheme")

/** @type {import('tailwindcss').Config} */
module.exports = {
  darkMode: ["class"],
  content: ["app/**/*.{ts,tsx}", "components/**/*.{ts,tsx}"],
  theme: {
    container: {
      center: true,
      padding: "2rem",
      screens: {
        "2xl": "1400px",
      },
    },
    extend: {
      colors: {
        border: "hsl(var(--border))",
        input: "hsl(var(--input))",
        ring: "hsl(var(--ring))",
        background: "hsl(var(--background))",
        foreground: "hsl(var(--foreground))",
        primary: {
          DEFAULT: "hsl(var(--primary))",
          foreground: "hsl(var(--primary-foreground))",
        },
        secondary: {
          DEFAULT: "hsl(var(--secondary))",
          foreground: "hsl(var(--secondary-foreground))",
        },
        destructive: {
          DEFAULT: "hsl(var(--destructive))",
          foreground: "hsl(var(--destructive-foreground))",
        },
        muted: {
          DEFAULT: "hsl(var(--muted))",
          foreground: "hsl(var(--muted-foreground))",
        },
        accent: {
          DEFAULT: "hsl(var(--accent))",
          foreground: "hsl(var(--accent-foreground))",
        },
        popover: {
          DEFAULT: "hsl(var(--popover))",
          foreground: "hsl(var(--popover-foreground))",
        },
        card: {
          DEFAULT: "hsl(var(--card))",
          foreground: "hsl(var(--card-foreground))",
        },
      },
      borderRadius: {
        lg: `var(--radius)`,
        md: `calc(var(--radius) - 2px)`,
        sm: "calc(var(--radius) - 4px)",
      },
      fontFamily: {
        sans: ["var(--font-sans)", ...fontFamily.sans],
      },
      keyframes: {
        "accordion-down": {
          from: { height: "0" },
          to: { height: "var(--radix-accordion-content-height)" },
        },
        "accordion-up": {
          from: { height: "var(--radix-accordion-content-height)" },
          to: { height: "0" },
        },
      },
      animation: {
        "accordion-down": "accordion-down 0.2s ease-out",
        "accordion-up": "accordion-up 0.2s ease-out",
      },
    },
  },
  plugins: [require("tailwindcss-animate")],
}

使用以下內容更新 globals.css 檔案:

@tailwind base;
@tailwind components;
@tailwind utilities;

@layer base {
  :root {
    --background: 0 0% 100%;
    --foreground: 222.2 47.4% 11.2%;

    --muted: 210 40% 96.1%;
    --muted-foreground: 215.4 16.3% 46.9%;

    --popover: 0 0% 100%;
    --popover-foreground: 222.2 47.4% 11.2%;

    --border: 214.3 31.8% 91.4%;
    --input: 214.3 31.8% 91.4%;

    --card: 0 0% 100%;
    --card-foreground: 222.2 47.4% 11.2%;

    --primary: 222.2 47.4% 11.2%;
    --primary-foreground: 210 40% 98%;

    --secondary: 210 40% 96.1%;
    --secondary-foreground: 222.2 47.4% 11.2%;

    --accent: 210 40% 96.1%;
    --accent-foreground: 222.2 47.4% 11.2%;

    --destructive: 0 100% 50%;
    --destructive-foreground: 210 40% 98%;

    --ring: 215 20.2% 65.1%;

    --radius: 0.5rem;
  }

  .dark {
    --background: 224 71% 4%;
    --foreground: 213 31% 91%;

    --muted: 223 47% 11%;
    --muted-foreground: 215.4 16.3% 56.9%;

    --accent: 216 34% 17%;
    --accent-foreground: 210 40% 98%;

    --popover: 224 71% 4%;
    --popover-foreground: 215 20.2% 65.1%;

    --border: 216 34% 17%;
    --input: 216 34% 17%;

    --card: 224 71% 4%;
    --card-foreground: 213 31% 91%;

    --primary: 210 40% 98%;
    --primary-foreground: 222.2 47.4% 1.2%;

    --secondary: 222.2 47.4% 11.2%;
    --secondary-foreground: 210 40% 98%;

    --destructive: 0 63% 31%;
    --destructive-foreground: 210 40% 98%;

    --ring: 216 34% 17%;

    --radius: 0.5rem;
  }
}

@layer base {
  * {
    @apply border-border;
  }
  body {
    @apply bg-background text-foreground;
    font-feature-settings: "rlig" 1, "calt" 1;
  }
}

最後將 cn 助手加入您的 lib/utils.ts

import { clsx, type ClassValue } from "clsx"
import { twMerge } from "tailwind-merge"

export function cn(...inputs: ClassValue[]) {
  return twMerge(clsx(inputs))
}

然後只需從此處安裝所需的組件並按照每個組件的說明進行操作即可。

就是這樣,我現在幾乎在所有的Web 專案中都使用shadcn,它已經變得非常流行,因為它非常易於使用和自訂,請查看我如何從Select 和Scrollarea 元件建立自訂shadcn-date- picker 組件在這裡。

如果您在將此庫添加到您的專案中時遇到任何問題,請告訴我。

讓我們在 x.com 上聯絡

以上是如何將shadcn添加到現有項目中的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn