Onap-ui-common NPM

ONAP-UI-COMMON

This project aims to create a unified UI styled components for multiple development teams who work on the same web-based applications. This repository contains the components HTML files and SCSS files. The project is used by ONAP-UI-ANGULAR and ONAP-UI-REACT that implements components according to the HTML in this project.

Installation

npm install onap-ui-common

Usage

You can use the scss files (for styling) and icons-map.js file (for using icons). To use the icons just import the iconsMap

import { iconsMap } from 'onap-ui-common';

To use the SCSS files you need to reference them from your local SCSS file and compile them.

@import '../../../node_modules/onap-ui-common/styles/style.scss';

HTML files are included for reference of how the react and angular projects should output the DOM SVG files are also included - allowing the react SVGIcon component, and consumption via CSS if needed

Having some trouble? Have an issue?

For bugs and issues, please use the issues page

How to Contribute

Contribution can be made only by following these guide lines

Every change in the basic HTML files structure, must be followed by changes on the frameworks projects (ONAP-UI-ANGULAR and ONAP-UI-REACT).
There will be no 3rd party UI framework imported (i.e. Bootstrap, Material, Foundation... etc.).
Contribution are done only by the contribution guide. Contributions submitted not in this format and guidelines will not be considered.