Giter Club home page Giter Club logo

ovirt-ui-components's Introduction

oVirt UI Components

Build Status

Reusable components for UIs related to the oVirt project.

Usage

npm install ovirt-ui-components

import { MyComponent } from 'ovirt-ui-components'

ReactDOM.render(
  <MyComponent prop1={foo} prop2={bar} />,
  document.getElementById('my-root')
)

Development

To facilitate rapid development with instant feedback a showcase application for development is provided in the /showcase directory.

npm start will run a webpack-dev-server with live reloading of all components that serves this showcase application.

Build

To get production build run npm run build. This will produce the file ovirt-ui-components.js containing all oVirt UI Components. This file is a non-minified UMD module intended to be used in a target host application.

Host Applications

The goal of this repository is to aggregate a wide range of useful components from small "dumb" components to a large and complex dialog-style components. Due to this there are several restrictions on the context in which these components can be used.

TODO: document host app requirements

Samples

The samples directory contains various sample host applications created using create-react-app.

To run a specific sample host app just run

cd dummy-host   # or other sample
npm install
npm start

Please note that if you change some components and want to see this change reflected in a sample host application you will need to re-run the production build npm run build in the root project and then

npm rm ovirt-ui-components
npm install ../..

inside the given sample host directory.

ovirt-ui-components's People

Contributors

mareklibra avatar matobet avatar

Watchers

 avatar  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.