bitrix-components

Guide Bitrix component development with file structure, caching, and SEF routing.

33|3|Updated Jun 5, 2025

Search Tags:#development #templates #caching #components #ajax #bitrix #controllerable

Ready to run

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

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bitrix-components
Source: https://github.com/bxmaximum/bitrix_ai_challenge/tree/main/.agents/skills/bitrix-components
Command: npx skills add https://github.com/bxmaximum/bitrix_ai_challenge --skill bitrix-components

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Bitrix component development involves managing multiple files, caching logic, and advanced features like SEF routes and AJAX actions. This skill provides a structured guide to creating and editing Bitrix components and their templates, including best practices for file naming, caching, and controller capabilities.

Core Features & Use Cases

Covers essential files: class.php, .description.php, .parameters.php, templates, result_modifier.php, and component_epilog.php.
Explains caching with startResultCache/endResultCache, complex components with SEF/ЧПУ, Controllerable and AJAX via runComponentAction, and how to structure for maintainability.
Use cases include building modular components for Bitrix projects, implementing robust caching strategies, and integrating with enterprise routing.

Quick Start

Create a sample local Bitrix component following the described structure and cache guidelines to see the end-to-end workflow.

Frequently Asked Questions about bitrix-components

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I create a Bitrix component with the correct file structure?▼

Creating a Bitrix component requires structuring essential files like class.php, .description.php, and .parameters.php within your local project. This establishes the necessary logic, parameters, and templates to follow standard Bitrix development practices.

What is the best way to handle caching in Bitrix components?▼

Handling caching in Bitrix components involves using startResultCache and endResultCache methods. Proper cache key management is essential for performance, ensuring that data is stored and retrieved efficiently without causing conflicts during component execution.

How does SEF routing work for complex Bitrix components?▼

SEF routing for complex Bitrix components, also known as ЧПУ, maps clean URLs to component parameters. Setting this up correctly in your local project ensures that enterprise routing integrates seamlessly, providing maintainable and readable URLs for your application's users.

Can I use AJAX and Controllerable actions in Bitrix components?▼

Yes, you can implement AJAX in Bitrix components using the Controllerable interface and runComponentAction. This pattern enables dynamic workflows by routing specific actions through AJAX, allowing your component to process requests without reloading the entire page.

When do I need result_modifier.php and component_epilog.php in Bitrix templates?▼

You need result_modifier.php to modify template data before rendering and component_epilog.php to execute logic after caching in Bitrix templates. These files are crucial for maintaining dynamic content and handling post-rendering tasks without breaking the cache.

Does Bitrix component development require a specific environment setup?▼

Bitrix component development targets developers working on local Bitrix projects. You need a local environment configured for Bitrix to properly manage the required file structure, implement caching, and integrate SEF routing and AJAX workflows as guided by best practices.