1.2.0 • Published 2 years ago
alomni-ui v1.2.0
Alomni-UI
A simple react component library
Table of Contents
Installation
To install Alomni-UI you can use npm or yarn :
$ npm i alomni-ui
$ yarn add alomni-ui
Usage
Import Alomni-UI style manually in index.js
:
import "alomni-ui/dist/alomni-ui.css";
Example of Alomni-UI usage:
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 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 and execute the command npm run storybook
.