What’s New

The following new add-ons are now available:

The HTML components like div, span, h1…​h5 and others can now be bound to your data model entities declaratively in XML using the dataContainer and property attributes.

In many cases this will save you from writing code to set values in these components programmatically in view controllers.

Renderers for virtualList, dataGrid and other components can now be defined by fragments.

The new fragmentRenderer XML element should specify the fragment Java class, for example:

An example of the fragment used as a renderer:

The fragment renderer class should extend the FragmentRenderer base class with type parameters indicating the root component and rendered entity, for example:

The @RendererItemContainer annotation is used to specify the data container that accepts the rendered entity.

See #3699 for more information.

The new UiAsyncTasks bean allows you to execute an operation in a separate thread using the security context of the current user, and then update the UI with the result of that operation.

In comparison to Background Tasks, this is a lightweight mechanism based on CompletableFuture.

The textField and textArea components now have the trimEnabled attribute which controls whether the component trims spaces at the beginning and at the end of the entered string.

The jmix.ui.component.default-trim-enabled application property specifies the default value of this attribute for the whole application. In new projects, this property is true. The Studio migration procedure sets this property to false for existing projects to minimize changes in behavior.

The new ThemeUtils class contains methods for switching theme variants at runtime. This allows you to easily switch between light and dark themes in your application.

See an example in the Changing Theme Variants at Runtime section.

The new jmix.ui.component.immediate-required-validation-enabled application property allows you to disable validation of required fields on view opening.

When using the Grid Export Actions add-on, the set of export options can now be defined by a particular export action using its setAvailableExportModes() method and corresponding availableExportModes property in XML. The default set of options is defined by the jmix.gridexport.default-export-modes application property.

If a time zone is not assigned to the user explicitly, it can be obtained from the web browser at login. This option is controlled by the isAutoTimeZone() method of the HasTimeZone interface implemented by the standard User entity scaffolded in projects.

In existing projects the behavior won’t change, because this method returns false by default. In new projects User will be scaffolded with isAutoTimeZone() returning true.

More options have been introduced for configuring endpoints security when using Authorization Server or OpenID Connect add-ons:

See Token Based Authentication for more information.

The old AuthorizedUrlsProvider is deprecated, but still works, as well as jmix.rest.authenticated-url-patterns and jmix.rest.anonymous-url-patterns properties. It is recommended to move the configuration to the new interfaces or properties.

The new @ExtendedSearch annotation can be added to an index definition interface to provide functionality of "Starts with" search. It instructs the Search add-on to create additional "virtual" subfields for each "real" field to store prepared prefix terms.

The searchField component now allows users to open a Search settings window to set the search strategy, results size and, optionally, a set of entities to search only within these entities. If there are index definitions with @ExtendedSearch in the project, the list of strategies contains "Starts with".

allTermsAnyField and allTermsSingleField strategies have been deprecated.

Generic REST API now supports CRUD operations with DTO entities in the /entities endpoints. The search conditions provided to the entities/:entityName/search endpoint are converted to the Condition tree and passed to the DataManager. This allows you to request DTO entities that are in turn loaded from another REST API through the REST DataStore.

The JSON search conditions can now include objects in property values, for example:

The Jmix UI component inspector now groups the properties by categories: General, Data Binding, Size, Position, Look & Feel, Other. This new feature allows you to quickly locate the property you need without having to go through a long list.

Categories are displayed only in projects based on Jmix 2.4 and above.

Besides, the component inspector now provides better support for the icon property. You can click the "pencil" button in the value field to show a dialog with the list of available icons and select an icon from it.

Jmix Studio now provides advanced support for OpenAPI-based integration. These new features include configuration of the OpenAPI client generator in your project and automatic generation of DTO entities, mappers, and intermediate services, making it easier to integrate external REST APIs into Jmix applications.

For a practical example and step-by-step instructions on how to use these features, refer to the Integrating Applications Using OpenAPI guide.

We’ve added a new template for a composite project that is intended to be hosted in a monorepo. It provides a simple structure where all subprojects are located inside the root aggregate project:

This project layout is recommended if you are not going to store subprojects in separate repositories.

When using the Multitenancy add-on, the User entity does not have to implement the io.jmix.multitenancy.core.AcceptsTenant interface anymore. The @TenantId annotation on a tenant field is enough.

The AcceptsTenant interface has been deprecated and will be removed in a future major release.

When @EnableJmixDataRepositories is used on the main application class extending AppShellConfigurator, a clean build fails with the following message:

The problem is caused by vaadin/flow#19616 and will be fixed in a future patch.

To work around the problem, move the @EnableJmixDataRepositories annotation to a separate @Configuration class in the same package, for example:

Due to improvements in endpoints security configuration (see above), the following application property must be set to secure the Generic REST API endpoints:

The Studio migration procedure adds it to application.properties automatically.

Previously, generic REST API returned HTTP 500 code if the request to a secured endpoint was performed without Authorization header. Now it correctly returns HTTP 401.

listMenu component styles have been changed to fix the issue with focus ring:

If you have defined your own styles for this component, you may need to adjust them.

See #3589 for more information.

The dateTimeParameter(), dateParameter() and timeParameter() methods of the input dialog builder have been fixed: now they create parameters of java.util.Date, java.sql.Date and java.sql.Time type respectively. Previously they wrongly created LocalDateTime, LocalDate and LocalTime parameters.

See #3499 for more information.

The Studio migration procedure automatically replaces calls to these methods with calls to localDateTimeParameter(), localDateParameter() and localTimeParameter() to keep compatibility with returning values.

Previously, the Data Tools add-on contained transitive dependency to the Grid Export Actions add-on. This dependency has been removed, so now export actions can be used only when the Grid Export Actions add-on is included explicitly.

The Studio migration procedure automatically adds the Grid Export Actions add-on to the project if it includes the Data Tools add-on.

Spring Boot 3.3 brings the dependency on Liquibase 4.27, which changed column type for UUID attributes from char(36) to uuid. This is incompatible with the current support for MySQL/MariaDB databases in Jmix and causes invalid conversion of UUID values.

If you are using MariaDB, downgrade Liquibase in your project by adding the following dependency to build.gradle:

See #3888 for more information.