@incognia/orion

Orion

Incognia's component library, based on React Semantic UI.

You can see and interact with the components here.

Usage

1. Install via NPM or Yarn:

  npm install --save @incognia/orion
  #or
  yarn add @incognia/orion

2. Add Material Icons Font to your HTML:

<link
  href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined"
  rel="stylesheet"
/>

3. Import Orion's CSS on your react app:

import '@incognia/orion/dist/orion.css'

4. Import and use Orion's components as needed:

import { Dropdown } from '@incognia/orion'

Testing

Apps using Orion will have failing Jest tests due to canvas usage, which is not supported by default. To fix this, just include the jest-canvas-mock dev dependency and follow its setup instructions.

Contributing

Watch (Hot reloading)

To start the project:

yarn start

Release

To release, follow these steps:

1. Run yarn publish
2. Select the version you wish to publish.
3. You're done!