ukelli-ui/README.md

Base on React's UI lib. Make frontend's dev simpler and faster.

# ukelli-ui

Base on React's UI lib. Make frontend's dev simpler and faster.

[![Build Status](https://travis-ci.org/ukelli/ukelli-ui.svg?branch=master)](https://travis-ci.org/ukelli/ukelli-ui)
[![install size](https://packagephobia.now.sh/badge?p=ukelli-ui)](https://packagephobia.now.sh/result?p=ukelli-ui)

## Support

- Client side render React App
- Server side render React App (like Gatsby, Next)

## Project

- [uke-dashboard](https://github.com/ukelli/uke-dashboard)
- [uke-admin-web-scaffold](https://github.com/ukelli/uke-admin-web-scaffold)
- [gatsby-theme-elk](https://github.com/SANGET/gatsby-theme-elk)

## Getting started

```shell
yarn add ukelli-ui basic-helper unistore
```

### Example

[`react-app-seed`](https://github.com/SANGET/react-app-seed.git)

```shell
git clone https://github.com/SANGET/react-app-seed.git
cd react-app-seed
yarn; yarn start
```

### Use in project

```js
import React from 'react';
import ReactDOM from 'react-dom';
import { ShowModal, CloseModal } from 'ukelli-ui/core/modal';
import { Button } from 'ukelli-ui/core/button';

const handleClick = (e) => {
  const ModalID = ShowModal({
    title: 'Overlay',
    elem: e,
    children: (
      <div>Content</div>
    )
  })

  // CloseModal(ModalID)
}

const App = () => (
  <Button onClick={handleClick}>
    Overlay
  </Button>
)

ReactDOM.render(<App />, document.querySelector('#Main'));
```

## Local dev

```shell
git clone https://github.com/ukelli/ukelli-ui
cd ukelli-ui
yarn
yarn docz:dev
```

## Reference

- [Online Doc](https://ui.ukelli.com/)
- [FormGenerator](https://ui.ukelli.com/#/G-Desc)
- [CHANGELOG](./docs/CHANGELOG.md)
- [UI logic of FormGenerator](./docs/ui-logic.md)
- [Import](./docs/import-desc.md)
- [Configure](./docs/configuration.md)
- [Components Desc](./docs/components.md)