# @mobly/ui-react

> Mobly UI component library for react

Latest version **1.1.2** (published 2020-08-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install @mobly/ui-react
pnpm add @mobly/ui-react
yarn add @mobly/ui-react
bun add @mobly/ui-react
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2020-08-03 |
| First published | 2020-07-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 355.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andry Charlier |
| Maintainers | andrych, mobly-dev |
| Keywords | Mobly, React, components, Storybook |

## Links

- npm: https://www.npmjs.com/package/@mobly/ui-react
- Repository: https://github.com/mobly-nv/mobly-ui
- Homepage: https://github.com/mobly-nv/mobly-ui#readme
- Issues: https://github.com/mobly-nv/mobly-ui/issues
- npm.io page: https://npm.io/package/@mobly/ui-react

## Dependencies (9)

- [date-fns](https://npm.io/package/date-fns.md) ^2.14.0
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [react-select](https://npm.io/package/react-select.md) ^3.1.0
- [@mobly/ui-styles](https://npm.io/package/@mobly/ui-styles.md) ^1.0.1
- [text-mask-addons](https://npm.io/package/text-mask-addons.md) ^3.8.0
- [@types/react-select](https://npm.io/package/@types/react-select.md) ^3.0.14
- [react-device-detect](https://npm.io/package/react-device-detect.md) ^1.13.1
- [@mobly/react-text-mask](https://npm.io/package/@mobly/react-text-mask.md) ^5.5.0
- [@mobly/react-mobile-picker](https://npm.io/package/@mobly/react-mobile-picker.md) ^0.2.3

## 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

- 1.1.2 (latest) — 2020-08-03
- 1.1.1 — 2020-08-02
- 1.1.0 — 2020-08-02
- 1.0.0 — 2020-07-29
- 1.0.0-alpha.0 — 2020-07-27

## README

# @mobly/ui-react

Mobly UI react component library.

## Install

Install dependencies:

```shell
npm i @mobly/ui-react
```

## Usage

This package is built with React, TypeScript and Sass.

It also utilizes the styles from [`@mobly/ui-styles`](../mobly-ui-styles) as Sass modules.  
These styles are also exported to easily use in combination with css-in-js libraries.

```jsx
import React from 'react';
import { Button } from '@mobly/ui-react';

const App = () => {
	return <Button>Click me</Button>;
};
```

## API

* Box
* Button
* Checkbox
* Datepicker
* Icon
* Input
* Loader
* Modal
* Radio
* Select
* Switch

## Development

Builds are setup with webpack, check the [`webpack.config.js`](./webpack.config.js) for more info.  
We use [storybook](https://github.com/storybookjs/storybook) for developping our react components.

### NPM scripts

| Command         | Description                                                | Runs
| --------------- | ---------------------------------------------------------- | -----------
| start           | Start up storybook                                         | `start-storybook -p 6006 -s ../../storybook/static`
| build           | Build package contents and types                           | `webpack && npm run build:types`
| build:types     | Build types                                                | `tsc -p tsconfig.build.json`
| build:storybook | Build storybook styleguide                                 | `build-storybook`
| lint            | Lint all script and style files                             | `npm run lint:scripts && npm run lint:styles`
| lint:scripts    | Lint scripts (.js,.jsx,.ts,.tsx)                           | `eslint --cache --ext .js,.jsx,.ts,.tsx ./src`
| lint:styles     | Lint styles (.css,.scss)                                   | `stylelint ./src/**/*.scss --cache`
| prepublishOnly  | Runs before every `npm run publish` (!important for lerna) | `npm run lint && npm run build`

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