> Tip:所有代码或命令可以双击选定词,三击选定行。
## 😉 已有工程
### 安装
已有配置好 Svelte 与 Tailwind 的工程,直接安装。
```bash
bun i stdf -D
# or
pnpm i stdf -D
# or
npm i stdf -D
```
### 在 Svelte 中使用
```svelte
```
## 😓 无工程
### 使用 create-stdf
可以尝试使用 [create-stdf](https://www.npmjs.com/package/create-stdf) 快速创建工程。(beta 版本)
```bash
bun create stdf
# or
pnpm create stdf
# or
npm create stdf@latest
# or
npm init stdf@latest
# or
npx create-stdf@latest
```
### 自行搭建工程
此处用 Vite 示例创建工程,参考 [Vite 文档](https://cn.vitejs.dev/guide/#scaffolding-your-first-vite-project)。
```sh
npm create vite@latest
```
按照提示操作创建工程。
参考 [Tailwind CSS 文档](https://tailwindcss.com/docs/guides/vite) 配置 Tailwind CSS。
1. 安装 Tailwind CSS 和其他依赖,然后生成 `tailwind.config.js` 和 `postcss.config.js` 文件。
```sh
npm install -D tailwindcss postcss autoprefixer
npx tailwindcss init -p
```
1. 在 `tailwind.config.js` 文件内添加模板文件。注意 content 内添加`./node_modules/stdf/**/*.svelte`,这是 STDF 的组件位置。其中 theme 的 colors 可以根据自己的需要进行修改。可参考 [STDF 指南 - 色彩](/#/guide?nav=color)。
注意:Tailwind 配置文件中的 content 即表示所有可能用到 Tailwind 的文件,请不要遗漏。darkMode 请设置为 'class',这是为了配合 STDF 的暗黑模式。
```javascript
/** @type {import('tailwindcss').Config} */
export default {
// ...
content: ['./src/**/*.{html,js,svelte,ts}', './node_modules/stdf/**/*.svelte'],
theme: {
colors: {
// 主题色
primary: {
50: 'rgba(var(--theme-color-primary-50), )',
100: 'rgba(var(--theme-color-primary-100), )',
200: 'rgba(var(--theme-color-primary-200), )',
300: 'rgba(var(--theme-color-primary-300), )',
400: 'rgba(var(--theme-color-primary-400), )',
500: 'rgba(var(--theme-color-primary-500), )',
DEFAULT: 'rgba(var(--theme-color-primary), )',
700: 'rgba(var(--theme-color-primary-700), )',
800: 'rgba(var(--theme-color-primary-800), )',
900: 'rgba(var(--theme-color-primary-900), )',
950: 'rgba(var(--theme-color-primary-950), )',
},
dark: {
50: 'rgba(var(--theme-color-dark-50), )',
100: 'rgba(var(--theme-color-dark-100), )',
200: 'rgba(var(--theme-color-dark-200), )',
300: 'rgba(var(--theme-color-dark-300), )',
400: 'rgba(var(--theme-color-dark-400), )',
500: 'rgba(var(--theme-color-dark-500), )',
DEFAULT: 'rgba(var(--theme-color-dark), )',
700: 'rgba(var(--theme-color-dark-700), )',
800: 'rgba(var(--theme-color-dark-800), )',
900: 'rgba(var(--theme-color-dark-900), )',
950: 'rgba(var(--theme-color-dark-950), )',
},
primaryBlack: 'rgba(var(--theme-color-primaryBlack), )',
primaryWhite: 'rgba(var(--theme-color-primaryWhite), )',
darkBlack: 'rgba(var(--theme-color-darkBlack), )',
darkWhite: 'rgba(var(--theme-color-darkWhite), )',
// 功能色
success: 'rgba(var(--theme-color-functional-success), )',
warning: 'rgba(var(--theme-color-functional-warning), )',
error: 'rgba(var(--theme-color-functional-error), )',
info: 'rgba(var(--theme-color-functional-info), )',
// 扩展色
extend0: 'rgba(var(--theme-color-extend0), )',
extend1: 'rgba(var(--theme-color-extend1), )',
extend2: 'rgba(var(--theme-color-extend2), )',
// 中性色
black: '#000000',
white: '#ffffff',
gray: {
50: '#f2f2f2',
100: '#e6e6e6',
200: '#cccccc',
300: '#b3b3b3',
400: '#999999',
500: '#808080',
600: '#666666',
700: '#4D4D4D',
800: '#333333',
900: '#1A1A1A',
950: '#0D0D0D',
},
transparent: 'transparent',
},
// ...
},
darkMode: 'class',
// ...
};
```
3. 将 Tailwind CSS 添加到入口 CSS 文件中,如 `./src/index.css`,并在入口文件 main.js 中引入这个 CSS 文件。
4. 启动项目。
```sh
bun dev
# or
npm run dev
```