Annotations Overview
An index of Erupt's core annotations, with details on every major feature.
Class-level Annotations
| Annotation | Link | Description |
|---|---|---|
@Erupt | @Erupt | Core annotation that defines the entity behavior |
@OrderBy | @OrderBy | Sort rules |
@Layout | @Layout | Page layout and pagination |
@Power | @Power | Permission control for CRUD actions |
@RowOperation | @RowOperation | Custom row-action buttons |
@Filter | @Filter | Conditional data filters |
@Tree | @Tree | Tree-based data display |
@LinkTree | @LinkTree | Tree-on-the-left, table-on-the-right layout |
@Drill | @Drill | Data drilldown (one-to-many without foreign keys) |
@Vis | @Vis | Switch between card, gantt, kanban, and other views |
Field-level Annotations
| Annotation | Link | Description |
|---|---|---|
@EruptField | @EruptField | Field declaration (contains views and edit) |
@Edit | @Edit | Edit-form configuration |
@View | @View | Table-column display configuration |
@Search | @Search | Search bar configuration |
@Dynamic | @Dynamic | Dynamic component control (1.13.1+) |
Recommendations
- Start with the basics — understand
@Eruptfirst, then move on to feature annotations. - Permissions first — configure
@Powerto keep your data safe. - Polish your layout with
@Layoutfor a better UX. - Master
@Drilland@LinkTreeto model complex data relationships. - Combine
@Viewand@Editfor fine-grained control over display and editing. - Use
@Dynamicto build conditional, interactive forms.
Contributors
YuePeng