Oui! Version 2
UI components for building smart health applications
Installation
npm i -S @oberd/oui
Usage
Distribution files are compatible both in node and browser context.
import React, { Component, PropTypes } from 'react';
import { Button } from '@oberd/oui';
class MyComponent extends Component {
static propTypes = {
};
render() {
return (
<div>
<Button inline>Click Me</Button>
</div>
);
}
}
export default MyComponent;
Overview
Oui has the goal of standardizing user interface components for all Oberd Platform Applications.
Components should have these goals in mind:
- Accessibile
- Well tested
- Keyboard Enabled
- Progressively enhanced (with a baseline assumption of Javascript)
- Browser support: IE8+
Getting Started
./tools/init.sh
Contribution
More information on creating your own component can be found in the Contribution Guide
Development Commands
-
gulp serve
- Start a server for mocha tests and documentation. Use this command for active development -
gulp build
- Compiles dist folder from source -
gulp test
- Runs mocha tests in phantomjs
Directory Structure
|-- assets # Any static assets for use in the compilation / build step |-- dist # Compiled files for use with browser globals, compiled CSS |-- docs | `-- src # Example source code. |-- src # Component source, one component per folder please. |-- test # Specifications and test files `-- tools # Random utilities and build tools