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.
@import "path_to_node_modules/sdc-ui/css/style.css";
<link rel="stylesheet" href="path_to_node_modules/sdc-ui/css/style.css">
As Module (Using loading tool, i.e. Webpack)
import 'sdc-ui/css/style.css';
import Button from 'sdc-ui/lib/react/Button.js';
// inside component rendering...
render(){
return (
<Button>I am a Button</Button>
);
}
import {Button} from 'sdc-ui/lib/react';
// inside component rendering...
render(){
return (
<Button>I am a Button</Button>
);
}
import SDCUI from 'sdc-ui';
// inside component rendering...
render(){
return (
<SDCUI.React.Button>I am still a Button</SDCUI.React.Button>
);
}
The components in this library are displayed via storybook. Head to http://onap-sdc.github.io/sdc-ui 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
- This project combines both
React
&Angular
framework libraries. Hence, every change in the basic HTML files structure, must be followed by changes on the frameworks files accordingly (undersrc/react
andsrc/angular
). - There will be no any 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.