Page tree
Skip to end of metadata
Go to start of metadata

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:

Installing

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.restclient</groupId>
  <artifactId>magnolia-rest-client-ui</artifactId>
  <version>1.0.2</version>
</dependency>

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.