Giter VIP home page Giter VIP logo

onap-ui-react's Introduction

ONAP-UI React Components

This project aims to create a unified UI of styled components for multiple development teams who work on the same web-based applications. This repository contains the definitions of all the basic components implemented in React.

In order to use the accompanying styles, you must install onap-ui-common!

Usage

React Code examples

Importing a component
import { Button } from 'onap-ui-react';

// inside component rendering...
render() {
	return (
		<Button>I am a Button</Button>
	);
}
Importing the entire library
import OnapUI from 'onap-ui-react';

// inside component rendering...
render(){
	return (
		<OnapUI.Button>I am still a Button</OnapUI.Button>
	);
}

Running storybook

The components in this library are displayed via storybook. Head to http://onap-sdc.github.io/onap-ui-react 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.

Useful guides

Adding a new component

Deploying storybook to a fork's github pages

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

  • 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 (under src/react and src/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.

onap-ui-react's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.