OpenParable
Skip to content
← Back to skills

Configure Plugin Navigation

Development
configure-plugin-navigation

Configure 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.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. 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

  1. Open the plugin's src/config.tsx and nearby plugin config files.
  2. Reuse the plugin's existing IUIConfig shape: name, path, icon, navigationGroup, modules, and widgets when present.
  3. Use icons from @tabler/icons-react and keep icon naming consistent with nearby config files.
  4. Add module entries only when the module should appear in app navigation or settings navigation.
  5. Add relationWidgets or floating widgets only when the plugin exposes and implements those widget surfaces.
  6. Keep paths aligned with route registration and Module Federation exposes.
  7. Run pnpm nx lint <plugin> and pnpm nx build <plugin> for code changes.

Important

  • Do not add plugin-specific navigation or widgets in frontend/core-ui.
  • Do not use IconSandbox as a final icon unless the surrounding plugin is intentionally still placeholder-quality.
  • Check module-federation.config.ts before 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.