mcpField
B
bitrix-components

bitrix-components

github.com/bxmaximum开发47198 次安装2 周前更新
代码仓库

关于 bitrix-components

bitrix-components 是面向 Bitrix 开发者的组件开发规范与参考索引,涵盖组件结构、模板、缓存、SEF 和 AJAX。它还列出组件实现中的参数处理、输出转义和缓存键等约束。

主要功能

  1. 01组件目录与文件结构规范
  2. 02模板查找、覆盖与渲染指引
  3. 03缓存、分页、SEF 与 AJAX 规则
  4. 04组件参数转换要求
  5. 05输出转义与缓存键约束

适用场景

  1. 01搭建本地自定义 Bitrix 组件
  2. 02查找模板覆盖和渲染方式
  3. 03实现带分页或 SEF 的组件
  4. 04为组件配置缓存与 AJAX 操作

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/bxmaximum/bitrix-framework-skills --skill bitrix-components

安装后在 Claude Code 中输入/bitrix-components确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

rules/
cache-sef-ajax.md
structure.md
template.md

详细介绍

Bitrix 组件

基线:main 23.0+ · 已验证:main 26.800.0

任务阅读
放置位置、脚手架、class.php、参数、.description.php、.parameters.phprules/structure.md
模板搜索顺序与覆盖、template.php、result_modifier.php、component_epilog.phprules/template.md
结果缓存、分页列表、复杂 SEF、AJAX 操作rules/cache-sef-ajax.md
PageNavigation、分页器模板bitrix-cms-basics
模板中的网格、筛选器、工具栏bitrix-ui

不变原则

  • 自有组件放在 /local/components/<vendor>/;内核组件只能通过将其模板复制到 /local/templates/<site>/components/… 来修改。
  • 逻辑放在 class.php 和服务中;模板只负责渲染 $arResult 并转义输出。
  • onPrepareComponentParams() 会转换每个参数的类型;~KEY 是原始值。
  • 所有会改变输出的因素都必须包含在缓存键中(用户组、页码、筛选条件)。
  • 嵌套组件通过 IncludeComponent() 的第 4 个参数获取 $component。
  • 通过带有预过滤器和签名参数的 Controllerable 操作处理 AJAX。

评论

支持 Markdown