用途:这是 Bitrix24 UI 组件库的贡献指南,用于指导开发者按统一规范新增或修改组件,涵盖组件结构、主题、测试与文档四方面。
主要能力与用法:项目结构分为 src/runtime(组件、composables、types、utils)、src/theme(Tailwind Variants 主题,kebab-case.ts)、test/components(*.spec.ts 测试与快照)、docs/content/docs/2.components(MDC 文档)以及 playgrounds。脚手架需先执行 npm link 完成一次性配置,再用 bitrix24-ui make component <name> 创建组件,支持 --primitive、--prose、--content 及 --template 选项。创建流程共十步:脚手架、实现组件、建主题、导出类型、写测试、写文档、加 playground 页面,随后运行 pnpm run lint、typecheck、test。可用参考文件按任务按需加载:component-structure.md、theme-structure.md、testing.md、documentation.md,不建议一次全部加载。
约定:类型导入单独成行;props 默认值用 withDefaults(),文档用 @defaultValue;模板插槽元素加 data-slot 属性;响应式主题用 computed(() => tv(...));通过 useComponentUI(name, props) 合并主题;颜色使用 text-default、bg-elevated 等语义色而非 Tailwind 调色板;转发 Reka UI props 用 reactivePick 与 useForwardPropsEmits;表单组件用 useFormField 与 useFieldGroup。常用命令包括 pnpm run dev:prepare、dev、dev:vue、docs、lint、lint:fix、typecheck、test。
适用场景与限制:适用于向 Bitrix24 UI 提交组件相关贡献的开发者,PR 需保证组件符合既有模式、测试覆盖 props/插槽/可访问性、文档含 Usage、Examples 与 API,且检查全部通过。具体贡献入口链接与 GitHub 地址等细节暂未提供完整信息。