Annotations Overview

Erupt's annotation system is organized along two main lines: class-level and field-level. @Erupt defines the entity's overall behavior, while @EruptField declares how each field is displayed and edited. Feature annotations attach to them as attributes, forming the hierarchy below.

@EruptScanEntryPlaced on the boot class to declare package paths to scan for Erupt entities

@EruptClassClass-level annotation defining entity behavior and page capabilities

• power =@PowerPermission control for CRUD actions
• rowOperation =@RowOperationCustom row-action buttons
• drills =@DrillData drilldown, one-to-many without foreign keys
• filter =@FilterConditional data filters
• orderBy =@OrderBySort rules
• tree =@TreeTree-based data display
• linkTree =@LinkTreeTree-on-the-left, table-on-the-right layout
• layout =@LayoutPage layout and pagination
• dragSort =@DragSortRow drag-sort for tables
• vis =@VisMulti-view switching
  CARDGANTTBOARDCALENDAR

@EruptFieldFieldField-level annotation declaring how a field is displayed and edited

• views =@ViewTable-column display configuration
• edit =@EditEdit-form configuration
  • type =EditType30+ component types, see Components overview
  • search =@SearchSearch bar configuration
  • onchange =OnChangeData-change linkage, update other fields in real time
  • dynamic =@DynamicDynamic component control

Recommendations

1. Start with the basics — understand @Erupt first, then move on to feature annotations.
2. Permissions first — configure @Power to keep your data safe.
3. Polish your layout with @Layout for a better UX.
4. Master @Drill and @LinkTree to model complex data relationships.
5. Combine @View and @Edit for fine-grained control over display and editing.
6. Use @Dynamic to build conditional, interactive forms.

Contributors

YuePeng

Claude Opus 5 (1M context)

Changelog

Last edited 2 minutes ago

View full history

f3752b9-filter: add a role-based row-level data filtering example