lynx-ui
帮助 coding agent 基于 lynx-ui 仓库中的精选参考资料使用 @lynx-js/lynx-ui 组件。
适合在以下场景使用:
- 为功能选择合适的 lynx-ui 组件
- 确认组件支持的 props、事件、ref 方法、导出项或类型别名
- 将官方示例改写为项目代码
- 对照公开 API 排查组件使用问题
- 避免 agent 凭模型记忆编造不存在的 lynx-ui API
安装
这会安装 lynx-ui skill,让兼容的 coding agent 自动加载它的路由指南和参考资料。
包含内容
lynx-ui 按渐进读取方式组织:
SKILL.md:agent 的入口和工作流规则reference.md:组件选择和路由指南references/index.md:当前覆盖的组件列表references/components/<component>/guide.md:使用模式、组合方式和常见问题references/components/<component>/api.md:公开 API 的事实来源references/components/<component>/examples.md:精简实现模式
推荐工作流
在实现 lynx-ui 代码前,让 agent 优先使用 lynx-ui。
- 确认具体组件,或缩小到少量候选组件。
- 组件选择不明确时,先阅读
reference.md。 - 先阅读组件的
guide.md,理解使用模式。 - 需要确认公开 API 细节时,再阅读
api.md。 - 只有需要实现示例模式时,才阅读
examples.md。
默认建议 agent 从 @lynx-js/lynx-ui 导入组件,并将 api.md 作为 props、事件、ref 方法和导出类型的事实来源。