@senseyeinc/senseye-frontend-library

a collection of reusable components that can be assembled together to build any number of applications

Usage no npm install needed!

<script type="module">
  import senseyeincSenseyeFrontendLibrary from 'https://cdn.skypack.dev/@senseyeinc/senseye-frontend-library';
</script>

README

Contains a collection of reusable ReactJS components that can be assembled together to build any number of applications

Install

npm i --save @senseyeinc/senseye-frontend-library

Usage

In your ReactJS app, import the component you want to use then render the component in your return statement

// Import example
import {Calibration} from '@senseyeinc/senseye-frontend-library'

// Render example
<Calibration />

Additional examples available below and inside Storybook

Example

import React from 'react'
import {Nystagmus} from '@senseyeinc/senseye-frontend-library'

function App() {
    return <Nystagmus />
}

export default App

Previewing UI Components

Navigate to Storybook to see a list of all components included in this library and to preview how they function.

Storybook locally:

In the project directory, you can start the Storybook server by running:

yarn storybook

This will launch Storybook which allows you to preview UI components and additional documentation before using them in your applications.

You can view Storybook locally at http://localhost:9009 by default.

Storybook on the web:

Alternatively, Senseye's UI components are available to preview at storybook.senseye.co

For more detailed instructions on how to use Storybook please refer to their docs here

Future plans

  • We'd like to extend support to Angular and Vue.js users

License

  • BSD-3-Clause

    • Note: This license has also been called the "New BSD License" or "Modified BSD License".

  • 3rd Party Attributions

    • A full list of 3rd party software and respective licenses can be found here