uiik/README.md

A UI interactions kit includes draggable, splittable, rotatable, selectable, etc.

![npm](https://img.shields.io/npm/v/uiik?style=plastic)
![NPM](https://img.shields.io/npm/l/uiik)

# Uiik
A UI interaction kit includes draggable, splittable, rotatable, selectable, etc.
> English | [中文](./README_ZH.md)

- [📑 Documentation](https://holyhigh2.github.io/uiik/)
- [⚡ Play on StackBlitz](https://stackblitz.com/edit/uiik)

## Features
- Draggable/Droppable/Splittable/rotatable/selectable/Resizable
- Customizable CSS interfaces like 'uii-draggable-handle', 'uii-splittable-handle'...
- Rich options
- SVG support

## Quick start
1. install
```sh
npm i uiik
```
2. import
```ts
import uiik from 'uiik'
//or
import {newSplittable} from 'uiik'
//or
import {Splittable} from 'uiik'
//or
import uiik from 'https://cdn.skypack.dev/uiik'
```
3. import module
```ts
import {newSplittable} from 'uiik/splittable'
//or
import {newSortable} from 'uiik/sortable'
```

## Development
1. use `test` to do jest 
2. use `build` to rollup uiik
3. use `doc` to gen tsdoc