| commit | b2a3acea0d0f66028c9ce5fad02d4ecc64abf70c | [log] [tgz] |
|---|---|---|
| author | Israel Lavi <il0695@att.com> | Tue Aug 07 10:54:17 2018 +0300 |
| committer | Israel Lavi <il0695@att.com> | Tue Aug 07 11:06:44 2018 +0300 |
| tree | 8d70110f34cb845965c42a5915e950bca967d2c3 | |
| parent | 05b37297177e8a342668c15e5d6f738b51f7aedd [diff] |
Initial commit. Adding files needed for Linux Foundation. Change-Id: I9f2b4851a5ae01f83800c7f8bab8608a2221c730 Issue-ID: SDC-1608 Signed-off-by: Israel Lavi <il0695@att.com>
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 definition of all the basic widgets and reusable controllers.
Note: the project is build of 3 different projects:
To start using this library you need to install 2 libraris:
npm install --save-dev onap-ui-angular npm install --save-dev onap-ui-common
The main CSS file is defined in onap-ui-common library. There are several options to link it to your project:
You can add this line to src/style.css file:
@import "node_modules/onap-ui-common/lib/style.css";
Angular CLI project has angular.json file, that defines location of styles files. By default angular.json contains the following definition:
"styles": [ "src/styles.css" ],
So you can add to src/styles.css import of onap-ui-common styles.
<link rel="stylesheet" href="node_modules/onap-ui-common/lib/style.css">
import 'onap-ui-common/lib/style.css';
onap-ui-common also contains to SCSS files: variables.scss mixins.scss
You can import these files to your project and get the same color scheme and variables line onap-ui-common.
import { SdcUiComponentsModule, SdcUiComponents } from 'onap-ui-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, FormsModule, HttpModule, SdcUiComponentsModule ], providers: [ SdcUiComponents.ModalService ], bootstrap: [AppComponent] }) export class AppModule { }
The components in this library are displayed via storybook. Head to http://onap-sdc.github.io/onap-ui-angular to see the components that are in master.
While developing, just run npm run storybook in your terminal to launch a local storybook server where you can see your changes. For deploying storybook to your own fork repository, refer to the guides section below.
Deploying storybook to a fork's github pages
For bugs and issues, please use the issues page
Contribution can be made only by following these guide lines
React & Angular framework libraries. Hence, every change in the basic HTML files structure, must be followed by changes on react and angular projects (onap-ui-angular, onap-ui-react).Bootstrap, Material, Foundation... etc.).