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.
There are several options to link to sdc-ui CSS file:
@import "path_to_node_modules/sdc-ui/css/style.css";
<link rel="stylesheet" href="https://github.com/onap-sdc/sdc-ui/blob/master/path_to_node_modules/sdc-ui/css/style.css">
import 'sdc-ui/css/style.css';
You can add this line to style.css file:
@import "../node_modules/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>
);
}
import { SdcUiComponentsModule, SdcUiComponents } from 'sdc-ui/lib/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/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.
To see angular components in design run: npm run lab
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 the frameworks files accordingly (under src/react
and src/angular
).Bootstrap
, Material
, Foundation
... etc.).