# alomni-ui

> A simple react component library

Latest version **1.2.0** (published 2022-10-24) · ISC license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2022-10-24 |
| First published | 2022-07-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 270.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | matheoht |
| Maintainers | matheoht |

## Links

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

## Recent versions

- 1.2.0 (latest) — 2022-10-24
- 1.1.1 — 2022-09-26
- 1.1.0 — 2022-09-26
- 1.0.1 — 2022-09-06
- 1.0.0 — 2022-07-04

## README

# Alomni-UI

A simple react component library

## Table of Contents

- [Alomni-UI](#alomni-ui)
  - [Table of Contents](#table-of-contents)
  - [Installation](#installation)
  - [Usage](#usage)
  - [Documentation](#documentation)

## Installation

To install Alomni-UI you can use [npm](https://npmjs.org/) or [yarn](https://yarnpkg.com) :

```
$ npm i alomni-ui
$ yarn add alomni-ui
```

## Usage

Import Alomni-UI style manually in `index.js`:

```js
import "alomni-ui/dist/alomni-ui.css";
```

Example of Alomni-UI usage:

```jsx
import { useState } from "react";
import { Button, Text } from "alomni-ui";

function App() {
  const [counter, setCounter] = useState(0);

  return (
    <div style={{ margin: "50px" }}>
      <Button width="full" onClick={() => {setCounter(counter + 1);}}>Click me !</Button>
      <Text size="l" color="blue" style={{ textAlign: "center" }}>{counter}</Text>
    </div>
  );
}
```

## Documentation

Alomni-UI use [Storybook](https://storybook.js.org/) as the main documentation, which describes the library and gives examples of its usage.

To run the Storybook you have to clone the github repository of [Alomni-UI](https://github.com/matheoht/alomni-ui) and execute the command `npm run storybook`.

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