ui-registration

Register standardized UI pages, routes, and components for BrainDrive plugins.

Updated Feb 1, 2026
One-click install
npx skills add https://github.com/BrainDriveAI/BrainDrive-Plugin-Builder-ClaudeCode --skill ui-registration
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ui-registration
Source: https://github.com/BrainDriveAI/BrainDrive-Plugin-Builder-ClaudeCode/tree/main/.claude/skills/ui-registration
Command: npx skills add https://github.com/BrainDriveAI/BrainDrive-Plugin-Builder-ClaudeCode --skill ui-registration

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

BrainDrive plugins require a standardized method to declare which UI pages exist, how they route, and how components are wired for rendering within the plugin UI. Without registration, BrainDrive cannot mount or navigate plugin UI consistently across environments.

Core Features & Use Cases

  • Declares pages with slug, title, route, icon, and component to render.
  • Supports modules vs components, nested pages, and dynamic registrations.
  • Use case: register a dashboard and a settings page with proper routes and icons.

Quick Start

Define your plugin's UI pages using the registration schema and restart BrainDrive to apply the new routes.

Frequently Asked Questions about ui-registration

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

FAQPage Schema
How do I register UI pages and routes for a BrainDrive plugin?

UI page registration in BrainDrive requires specifying a slug, title, route, icon, and component for each page. This standardized schema allows BrainDrive to consistently mount and navigate plugin UI across environments.

What fields are required when declaring plugin UI pages and routes?

Required fields for declaring plugin UI pages include slug, title, route, icon, and component. Optional fields such as description, default, public, and children support nested pages and dynamic module registrations.

Can I use module federation to register nested pages in BrainDrive?

Yes, the registration system supports nested pages and dynamic registrations using module definitions. You can declare child pages via the optional children field to structure modules and components for rendering.

Why does my BrainDrive plugin UI fail to mount without page registration?

BrainDrive cannot mount or navigate plugin UI consistently without registration. The system requires declared pages, routes, and components validated at startup to ensure correct integration and rendering.

Does BrainDrive validate UI page exports during plugin startup?

Yes, BrainDrive applies export validation during startup to ensure correct integration. This validation checks that your declared UI pages, routes, and module definitions meet the required schema before loading.

How do I add a settings page with proper routes and icons to my plugin?

To add a settings page, define it in your plugin's UI registration schema using a unique slug, a descriptive title, the target route path, an icon, and the component to render, alongside any other pages like a dashboard.