# insiteful-ui

> This is component library exposes some styled components for you to utilize in your projects.

Latest version **0.1.0** (published 2022-11-17) · 0 weekly downloads

## Install

```sh
npm install insiteful-ui
pnpm add insiteful-ui
yarn add insiteful-ui
bun add insiteful-ui
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2022-11-17 |
| First published | 2022-08-31 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 347.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lauren Wright |
| Maintainers | ericbf, itslwright, pdreed, alexholt757, tmmccroan |

## Links

- npm: https://www.npmjs.com/package/insiteful-ui
- Repository: https://github.com/laurenmwright/insiteful-ui
- Homepage: https://github.com/laurenmwright/insiteful-ui#readme
- Issues: https://github.com/laurenmwright/insiteful-ui/issues
- npm.io page: https://npm.io/package/insiteful-ui

## Dependencies (6)

- [prop-types](https://npm.io/package/prop-types.md) ^15.8.1
- [react-table](https://npm.io/package/react-table.md) ^7.8.0
- [react-feather](https://npm.io/package/react-feather.md) ^2.0.10
- [tailwind-merge](https://npm.io/package/tailwind-merge.md) ^1.8.0
- [@headlessui/react](https://npm.io/package/@headlessui/react.md) ^1.7.4
- [regenerator-runtime](https://npm.io/package/regenerator-runtime.md) ^0.13.10

## Recent versions

- 0.1.0 (latest) — 2022-11-17
- 0.0.48 — 2022-11-11
- 0.0.47 — 2022-11-02
- 0.0.46 — 2022-11-02
- 0.0.45 — 2022-10-19
- 0.0.44 — 2022-10-19
- 0.0.43 — 2022-10-19
- 0.0.42 — 2022-10-19
- 0.0.41 — 2022-10-17
- 0.0.40 — 2022-10-12
- 0.0.39 — 2022-10-12
- 0.0.38 — 2022-10-07
- 0.0.37 — 2022-10-07
- 0.0.36 — 2022-10-07
- 0.0.34 — 2022-09-20
- … 31 more at https://npm.io/package/insiteful-ui/versions

## README

# Insiteful UI Component Library

This is component library exposes some styled components for you to utilize in your projects.

## Theming

Colors on elements are added through css variables, and components are styled with Tailwindcss.

You can override the variables to adjust the theme:

```
--color-primary // Defaults to #46A689
--color-secondary // Defaults to #E0C591
--color-gray-lightest // Defaults to #d6d3d1
--color-gray-lighter // Defaults to #959595
--color-gray-light // Defaults to #78716c
--color-gray-medium // Defaults to #666
--color-gray-dark // Defaults to #333
--color-gray-darker // Defaults to #292524
--color-gray-darkest // Defaults to #1c1917
--color-action-blue // Defaults to #2F77EE
--color-success-light // Defaults to #86CCA4
--color-success-dark // Defaults to #0E4325
--color-error-light // Defaults to #fca5a5
--color-error-medium // Defaults to #dc2626
--color-error-dark // Defaults to #7f1d1d
--color-editor-dark-purple // Defaults to #4945FF
--color-editor-medium-purple // Defaults to #928fff
--color-editor-light-purple // Defaults to #dbdaff

--common-font // Defaults to `'Courier New', Courier, monospace`
```

## Contributing

You can contribute to this project. Fork it, make your changes, and put up a PR.

### Environment set up

Install dependencies with npm:

```
npm i
```

### Running

You can spin up a local server to test components with storybook:

```bash
npm run storybook
```

Runs the storybook in the development mode.\
Open [http://localhost:6006]

You can also run the local react app:

```bash
npm start
```

Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

### Publishing changes

Follow these steps to publish:

1. Update version number in `package.json`.
1. Run `npm i` to propagate that version number.
1. Run `npm run build`
1. Change directory into the dist directory: `cd dist`.
1. Run publish: `npm publish`.

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