docyrus-app-ui-design

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Docyrus App UI Design

Docyrus应用UI设计

Build polished, accessible UI components for Docyrus React applications using a curated set of 127+ pre-built components from shadcn, diceui, animate-ui, docyrus-ui, and reui libraries.
为Docyrus React应用构建精致、易用的UI组件,可从shadcn、diceui、animate-ui、docyrus-ui和reui库中挑选127+个预先构建的组件。

Component Library Preferences

组件库偏好

Primary component libraries (in order of preference):
  1. shadcn — 43 core components (buttons, forms, dialogs, tables, charts)
  2. diceui — 42 advanced components (data grids, kanban, file upload, color picker)
  3. animate-ui — 21 animated components (sidebar, dialogs, cards, menus)
  4. docyrus — 19 Docyrus-specific components (data grid, form fields, value renderers)
  5. reui — 2 utility components (file upload, sortable)
Total available: 127 components
首选组件库(按优先级排序):
  1. shadcn — 43个核心组件(按钮、表单、对话框、表格、图表)
  2. diceui — 42个高级组件(数据网格、看板、文件上传、颜色选择器)
  3. animate-ui — 21个动画组件(侧边栏、对话框、卡片、菜单)
  4. docyrus — 19个Docyrus专属组件(数据网格、表单字段、值渲染器)
  5. reui — 2个实用组件(文件上传、可排序组件)
可用组件总数:127个

Critical Design Rules

关键设计规则

  1. Always check preferred components first — Before implementing any new component, search the preferred components reference to find an existing match.
  2. Use AwesomeCard for dashboards — Unless the user specifically requests a different card design, use
    @docyrus/ui-awesome-card
    for dashboard stat cards and metrics.
  3. Use animate-ui Sidebar for layouts — Unless the user requests a different layout, use
    @animate-ui/sidebar
    for app navigation.
  4. Prefer Recharts for charting — Use Recharts as the first choice for all data visualization needs. shadcn Chart components are built on Recharts.
  5. Icon library preference order:
    • First choice: hugeicons
    • Second choice: fontawesome light
    • Third choice: lucide-icons
  1. 优先检查首选组件 — 在实现任何新组件之前,先在首选组件参考文档中搜索是否有现成的匹配组件。
  2. 仪表盘使用AwesomeCard — 除非用户明确要求不同的卡片设计,否则仪表盘统计卡片和指标使用
    @docyrus/ui-awesome-card
  3. 布局使用animate-ui侧边栏 — 除非用户要求不同的布局,否则应用导航使用
    @animate-ui/sidebar
  4. 图表优先使用Recharts — 所有数据可视化需求优先选择Recharts。shadcn的Chart组件基于Recharts构建。
  5. 图标库偏好顺序
    • 首选:hugeicons
    • 次选:fontawesome light
    • 第三选择:lucide-icons

Quick Start Patterns

快速入门模式

Dashboard with AwesomeCard

使用AwesomeCard的仪表盘

tsx
import { AwesomeCard } from '@/components/ui/awesome-card'
import { HugeIcon } from '@/components/ui/icons'

<AwesomeCard
  title="Total Revenue"
  value="$124,500"
  icon={<HugeIcon name="dollar-circle" />}
  trend={{ value: 12.5, direction: 'up' }}
/>
tsx
import { AwesomeCard } from '@/components/ui/awesome-card'
import { HugeIcon } from '@/components/ui/icons'

<AwesomeCard
  title="Total Revenue"
  value="$124,500"
  icon={<HugeIcon name="dollar-circle" />}
  trend={{ value: 12.5, direction: 'up' }}
/>

App Layout with animate-ui Sidebar

使用animate-ui侧边栏的应用布局

tsx
import { Sidebar, SidebarContent, SidebarHeader } from '@/components/ui/sidebar'

<Sidebar>
  <SidebarHeader>
    <AppLogo />
  </SidebarHeader>
  <SidebarContent>
    <NavItems />
  </SidebarContent>
</Sidebar>
tsx
import { Sidebar, SidebarContent, SidebarHeader } from '@/components/ui/sidebar'

<Sidebar>
  <SidebarHeader>
    <AppLogo />
  </SidebarHeader>
  <SidebarContent>
    <NavItems />
  </SidebarContent>
</Sidebar>

Data Table with diceui

使用diceui的数据表格

tsx
import { DataTable } from '@/components/ui/data-table'

<DataTable
  columns={columns}
  data={projects}
  enableFiltering
  enableSorting
  enablePagination
/>
tsx
import { DataTable } from '@/components/ui/data-table'

<DataTable
  columns={columns}
  data={projects}
  enableFiltering
  enableSorting
  enablePagination
/>

Charts with shadcn + Recharts

使用shadcn + Recharts的图表

tsx
import { ChartContainer, ChartTooltip } from '@/components/ui/chart'
import { LineChart, Line, XAxis, YAxis } from 'recharts'

<ChartContainer>
  <LineChart data={chartData}>
    <XAxis dataKey="month" />
    <YAxis />
    <ChartTooltip />
    <Line type="monotone" dataKey="revenue" />
  </LineChart>
</ChartContainer>
tsx
import { ChartContainer, ChartTooltip } from '@/components/ui/chart'
import { LineChart, Line, XAxis, YAxis } from 'recharts'

<ChartContainer>
  <LineChart data={chartData}>
    <XAxis dataKey="month" />
    <YAxis />
    <ChartTooltip />
    <Line type="monotone" dataKey="revenue" />
  </LineChart>
</ChartContainer>

Component Selection Strategy

组件选择策略

When the user requests a UI component:
  1. Search the reference — Check
    references/preferred-components-catalog.md
    for existing components by name, category, or functionality
  2. Match by use case — If multiple options exist, prefer:
    • shadcn for basic/common components
    • diceui for advanced/specialized components
    • animate-ui for components requiring animation/transitions
    • docyrus for Docyrus-specific data handling
  3. Install the component — Use the registry install command from the catalog
  4. Reference the docs — Point to the component's doc file for detailed usage
当用户请求UI组件时:
  1. 搜索参考文档 — 查看
    references/preferred-components-catalog.md
    ,按名称、类别或功能查找现有组件
  2. 按用例匹配 — 如果有多个选项,优先选择:
    • shadcn用于基础/通用组件
    • diceui用于高级/专业组件
    • animate-ui用于需要动画/过渡效果的组件
    • docyrus用于Docyrus专属的数据处理组件
  3. 安装组件 — 使用组件目录中的注册表安装命令
  4. 参考文档 — 查看组件的文档文件获取详细使用说明

Installation Pattern

安装模式

All components follow the shadcn registry pattern:
bash
undefined
所有组件均遵循shadcn注册表模式:
bash
undefined

shadcn components

shadcn components

pnpm dlx shadcn@latest add button
pnpm dlx shadcn@latest add button

diceui components

diceui components

pnpm dlx shadcn@latest add @diceui/data-table
pnpm dlx shadcn@latest add @diceui/data-table

animate-ui components

animate-ui components

pnpm dlx shadcn@latest add @animate-ui/sidebar
pnpm dlx shadcn@latest add @animate-ui/sidebar

docyrus components

docyrus components

pnpm dlx shadcn@latest add @docyrus/ui-awesome-card
pnpm dlx shadcn@latest add @docyrus/ui-awesome-card

reui components

reui components

pnpm dlx shadcn@latest add @reui/file-upload-default
undefined
pnpm dlx shadcn@latest add @reui/file-upload-default
undefined

Common Use Cases

常见用例

Use CasePreferred ComponentLibrary
Dashboard cardsAwesomeCarddocyrus
App navigationSidebaranimate-ui
Data tablesDataTablediceui
Editable gridsData Griddocyrus
FormsForm Fieldsdocyrus
File uploadFile Uploaddiceui
ChartsChart + Rechartsshadcn
DialogsResponsive Dialogdiceui
Date pickerDate Time Pickerdocyrus
Color pickerColor Pickerdiceui
Kanban boardKanbandiceui
TimelineTimelinediceui
RatingRatingdiceui
用场景首选组件
仪表盘卡片AwesomeCarddocyrus
应用导航Sidebaranimate-ui
数据表格DataTablediceui
可编辑网格Data Griddocyrus
表单Form Fieldsdocyrus
文件上传File Uploaddiceui
图表Chart + Rechartsshadcn
对话框Responsive Dialogdiceui
日期选择器Date Time Pickerdocyrus
颜色选择器Color Pickerdiceui
看板Kanbandiceui
时间线Timelinediceui
评分Ratingdiceui

References

参考资料

Read these files for detailed component information:
  • references/preferred-components-catalog.md
    — Complete catalog of all 127 components with descriptions, install commands, and doc paths
  • references/component-selection-guide.md
    — Decision trees and guidelines for choosing the right component for each use case
  • references/icon-usage-guide.md
    — Icon library integration patterns and usage examples for hugeicons, fontawesome, and lucide
查看以下文件获取组件详细信息:
  • references/preferred-components-catalog.md
    — 包含所有127个组件的完整目录,含描述、安装命令和文档路径
  • references/component-selection-guide.md
    — 组件选择的决策树和指南,帮助为每个用例选择合适的组件
  • references/icon-usage-guide.md
    — hugeicons、fontawesome和lucide图标的库集成模式及使用示例

Integration with docyrus-app-dev

与docyrus-app-dev的集成

This skill works alongside
docyrus-app-dev
for full-stack app development:
  • docyrus-app-dev handles data fetching, collections, queries, auth
  • docyrus-app-ui-design handles component selection, UI design, layout
When building a feature:
  1. Use
    docyrus-app-dev
    to set up data queries and mutations
  2. Use
    docyrus-app-ui-design
    to select and implement UI components
  3. Combine them for complete, polished features
此技能与
docyrus-app-dev
配合使用,可进行全栈应用开发:
  • docyrus-app-dev 负责数据获取、集合、查询、认证
  • docyrus-app-ui-design 负责组件选择、UI设计、布局
构建功能时:
  1. 使用
    docyrus-app-dev
    设置数据查询和变更
  2. 使用
    docyrus-app-ui-design
    选择并实现UI组件
  3. 结合两者完成精致的完整功能