Package Exports

@coveord/plasma-react
@coveord/plasma-react/dist/cjs/Entry.js
@coveord/plasma-react/dist/esm/Entry.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@coveord/plasma-react) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Plasma React

Coveo Administration Console's design system.

Have a look at the 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 @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.