Skip to main content

UI page or component

Introduction​

An External Object of nature UI page or component is a custom component that renders inside Simplicité's standard interface. It can be placed in views and home pages. When the UI Widget option is enabled, it can also be included in dashboards.

For the shared architecture (resources, Java class, rights model), see External Objects.

Features​

This nature covers a broad range of embedded UI use cases:

  • Standard widgets — Simplicité provides a library of predefined widget classes (cards, counters, carousels, etc.) usable without writing front-end code, configured entirely through the Settings field
  • Custom charts and data visualizations — by extending a chart class (e.g. com.simplicite.webapp.web.widgets.ChartjsExternalObject) and providing chart configuration in Settings
  • Fully custom components — any visual element or interactive panel built with HTML, CSS, and JavaScript using the platform's resource system

Configuration​

FieldDescription
CodeObject's unique identifier. Convention: ModulePrefix + ObjectName (e.g. TrnMyComponent)
NatureMust be set to UI page or component
ClassJava class extended by this object. Leave empty for fully custom components. Set to a predefined widget class when using a standard widget
SettingsOptional JSON configuration. See usage patterns below
UI WidgetControls whether this object can be added to Dashboard-type views. Does not affect availability in other view types (home pages, standard views)
ModuleModule this object belongs to. Determines the object's namespace and governs its packaging and deployment within the application

Settings field​

The Settings field accepts a JSON value and serves two distinct purposes:

1. Predefined widget setup​

When the Class field references a Simplicité standard widget class, Settings holds the JSON structure expected by that widget to declare its behavior and display options — without requiring custom code. Refer to the Standard Widgets documentation for the expected format per widget type.

2. Custom constants​

When building a fully custom component, Settings can hold any JSON structure you define (colors, titles, endpoint paths, feature flags, etc.). These values are then parsed in your Java class via the param argument and passed to the front-end as needed.

Last updated on