# @turnkeyvr/common-ui

> Shared components, styles and themes for TurnKey front-end applications

Latest version **2.47.0** (published 2021-03-31) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install @turnkeyvr/common-ui
pnpm add @turnkeyvr/common-ui
yarn add @turnkeyvr/common-ui
bun add @turnkeyvr/common-ui
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.47.0 |
| Published | 2021-03-31 |
| First published | 2019-03-26 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8 |
| Dependencies | 13 |
| Unpacked size | 5.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | TurnKey Dev |
| Maintainers | cchapman89, nate.exe, jsatterfield, akemi_tk, eric.carr, dsquires, arc6789, rhoyer, bretwarren, aidanp, c27cochran, beardles, hnbowen, tkvr-integration, ajewe |

## Links

- npm: https://www.npmjs.com/package/@turnkeyvr/common-ui
- Repository: https://github.com/TurnKeyVR/common-ui
- Homepage: https://github.com/TurnKeyVR/common-ui#readme
- Issues: https://github.com/TurnKeyVR/common-ui/issues
- npm.io page: https://npm.io/package/@turnkeyvr/common-ui

## Dependencies (13)

- [@xdn/cli](https://npm.io/package/@xdn/cli.md) ^1.37.0
- [date-fns](https://npm.io/package/date-fns.md) ^2.12.0
- [@xdn/core](https://npm.io/package/@xdn/core.md) ^1.37.0
- [@xdn/prefetch](https://npm.io/package/@xdn/prefetch.md) ^1.37.0
- [react-truncate](https://npm.io/package/react-truncate.md) ^2.4.0
- [react-stickynode](https://npm.io/package/react-stickynode.md) ^2.1.1
- [react-autosuggest](https://npm.io/package/react-autosuggest.md) ^10.0.2
- [@turnkeyvr/common-lib](https://npm.io/package/@turnkeyvr/common-lib.md) ^2.12.6
- [@turnkeyvr/common-types](https://npm.io/package/@turnkeyvr/common-types.md) ^2.16.8
- [@turnkeyvr/common-utils](https://npm.io/package/@turnkeyvr/common-utils.md) ^1.3.12
- [@types/react-stickynode](https://npm.io/package/@types/react-stickynode.md) ^2.1.0
- [material-ui-popup-state](https://npm.io/package/material-ui-popup-state.md) ^1.5.4
- [@turnkeyvr/react-day-picker](https://npm.io/package/@turnkeyvr/react-day-picker.md) ^7.2.8

## Recent versions

- 2.47.0 (latest) — 2021-03-31
- 2.41.5-canary.50c0886 (canary) — 2020-12-17
- 2.46.0 — 2021-03-30
- 2.45.0 — 2021-02-19
- 2.44.7 — 2021-01-27
- 2.44.6 — 2021-01-27
- 2.44.5 — 2021-01-27
- 2.44.4 — 2021-01-26
- 2.44.3 — 2021-01-26
- 2.44.1 — 2021-01-26
- 2.44.0 — 2021-01-26
- 2.43.0 — 2021-01-14
- 2.42.1 — 2021-01-11
- 2.42.0 — 2021-01-07
- 2.41.5 — 2020-12-17
- … 183 more at https://npm.io/package/@turnkeyvr/common-ui/versions

## README

# common-ui

[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg)](http://storybook.tkvrdev.com)

Shared components, styles and themes for TurnKey front-end applications

### Installation

`npm install -S @turnkeyvr/common-ui`

To upgrade, run `npm install -S @turnkeyvr/common-ui@latest`

This library should house all common components, styles and themes that can be shared between TurnKey applications.

### Using the library

This library should be used to import the Material UI theme and pass it to the appropriate theme provider for your application.

Import components directly from the `@turnkeyvr/common-ui` package:

- `import { TextInput } from '@turnkeyvr/common-ui`

For more details, check out the [Design System Storybook](http://storybook.tkvrdev.com).

## Development

### Standards

The standards below are ever-evolving as we work on this application. If you have any thoughts or ideas on these standards please bring them up with the other developers.

**This library is _all about collaboration_ so it is important that we all agree on what these standards are!**

The common library is build on the following technologies:

- [Create React Library](https://github.com/transitive-bullshit/create-react-library): Structure generated by create-react-library
- [React](https://reactjs.org/): All components are react components
- [Material UI](https://material-ui.com/): CSS/Design framework that we are expecting the consumer to use
- [Typescript](http://www.typescriptlang.org/): This library will use Typescript with basic standards/configuration to enforce consistency across collaborative development.
- [Storybook](https://storybook.js.org/): Used for component development in isolation. Allows us to work with design to create a common language when developing applications.
- [Rollup](https://rollupjs.org/): Rollup is used to create the distribution files that will be published to npm.

We expect the following basic standards for developing in this library:

- [Trunk based development](https://trunkbaseddevelopment.com/) conventions are closely followed
- All non-trivial changes to main go through peer review
- There must be consensus between design/development before publishing a component to the library

### Running the library

To develop the library, we will use a local instance of storybook. All you have to do is simply run `npm run storybook` and, after the application is build, you will have a local instance of storybook running at `localhost:6006`.

### Deploying the library

Please see the wiki [section on deployment](https://github.com/TurnKeyVR/common-ui/wiki/Deployment) for detailed steps on how to deploy a new version of the library to npm.

Test

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