odui-dev

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Develop with Open Design UI

使用 Open Design UI 开发

Read AGENTS.md and the component guide. The catalogue uses the same component source as Studio and does not require the Studio backend.
  1. From the repository root run
    npm ci
    once when dependencies are missing, then run
    npm run components:dev
    .
  2. Open the local URL printed by Vite. Use Components for the live state matrix, Design tokens for semantic values and Contribution guide for the workflow.
  3. Use Preview and Code on a component page. Check keyboard, focus, disabled/loading, both themes and relevant narrow widths. Use Copy to Agent or Copy migration prompt when handing work to another Agent.
  4. Keep the dev server running while editing. Saving a component or example should update the page. If a change needs Studio behavior, use
    odui-apply
    after the catalogue check.
  5. For a shareable artifact run
    npm run components:build
    and inspect the built route before reporting it.
Do not treat a catalogue preview as proof that a Studio consumer is correct. The real consumer and its focused test remain part of the handoff.
阅读 AGENTS.md 和组件指南。该组件目录与 Studio 使用相同的组件源,并且不需要 Studio 后端。
  1. 如果缺少依赖,请从仓库根目录运行一次
    npm ci
    ,然后运行
    npm run components:dev
    。
  2. 打开 Vite 输出的本地 URL。使用 Components 查看实时状态矩阵,使用 Design tokens 查看语义值,使用 Contribution guide 了解工作流。
  3. 在组件页面使用 Preview 和 Code。检查键盘操作、焦点、disabled/loading 状态、两种主题以及相关的窄屏宽度。将工作移交给另一个 Agent 时,使用 Copy to Agent 或 Copy migration prompt。
  4. 编辑时保持开发服务器运行。保存组件或示例后,页面应自动更新。如果某项变更需要 Studio 行为,请在检查组件目录后使用
    odui-apply
    。
  5. 若需生成可共享的产物,请运行
    npm run components:build
    ,并在报告完成前检查构建后的路由。
不要将组件目录中的预览视为 Studio 使用方实现正确的证明。实际使用方及其专项测试仍属于交付范围。