# @talloinc/celula

> Tallo Inc.'s React component library and ui documentation

Latest version **0.8.6** (published 2021-12-13) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @talloinc/celula
pnpm add @talloinc/celula
yarn add @talloinc/celula
bun add @talloinc/celula
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.6 |
| Published | 2021-12-13 |
| First published | 2020-09-03 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 16.x |
| Dependencies | 7 |
| Unpacked size | 3.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ian Greulich |
| Maintainers | igreulich, splayer_tallo |
| Keywords | celula, react, ui-kit, styleguide, user-interface, components, style, documentation |

## Links

- npm: https://www.npmjs.com/package/@talloinc/celula
- Repository: https://github.com/STEMPremier/tallo-ui-kit
- Homepage: https://github.com/STEMPremier/tallo-ui-kit#readme
- Issues: https://github.com/STEMPremier/tallo-ui-kit/issues
- npm.io page: https://npm.io/package/@talloinc/celula

## Dependencies (7)

- [@nivo/bar](https://npm.io/package/@nivo/bar.md) ^0.73.1
- [@nivo/pie](https://npm.io/package/@nivo/pie.md) ^0.73.0
- [@nivo/core](https://npm.io/package/@nivo/core.md) ^0.73.0
- [@nivo/line](https://npm.io/package/@nivo/line.md) ^0.73.0
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [react-modal](https://npm.io/package/react-modal.md) ^3.12.1
- [react-table](https://npm.io/package/react-table.md) ^7.5.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.8.6 (latest) — 2021-12-13
- 0.8.7-dev.8 (dev) — 2022-02-04
- 0.8.7-dev.7 — 2022-02-01
- 0.8.7-dev.6 — 2022-01-13
- 0.8.7-dev.5 — 2022-01-12
- 0.8.7-dev.4 — 2021-12-16
- 0.8.7-dev.3 — 2021-12-16
- 0.8.7-dev.2 — 2021-12-16
- 0.8.7-dev.1 — 2021-12-16
- 0.8.5 — 2021-12-08
- 0.8.4 — 2021-12-06
- 0.8.3 — 2021-11-16
- 0.8.2 — 2021-11-10
- 0.8.1 — 2021-11-08
- 0.8.0 — 2021-11-04
- … 52 more at https://npm.io/package/@talloinc/celula/versions

## README

---
permalink: /index.html
---
# Celula

## Scripts
To aid in the development, deployment, and maintenance of Celula, there are several tasks/scripts available to you via the command line; `yarn run [task]`

### build
The `build` task produces a build that is the same as what is deployed to npm. Ultimately this task runs the [prettier](https://prettier.io/), and [eslint](https://eslint.org/) fixes, then builds the component library. It runs the `clean`, `prebuild`, and `build:components` tasks, in that order. 

### build:components
The `build:components` task builds the component library.

### build:icons
The `build:icons` task uses [svg-sprite-generate](https://www.npmjs.com/package/svg-sprite-generator) to build the icon sprite used by the various icon components.

### build:styleguide
The `build:styleguide` task builds the styleguide documentation site ([Storybook](https://storybook.js.org/)).

### check
The `check` task runs the [eslint](https://eslint.org/) and [prettier](https://prettier.io/) checks. It does not fix any of the errors/warnings.

### clean
The `clean` task uses `rimraf` to delete the `docs` and the `dist` directories.

### coverage
The `coverage` taske runs the test suite and generates a coverage report.

### generate
The `generate` task uses `plop` to generate the boilerplate for a new React component.

### lint:check
The `lint:check` task runs the [eslint](https://eslint.org/) checks. It does not fix any of the errors/warnings.

### lint:fix
The `lint:fix` task fixes any [eslint](https://eslint.org/) errors/warnings possible.

### optimize:icons
The `optimize:icons` task runs the [svgOptimize](https://github.com/STEMPremier/celula/blob/master/src/utils/svgOptimize.js) script. That script optimizes and normalizes all the [icons](https://github.com/STEMPremier/celula/tree/master/src/components/icon/icons), using [svgo](https://github.com/svg/svgo). This task should always be run before the `build:icons` task.

### prebuild
The `prebuild` task runs the [prettier](https://prettier.io/) and [eslint](https://eslint.org/) fix tasks.

### pretty:check
The `pretty:check` task runs the [prettier](https://prettier.io/) checks.  It does not fix any of the errors/warnings.

### pretty:fix
The `pretty:fix` task fixes any [prettier](https://prettier.io/) erros/warnings possible.

### start
The `start` task runs the documentation site ([Storybook](https://storybook.js.org/)) for devlopment.

### test
The `test` task runs the [jest](https://jestjs.io/docs/en/getting-started) tests.

### test:debug
The `test:debug` task runs the [jest](https://jestjs.io/docs/en/getting-started)  tests in debug mode. This is helpful if you need to see into other libs your tests might be 'using', such as a component from Semantic UI your component composes.

Once the test is complete, you will need to vist [chrome://inspect](chrome://inspect) in Google Chrome. You should see something that looks like this:

TODO: Add screenshot

Under 'Remote Target' click the `inspect` link to be taken to the debugger.

### test:watch
The `test:watch` task runs the [jest](https://jestjs.io/docs/en/getting-started) tests, in [watch](https://jestjs.io/docs/en/cli#--watch) mode.

Once running, you have several options:
- Press a to run all tests.
- Press f to run only failed tests.
- Press p to filter by a filename regex pattern.
- Press t to filter by a test name regex pattern.
- Press q to quit watch mode.
- Press Enter to trigger a test run.

And if the [snapshots](https://jestjs.io/docs/en/snapshot-testing) are out of date:

- Press u to update the snapshots.

---
_Source: https://npm.io/package/@talloinc/celula · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._