Useful types
These public types are not the core DSL by themselves, but they appear often enough that they deserve documentation.
Messages and browser commands
Section titled “Messages and browser commands”Message
Section titled “Message”Represents user-facing feedback.
return new Message("Saved successfully");Useful for notifications and success/error messages.
UICommand
Section titled “UICommand”Represents commands executed in the browser.
Examples:
UICommand.navigateTo("/users");UICommand.runAction("refresh");UICommand.pushStateToHistory("/users?page=2");This is one of the key primitives for browser-side effects.
UICommandType
Section titled “UICommandType”Important values include:
NavigateToRunActionPushStateToHistoryCloseModalSetWindowTitleSetFaviconAddContentToHeadAddContentToBody
Forms and fields
Section titled “Forms and fields”FormField
Section titled “FormField”Core fluent representation of a field.
Contains:
- data type
- stereotype
- required / readOnly
- options
- remote coordinates
- detail path
- editor/create forms
- layout details
This is one of the most important low-level types in the fluent DSL.
FieldDataType
Section titled “FieldDataType”Important values include:
stringintegernumberdatetimedateTimeboolarrayfilestatusmoneycomponentmenurangeactionactionGroupdateRange
FieldStereotype
Section titled “FieldStereotype”This is the key enum behind @Stereotype / @Representation.
It defines the rendering type for a field.
Grids and listings
Section titled “Grids and listings”GridColumn
Section titled “GridColumn”Defines a column in a grid/listing.
Contains things like:
- id
- label
- data type
- stereotype
- alignment
- sorting
- filtering
- width
- text/action behavior
GridContent
Section titled “GridContent”Base interface for fluent grid content.
GridGroupColumn
Section titled “GridGroupColumn”Groups multiple grid columns together.
Relationships and options
Section titled “Relationships and options”Option
Section titled “Option”Represents a selectable option.
Useful for:
- dropdowns
- radio/checkbox style choices
- lookup results
RemoteCoordinates
Section titled “RemoteCoordinates”Represents how a field can resolve remote data.
Used in relationship-heavy or distributed scenarios.
Common visual primitives
Section titled “Common visual primitives”These types are often embedded in pages and forms:
TextImageAvatarBadgeNotificationPopoverElementMicroFrontendScrollerSplitLayoutAccordionLayoutTabLayoutFullWidth
These are worth knowing because they are the building blocks of richer fluent UI composition.
Status and notifications
Section titled “Status and notifications”Status
Section titled “Status”Maps semantic state to a StatusType.
NotificationVariant
Section titled “NotificationVariant”Defines the visual variant of notifications/messages.
Message
Section titled “Message”Convenient high-level feedback type returned by actions.
Mental model
Section titled “Mental model”Useful types are the vocabulary around the DSL.
They are the pieces that make routing, forms, listings, effects and composition work together.