mirror of
https://github.com/langgenius/dify.git
synced 2026-05-11 14:58:23 +08:00
1.9 KiB
1.9 KiB
Frontend Workflow
- Refer to the
./docs/test.mdand./docs/lint.mdfor detailed frontend workflow instructions.
Overlay Components (Mandatory)
../packages/dify-ui/README.mdis the permanent contract for overlay primitives, portals, rootisolation: isolate, and thez-50/z-60layering../docs/overlay.mdrecords the current web overlay best practices.- In new or modified code, use only overlay primitives from
@langgenius/dify-ui/*. - Do not introduce overlay imports from
@/app/components/base/*; when touching existing callers, migrate them.
Query & Mutation (Mandatory)
frontend-query-mutationis the source of truth for Dify frontend contracts, query and mutation call-site patterns, conditional queries, invalidation, and mutation error handling.
SVG Icons (Mandatory)
- New custom SVG icons must be added under
../packages/iconify-collections/assets/.... - Run
pnpm --filter @dify/iconify-collections generateand consume generated icons with Tailwindi-custom-*classes. - Restart the web dev server after regenerating icons because Tailwind loads the custom icon collection at startup.
- Do not add new generated React icon components or JSON files under
app/components/base/icons/src/.... - See
../packages/iconify-collections/README.mdfor the full workflow.
Design Token Mapping
- When translating Figma designs to code, read
../packages/dify-ui/AGENTS.mdfor the Figma--radius/*token to Tailwindrounded-*class mapping. The two scales are offset by one step.
Automated Test Generation
- Use
./docs/test.mdas the canonical instruction set for generating frontend automated tests. - When proposing or saving tests, re-read that document and follow every requirement.
- All frontend tests MUST also comply with the
frontend-testingskill. Treat the skill as a mandatory constraint, not optional guidance.