README
Plasma React
Coveo Administration Console's design system.
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 @coveord/plasma-react
to work properly. All peer dependencies are listed in the package.json file along with their respective version requirements.
Install
npm install @coveord/plasma-react
If you want to use @coveord/plasma-react
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('@coveord/plasma-react').Badge;
ReactDom.render(<Badge label="Hello Plasma!" />, document.getElementById('SomewhereInYourApp'));
In a .tsx
context:
import * as React from 'react';
import * as ReactDom from 'react-dom';
import {Badge} from '@coveord/plasma-react';
ReactDom.render(<Badge label="Hello Plasma!" />, document.getElementById('SomewhereInYourApp'));
Contributing
See our main page.
License
@coveord/plasma-react
is distributed under Apache 2.0 license.