@ 经济/塔克
UI 反应组件库
使用量
import { Button } from '@economic/taco';
const MyComponent = () => <Button>Guacamole</Button>;
安装
npm install --save @economic/taco
同伴依赖关系
| 软件包 | 版本 |
|---|---|
react | ^18.3.1 |
react-dom | ^18.3.1 |
tailwindcss | >=3.4.19 |
样式
Taco 船 预编 CSS 文件 (dist/taco.css),包含其组件样式。 然而,消费者仍然需要自己的"Tailwind"设置,在他们的应用代码中使用设计系统的主题符号和实用类.
浏览器应瞄准、清理和微音化 由你,消费者。 。 。 .
tailwind.config.js 应使用taco配置作为预设 :
module.exports = {
presets: [require('@economic/taco/tailwind.config.js')],
content: {
files: ['./src/**/*.{ts,tsx}', './node_modules/@economic/taco/dist/**/*.js'],
},
};
然后在您的 CSS 应用程序中导入 Tailwind 层和 taco 样式表 :
@import 'tailwindcss/base';
@import 'tailwindcss/components';
@import '@economic/taco/taco.css';
@import 'tailwindcss/utilities';
PostCSS 配置
重要内容: 这个设计系统需要 postcss-import 用于正常运行.
以上使用的CSS进口 @import 语句代替 @tailwind 指令,因为 postcss-import 插件 。 这是在导入额外的CSS文件时避免出问题所必须的.
您的 PostCSS 配置应该看起来像这样:
module.exports = {
plugins: ['postcss-import', 'tailwindcss', 'autoprefixer'],
};
发展
先决条件
- 节点
>=24(通过沃尔塔管理,参见根)package.json(中文(简体) ) - 这个软件包住在单簧管旁边
@economic/taco-tokens。总是运行npm install从 仓库根。 。 。 .
开始
# from the repository root
npm install
npm run dev # starts Storybook on http://localhost:6006
可用的脚本
运行这些从 软件包目录 (单位:千美元)packages/taco:
| 脚本 | 说明 |
|---|---|
npm run build | 类型检查 tsc 然后用 Vite 构建库 |
npm test | 使用 Vitest 运行单元测试 |
npm run lint | 在 CSS 文件上运行样式林特, 在 JS/ TS 文件上运行克林特 |
npm run e2e | 运行 Playwright 端到端测试 |
npm run generate-icons | 从 SVG 源头重生成图标组件 |
或从 仓库根数字 :
| 脚本 | 说明 |
|---|---|
npm run dev | 在端口启动故事书 6006 |
npm run build | 构建所有软件包 |
npm run lint:styles | 运行样式林 @economic/taco (单位:千美元)src/**/*.css(中文(简体) ) |
npm run lint:classes | 运行所有 TSX/ TS 源文件中的类接口 |
故事书
故事书是主要的发展和文献环境. 运行 npm run dev 从寄存器根开始。 部分故事和文件与执行并存 __stories__/ 文件夹.
新组成部分准则
在下方创建文件夹 src/components/ 带有组件名称,例如:. <NewComponent />数字 :
src/components/
├── NewComponent/
│ ├── __stories__/
│ │ ├── NewComponent.dev.stories.tsx
│ │ ├── NewComponent.mdx
│ │ └── NewComponent.stories.tsx
│ ├── NewComponent.css
│ ├── NewComponent.spec.tsx
│ ├── NewComponent.e2e.ts
│ └── NewComponent.tsx
该组件的样式,执行,测试以及文档在自己的文件夹中合用.
| 文件 | 目的 |
|---|---|
__stories__/NewComponent.mdx | 构成部分文件 |
__stories__/NewComponent.dev.stories.tsx | 故事书的发展故事 |
__stories__/NewComponent.stories.tsx | 文件中使用的故事 |
NewComponent.css | 执行中直接导入的组件样式 |
NewComponent.spec.tsx | 单位测试(Vitest) |
NewComponent.e2e.ts | 端到端测试(Playwright),如果适用 |
NewComponent.tsx | 构成部分执行 |
线性
三层林地横穿密码库:
| 工具 | 范围 | 说明 |
|---|---|---|
| 奥克林特 | JS/TS档案 | 普通代码质量闪烁 |
| 样式lint | CSS 文件 (src/**/*.css(中文(简体) ) | 鼓励批准的设计标志 |
| 类线条 | TSX/TS文件 | 旗子不允许类用( 本地 oxlint JS 插件) |
Stylelint 和类插件也作为承诺前钩子通过 nano-staged。 。 。 .
风格林和克克林特的设计规则都来自
@economic/taco-rules因此,CSS和TSX接受
同样的课程。 塔克语的个性stylelint.config.mjs, (中文(简体) ), .oxlintrc.json, (中文(简体) ),
.oxlintrc.classes.json扩展其已发运的配置,只覆盖单个
规则。 CSS和TS/TSX分别切换: stylelint.config.mjs 支助科,
两者 .oxlintrc.json 财务报告和审定财务报表 .oxlintrc.classes.json 用于TS/TSX.