UI Framework REST Extensions module
Developer productivity Bundled: DX Core
| Edition | DX Core |
|---|---|
License |
|
Issues |
|
Maven site |
|
Latest |
1.0.6 |
The Magnolia UI Framework REST Extensions module is a DX Core Edition feature which complements the REST Client module by enabling configured REST clients as:
-
Datasources of subapps and UI elements such as the link field or Combobox field.
-
Search result suppliers for the Find Bar.
Installing with Maven
Bundled modules are automatically installed for you.
If the module is unbundled, add the following to your bundle including your project’s <dependencyManagement> section and your webapp’s <dependencies> section.
If the module is unbundled but the parent POM manages the version, add the following to your webapp’s <dependencies> section.
<dependency>
<groupId>info.magnolia.restclient</groupId>
<artifactId>magnolia-rest-client-ui</artifactId>
<version>1.0.6</version> (1)
</dependency>| 1 | Should you need to specify the module version, do it using <version>. |
Configuration
No configuration is required in this module. For REST Client configuration properties, see the REST Client module page.
Usage
Examples of using the UI Framework REST Extensions:
Handling offline datasources
The module provides two additional field types to handle offline datasources:
-
jsonLinkField -
jsonComboBoxField
These types wrap the linkField and comboBoxField types,
respectively, and check whether REST calls are working properly. If an
error occurs, a label appears next to the component that uses the REST
field type and the component is disabled.