magento-ui-component-developer — Claude Code skill
The magento-ui-component-developer skill builds Magento UI Component grids, forms, modals, and data-driven interfaces. Use it when an admin or frontend component needs structured configuration.
MIT 200 installs ★ 33 updated 2026-01-24
npx skills add maxnorm/magento2-agent-skills --skill magento-ui-component-developer -a claude-codeWhat magento-ui-component-developer does
The skill covers Magento UI Component work for admin and frontend interfaces. It can shape listings with filters, sorting, and pagination, plus validated forms, multi-step flows, conditional fields, modal dialogs, and reporting views. It also handles component hierarchy, XML definitions, communication between components, and event-driven behavior.
Its building blocks include data providers, collections, KnockoutJS templates, data binding, observable arrays, and JavaScript modules. A collection provider can implement DataProviderInterface, while form providers load and save values, validate them, and manage field dependencies. When a project does not use Magento UI Component framework, this skill’s component guidance does not apply.
What it helps with
- build an admin grid with filtering and sorting
- create a Magento form with field validation
- connect a UI Component to a collection data provider
- add a modal that contains a form
- paginate a large data set
Example prompts for the agent
- Build a Magento admin grid with filtering, sorting, and pagination.
- Create a multi-step form with conditional fields and validation.
- Connect a data provider to a collection and configure data loading for this UI Component.
How to install magento-ui-component-developer
1Skills CLI (Vercel)
npx skills add maxnorm/magento2-agent-skills --skill magento-ui-component-developer -a claude-code2Manually: put the files in place
~/.claude/skills/magento-ui-component-developer/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/magento-ui-component-developer/
1Skills CLI (Vercel)
npx skills add maxnorm/magento2-agent-skills --skill magento-ui-component-developer -a codex2Manually: put the files in place
.agents/skills/magento-ui-component-developer/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add maxnorm/magento2-agent-skills --skill magento-ui-component-developer -a cursor2Manually: put the files in place
.cursor/skills/magento-ui-component-developer/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install maxnorm/magento2-agent-skills skills/magento-ui-component-developer2Manually: put the files in place
.github/skills/magento-ui-component-developer/SKILL.md1Skills CLI (Vercel)
npx skills add maxnorm/magento2-agent-skills --skill magento-ui-component-developer -a gemini-cli2Platform CLI
gemini skills install https://github.com/maxnorm/magento2-agent-skills --path skills/magento-ui-component-developerManually: put the files in place
.devin/skills/magento-ui-component-developer/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add maxnorm/magento2-agent-skills --skill magento-ui-component-developer -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about magento-ui-component-developer
How do I install magento-ui-component-developer in Claude Code?
Run npx skills add maxnorm/magento2-agent-skills --skill magento-ui-component-developer -a claude-code, then check ~/.claude/skills/magento-ui-component-developer/SKILL.md.
What does magento-ui-component-developer do?
It guides Magento UI Component development for grids, forms, dialogs, and data-driven views. The skill works with XML configuration, data providers, KnockoutJS, and JavaScript modules.
Which platforms support this skill?
It supports Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, and OpenCode.
Source text
SKILL.md · MIT
---
name: magento-ui-component-developer
description: Builds sophisticated admin interfaces and frontend components using Magento's UI Component framework. Use when creating admin grids, forms, modals, or data-driven interfaces. Masters XML configuration, KnockoutJS templates, data providers, and complex form/grid implementations.
---
# Magento 2 UI Component Developer
Expert specialist in creating sophisticated, data-driven interfaces using Magento's powerful UI Component framework for both admin and frontend applications.
## When to Use
- Creating admin grids and forms
- Building data-driven interfaces
- Developing custom UI components
- Implementing complex forms with validation
- Creating modal dialogs and popups
- Building reporting and analytics interfaces
## UI Component Architecture
- **Component Hierarchy**: Master parent-child component relationships and inheritance
- **XML Configuration**: Expert in component definition and configuration files
- **Data Providers**: Implement efficient data sources and collection management
- **KnockoutJS Integration**: Build reactive templates and data binding
- **Component Communication**: Handle inter-component communication and events
## Component Types
### Listing Components (Grids)
- **Data Grids**: Create advanced data grids with filtering and sorting
- **Product Grids**: Product management interfaces
- **Order Grids**: Order management systems
- **Customer Grids**: Customer data management interfaces
- **Custom Entity Grids**: Grids for custom data entities
### Form Components
- **Product Forms**: Complex product editing interfaces
- **Configuration Forms**: System configuration interfaces
- **Customer Forms**: Customer data entry forms
- **Multi-step Forms**: Wizard-style form interfaces
- **Dynamic Forms**: Forms with conditional field display
### Modal Components
- **Dynamic Modals**: Modal dialogs and popups
- **Form Modals**: Forms within modal dialogs
- **Confirmation Dialogs**: Confirmation and alert dialogs
- **Custom Modals**: Specialized modal implementations
## UI Component Development Process
### 1. Component Planning & Design
- **Requirements Analysis**: Define component functionality and user interactions
- **Data Architecture**: Plan data structure and provider requirements
- **UX Design**: Design user-friendly interfaces and workflows
- **Performance Considerations**: Plan for scalability and optimization
- **Integration Strategy**: Plan integration with existing systems
### 2. Component Structure Setup
- **XML Configuration**: Create component definition files
- **Directory Structure**: Organize component files and dependencies
- **Data Provider**: Implement data source and collection handling
- **Template Files**: Create KnockoutJS templates for rendering
- **JavaScript Modules**: Build component logic and interactions
### 3. Data Management
- **Collection Building**: Create efficient data collections
- **Filtering & Sorting**: Implement advanced filtering and sorting capabilities
- **Pagination**: Handle large datasets with pagination
- **Search Functionality**: Implement search and filter mechanisms
- **Data Validation**: Ensure data integrity and validation
### 4. User Interface Development
- **Responsive Design**: Create interfaces that work across devices
- **Accessibility**: Implement WCAG compliance and keyboard navigation
- **User Experience**: Optimize for intuitive user interactions
- **Performance**: Ensure fast loading and smooth interactions
- **Cross-browser**: Ensure compatibility across browsers
## XML Configuration
### Component Definition
```xml
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
<argument name="data" xsi:type="array">
<item name="js_config" xsi:type="array">
<item name="provider" xsi:type="string">vendor_module.grid_data_source</item>
</item>
</argument>
<columns name="columns">
<column name="id">
<settings>
<filter>text</filter>
<label translate="true">ID</label>
</settings>
</column>
</columns>
</listing>
```
### Form Configuration
```xml
<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
<fieldset name="general">
<field name="name">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="label" xsi:type="string" translate="true">Name</item>
<item name="dataType" xsi:type="string">text</item>
<item name="validation" xsi:type="array">
<item name="required-entry" xsi:type="boolean">true</item>
</item>
</item>
</argument>
</field>
</fieldset>
</form>
```
## Data Providers
### Collection Data Provider
- Implement `\Magento\Framework\View\Element\UiComponent\DataProvider\DataProviderInterface`
- Create efficient data collections
- Handle filtering, sorting, and pagination
- Optimize database queries
### Form Data Provider
- Load and save form data
- Handle form field dependencies
- Implement data validation
- Manage form state
## KnockoutJS Templates
### Template Development
- Create KnockoutJS templates for component rendering
- Implement data binding
- Handle user interactions
- Manage component state
### Data Binding
- Two-way data binding
- Computed observables
- Observable arrays
- Custom bindings
## Best Practices
### Performance
- **Efficient Collections**: Optimize data collection queries
- **Lazy Loading**: Load data on demand
- **Caching**: Cache frequently accessed data
- **Pagination**: Implement proper pagination for large datasets
### Code Organization
- **Modular Structure**: Organize components in logical modules
- **Reusable Components**: Create reusable component patterns
- **Documentation**: Maintain clear component documentation
- **Testing**: Write tests for component functionality
### User Experience
- **Responsive Design**: Ensure mobile-friendly interfaces
- **Accessibility**: Implement WCAG compliance
- **Error Handling**: Provide clear error messages
- **Loading States**: Show appropriate loading indicators
## References
- [Adobe Commerce UI Components](https://developer.adobe.com/commerce/frontend-core/ui-components/)
- [KnockoutJS Documentation](https://knockoutjs.com/)
- [UI Component Guide](https://developer.adobe.com/commerce/frontend-core/guide/ui-components/)
Focus on creating intuitive, performant UI components that enhance user experience and productivity.
© maxnorm · MIT · maxnorm/magento2-agent-skills