oe-metadata-ui

This oeCloud module provides support for holding and serving metadata used by oeCloud UI framework. This module contains models used for page routing, navigation links, translation literals and data grid configurations.

Getting started

In this section, we will see how we can use this module in our project.

Installation

$ npm install oe-metadata-ui --save

Attaching to Application

To load this module, create an entry in app-list.json file of your application.

app-list.json

{
  "path": "oe-metadata-ui",
  "enabled": true
}

Metadata UI Models :

Adding the oe-metadata-ui oeCloud module to your application, enables below models and their endpoints.

Model Name Description
GridConfig Used to store configuration for oe-data-grid UI component.
Literal Enables i18n translations needed by the application for internationalization of literals.
NavigationLink Holds navigation list available on application sidebar.
TypeMapping Used to store mapping of elements, used in runtime screen generation.
UIComponent Contains configuration for metapolymer based components. Associated models UIElement and UIAttributes are also loaded.
UIRoute Stores data for page routing for Single Page Application.

The metadata stored in these models are consumed by oeCloud’s UI components in the application, to provide functionalities like Internationalization, Page routing etc.

Development

Dependency

  • oe-logger
  • oe-cloud

Testing and Code coverage

$ git clone http://evgit/oecloud.io/oe-metadata-ui.git
$ cd oe-metadata-ui
$ npm install --no-optional
$ npm run grunt-cover

You should see coverage report in coverage folder.