设计系统
- 作者仓库星标 190,957
- 作者仓库 n8n
- 领域
- 设计与多媒体
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @n8n-io · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
# Design System
Comprehensive guide for building, styling, and using components in the frontend.
## When to Apply
Reference these guidelines when:
- Working on `.{vue|css|scss}` files in `packages/frontend`
- Adding new components to `packages/frontend/@n8n/design-system`
- Refactoring styles for Vue components
- Implementing new UI components or features
- Reviewing changes to UI
## Rules
- Follow guidelines in `packages/frontend/@n8n/design-system/src/styleguide/*.mdx`
- ALWAYS use CSS variables for styles from `packages/frontend/@n8n/design-system/src/css/_tokens.scss` or `packages/frontend/@n8n/design-system/src/css/_primtivies.scss`. Use hard-coded values only when no suitable tokens.
- ALWAYS prefer using existing components from `packages/frontend/@n8n/design-system/src/components`. Prefer components that aren't marked `@deprecated`.
- Use `light-dark()` when alternating colors for ligh/dark mode
- When working with animations or transitions, ALWAYS prefer using mixins from `packages/frontend/@n8n/design-system/src/css/mixins/motion.scss`
- When reviewing animations, follow the guides in `rules/web-animation-guidelines.md`
- When reviewing UI changes or adding new components, follow `rules/web-interface-guidelines.md`
## Examples
- "Add a modal dialog for confirming workflow deletion" → Use `N8nDialog`
- "Add a dropdown to select workflow status" → Use `N8nDropdown` or `N8nSelect`
- "Add button with + icon to add new tiem" → Wrap `N8nButton` with `iconOnly` prop with `N8nTooltip` and wrap in `N8nTooltip`. Use `N8nIcon` and proper aria-label.
- "Add a destructive action button" → use `N8nButton` with `variant="destructive"`
- "Make background color white/black" → Use `var(--background--surface)` for white on light mode and "black" on dark mode
- "Animate the title in gracefully" -> Use `fade-in-up` mixin from `motion.scss` with `var(--duration--base)`
章节与文件索引
按说明文件中的顺序排列。
何时申请
规则
示例
文件/命令 -> .{vue|css|scss} · packages/frontend · packages/frontend/@n8n/design-system · packages/frontend/@n8n/design-system/src/styleguide/*.mdx · packages/frontend/@n8n/design-system/src/css/_tokens.scss · packages/frontend/@n8n/design-system/src/css/_primtivies.scss · packages/frontend/@n8n/design-system/src/components · @deprecated
内容校验值 -> 174cd05052d9
当前原文的自动摘译,尚未人工审校。
何时申请
在以下情况下请参考这些指南:
.{vue|css|scss}文件在packages/frontend添加新组件packages/frontend/@n8n/design-system重构 Vue 组件的样式 实现新的 UI 组件或功能规则
遵循以下指南
packages/frontend/@n8n/design-system/src/styleguide/*.mdx始终使用 CSS 变量作为样式packages/frontend/@n8n/design-system/src/css/_tokens.scss或packages/frontend/@n8n/design-system/src/css/_primtivies.scss。仅当没有合适的标记时才使用硬编码值。总是更喜欢使用现有的组件packages/frontend/@n8n/design-system/src/components。首选未标记的组件@deprecated。示例
“添加用于确认工作流程删除的模式对话框”→ 使用
N8nDialog“添加下拉菜单以选择工作流程状态”→ 使用N8nDropdown或N8nSelect“添加带有 + 图标的按钮以添加新关系”→ 换行N8nButton与iconOnly支撑与N8nTooltip并包裹在N8nTooltip。使用N8nIcon和适当的咏叹调标签。 “添加破坏性操作按钮”→使用N8nButton与variant="destructive"“将背景颜色设置为白色/黑色”→使用var(--background--surface)浅色模式下为白色,深色模式下为“黑色”