# minima-ui

> A library of reusable React UI components built with TypeScript and styled-components

Latest version **0.3.0** (published 2021-05-12) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2021-05-12 |
| First published | 2021-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 76.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alexey Suetin |
| Maintainers | asuetin |
| Keywords | react, typescript, styled-components, react-components, jest, storybook |

## Links

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

## 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.3.0 (latest) — 2021-05-12
- 0.2.0 — 2021-05-09
- 0.1.6 — 2021-05-06
- 0.1.5 — 2021-05-06
- 0.1.2 — 2021-05-05
- 0.1.1 — 2021-05-04
- 0.1.0 — 2021-05-04

## README

# Minima UI

This is a library of reusable React UI components created with simplicity, customization and accessibility in mind.

The library is written in TypeScript. It utilizes styled-components for styling and Jest for testing.

## Components

The library includes the following components:

#### Containers
1. [Table](https://asuetin.github.io/minima-ui/?path=/docs/components-containers-table--basic) - a virtualized table with sorting and column resizing that allows custom cell renderers;
2. [Tooltip](https://asuetin.github.io/minima-ui/?path=/docs/components-containers-tooltip--basic) - a wrapper around an element that shows a tooltip on hover;
3. [Modal](https://asuetin.github.io/minima-ui/?path=/docs/components-containers-modal--basic) - a modal dialog.
#### Inputs
1. [Button](https://asuetin.github.io/minima-ui/?path=/docs/components-inputs-button--basic) - a basic button;
2. [CheckBox](https://asuetin.github.io/minima-ui/?path=/docs/components-inputs-checkbox--basic) - a basic checkbox;
3. [Switch](https://asuetin.github.io/minima-ui/?path=/docs/components-inputs-switch--basic) - a button that allows the user to switch between "on" and "off" states;
4. [TextInput](https://asuetin.github.io/minima-ui/?path=/docs/components-inputs-textinput--basic) - a text input component that support single- and multi-line modes;
5. [ComboBox](https://asuetin.github.io/minima-ui/?path=/docs/components-inputs-combobox--basic) - a control allowing the user to search and select among a list of options;
6. [RadioGroup](https://asuetin.github.io/minima-ui/?path=/docs/components-inputs-radiogroup--basic) - a control allowing the user select an option among a list of radio buttons;
7. [Slider](https://asuetin.github.io/minima-ui/?path=/docs/components-inputs-slider--basic) - a slider with multi-thumb support.

#### Display
1. [Icon](https://asuetin.github.io/minima-ui/?path=/docs/components-display-icon--basic) - an SVG icon component that is easily scalable and includes a few preset icons;
2. [ProgressBar](https://asuetin.github.io/minima-ui/?path=/docs/components-display-progressbar--basic) - a basic progress bar.

#### Utility
1. [List](https://asuetin.github.io/minima-ui/?path=/docs/components-utility-list--basic) - a basic virtualized list/

## Installation and usage

To install minima-ui, use the following command:

	npm i minima-ui

To use the library in your app, import one or more of the included components:
```tsx
import {useState} from 'react';

import {ComboBox} from 'minima-ui';

const App = (): JSX.Element => {
  const [value, setValue] = useState(0);

  return <div>
    <ComboBox
      options={Array.from({length: 1000}, (v, i) => ({
        value: i,
        label: `Option ${i+1}`
      }))}
      value={value}
      onChange={setValue}
    />
  </div>;
};

export default App;
```

## Documentation

The library uses Storybook for documentation.

The GitHub Page with the Storybook is available [here.](https://asuetin.github.io/minima-ui/?path=/docs/introduction--page)

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