Configure Plugin Navigation
Developmentconfigure-plugin-navigationConfigure Plugin Navigation is an Agent Skill for development published in the erxes/erxes repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Configure erxes frontend plugin navigation, settings navigation, icons, module entries, widget declarations, and config paths. Use when changing src/config.tsx or plugin navigation surfaces.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/erxes/erxes/blob/HEAD/.agents/skills/configure-plugin-navigation/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/configure-plugin-navigation, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Skill: Configure Plugin Navigation
Workflow
- Open the plugin's
src/config.tsxand nearby plugin config files. - Reuse the plugin's existing
IUIConfigshape:name,path,icon,navigationGroup,modules, andwidgetswhen present. - Use icons from
@tabler/icons-reactand keep icon naming consistent with nearby config files. - Add module entries only when the module should appear in app navigation or settings navigation.
- Add
relationWidgetsor floating widgets only when the plugin exposes and implements those widget surfaces. - Keep paths aligned with route registration and Module Federation exposes.
- Run
pnpm nx lint <plugin>andpnpm nx build <plugin>for code changes.
Important
- Do not add plugin-specific navigation or widgets in
frontend/core-ui. - Do not use
IconSandboxas a final icon unless the surrounding plugin is intentionally still placeholder-quality. - Check
module-federation.config.tsbefore adding widget or module config that depends on a remote expose. - Preserve
hasSettings, relation widget, and floating widget behavior used by nearby plugin config files.