mcpField
B
bitrix-components

bitrix-components

github.com/bxmaximum開発47198 回インストール2 週間前に更新
リポジトリ

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 を渡します。
  • AJAX には、プリフィルターと署名付きパラメーターを使用する Controllerable アクションを使用します。

コメント

Markdown 対応