@zooniverse/react-components
v1.15.0
Published
Zooniverse React Components
Keywords
Readme
Zooniverse React Components
Common React components used throughout the Zooniverse.
Getting Started
Install the package from NPM:
npm i @zooniverse/react-componentsand use it
ES5
var { ZooFooter } = require('@zooniverse/react-components');ES6
import { ZooFooter } from '@zooniverse/react-components';Run
yarn start to run the storybook locally on (https://localhost:6007).
Tests
yarn test to run Vitest tests.
yarn test ProjectCard.spec.jsx to test one file at a time.
Contributing
Components should be added to the src/components folder and an export to src/index.js. Each component should be tested, documented readme, and have a storybook example added.
Technologies and tools we use
All of our components are written using React, built on top of Grommet, a component UI library, and styled by our custom Grommet style theme (@zooniverse/grommet-theme) and styled-components.
- Grommet - React UI component library
- React.js - Component, virtual DOM based javascript library
- styled-components - CSS in JS for styling and theming
- react-i18next - Internationalization framework for React.
Testing is done by
