# nessus-ui

> A React component UI library

Latest version **1.1.9** (published 2020-09-09) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.9 |
| Published | 2020-09-09 |
| First published | 2020-09-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 68.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | marcosbarbosa031 |
| Keywords | react, javascript, typescript |

## Links

- npm: https://www.npmjs.com/package/nessus-ui
- npm.io page: https://npm.io/package/nessus-ui

## Dependencies (11)

- [react](https://npm.io/package/react.md) ^16.13.1
- [@mdi/js](https://npm.io/package/@mdi/js.md) ^5.3.45
- [react-dom](https://npm.io/package/react-dom.md) ^16.13.1
- [@mdi/react](https://npm.io/package/@mdi/react.md) ^1.4.0
- [react-imask](https://npm.io/package/react-imask.md) 5.2.1
- [react-helmet](https://npm.io/package/react-helmet.md) ^6.1.0
- [react-lottie](https://npm.io/package/react-lottie.md) ^1.2.3
- [react-hook-form](https://npm.io/package/react-hook-form.md) ^6.0.8
- [@material-ui/lab](https://npm.io/package/@material-ui/lab.md) ^4.0.0-alpha.55
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.10.1
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.9.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

- 1.1.9 (latest) — 2020-09-09
- 1.1.8 — 2020-09-09
- 1.1.7 — 2020-09-09
- 1.1.6 — 2020-09-08
- 1.1.5 — 2020-09-08
- 1.1.4 — 2020-09-08
- 1.1.3 — 2020-09-08
- 1.1.2 — 2020-09-07
- 1.1.1 — 2020-09-07
- 1.1.0 — 2020-09-07
- 1.0.2 — 2020-09-07
- 1.0.1 — 2020-09-07
- 1.0.0 — 2020-09-07

## README

# 🪐 Nessus UI

A React UI library with easy and ready to use components!

# Button

<hr>

A component for triggering a user action. e.g: a submit button in a form

##### Import

```js
import { Button } from 'nessus-ui';
```

##### Usage

```jsx
<Button
  buttonType="contained"
  text="Send"
  loading={loading}
  loadingAnimation={loadingAnimation}
  onClick={() => 'Do something'}
/>
```

<div>
  <img src="https://i.imgur.com/lWjBZiv.png" width="auto" height="100%">
</div>

##### Required props

| Name   | Type     | Description                       |
| ------ | -------- | --------------------------------- |
| `text` | `string` | Text that will show inside button |

##### Optional props

| Name               | Type       | Description                                                                           |
| ------------------ | ---------- | ------------------------------------------------------------------------------------- |
| `onClick`          | `function` |                                                                                       |
| `buttonType`       | `string`   | A type that determines the style of the button. ('contained', 'outlined', 'disabled') |
| `type`             | `string`   | Determines the type of button input. ('button', 'submit','reset')                     |
| `buttonWidth`      | `string`   | Determines a specific width to the button.                                            |
| `disabled`         | `boolean`  | Determines whether the button is disabled or not.                                     |
| `testID`           | `string`   | Specify the data-testid of the button.                                                |
| `loading`          | `boolean`  | Specify whether to show the loading or not.                                           |
| `loadingAnimation` | `any`      | The element to show when 'loading' is true.                                           |

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