README

React-Vapor

Coveo Administration Console's design system.

Have a look at react-vapor's demo page!

Getting started

Prerequisites

This repository uses some external libraries defined as peer dependencies. You must install those libraries in you own project in order for react-vapor to work properly. All peer dependencies are listed in the package.json file along with their respective version requirements.

Install

npm install react-vapor

If you want to use react-vapor in a TypeScript context, the package already includes its types.

Usage

In a .jsx context:

const React = require('react');
const ReactDom = require('react-dom');
const Badge = require('react-vapor').Badge;

ReactDom.render(<Badge label="Hello react-vapor!" />, document.getElementById('SomewhereInYourApp'));

In a .tsx context:

import * as React from 'react';
import * as ReactDom from 'react-dom';
import {Badge} from 'react-vapor';

ReactDom.render(<Badge label="Hello react-vapor!" />, document.getElementById('SomewhereInYourApp'));

Contributing

See our main page.

License

react-vapor is distributed under Apache 2.0 license.

Usage no npm install needed!