https://github.com/holyhigh2/uiik

A UI Interactions kit includes draggable, splittable, rotatable, selectable, etc.
https://github.com/holyhigh2/uiik

Last synced: 8 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/holyhigh2/uiik
• Owner: holyhigh2
• License: mit
• Created: 2023-02-08T14:01:15.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T12:46:34.000Z (9 months ago)
• Last Synced: 2024-12-05T15:45:57.007Z (23 days ago)
• Language: JavaScript
• Homepage: https://holyhigh2.github.io/uiik/
• Size: 1.4 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![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