A frontend library to develop zoomable user interfaces.
Like it? Leave a star, it will help attract more visitors and contributors.
## What is zircle-ui? **Zircle-ui** is an experimental frontend library to develop [zoomable user interfaces (ZUI)](https://en.wikipedia.org/wiki/Zooming_user_interface). It is based on [vue.js](https://vuejs.org/) and JavaScript and comes with a set of components to create unconventional user interfaces. ## Features - **Zoomable UI/UX:** Enjoy a different UI/UX with the built-in zoomable navigation. - **Circles everywhere:** Breaking away from the conventional UI with a circular UI Kit. - **Responsive:** zircle-ui works pretty well on mobile devices and big screens. - **Customizable themes:** Aren't the integrated color themes enough? No problem, it is easy to create new ones. - **Zero-conf routes:** Using Vue-router? Let **zircle-ui** handles the routes for you. ## When to use zircle-ui? You can try **zircle-ui** to develop a wide range of applications, such as: dashboards, health/fitness trackers, IOT hubs or controllers, contact management, information and entertainment, interactive menus, etc. In general, using **zircle-ui** should be fine if your application is highly interactive and you need to intuitively view and control information without loosing the user’s attention. ## About zircle-ui **Zircle-ui** is the first [Open Source Project](https://opensource.guide/starting-a-project/) I've made and it was possible thanks to the Open Source community, specially the [Vue](https://vuejs.org) community. In retribution, I've created a project of the highest quality I could within my limitations since I'm not a professional developer. **Zircle-ui** intends to promote approach in the universe of UIs. My main motivation is believing there is room for a new UI/UX not constrained to grid layouts or to squared shapes. **Zircle-ui** was inspired by the idea underneath some really awesome projects and articles like [prezi](https://www.prezi.com), [impress.js](https://github.com/impress/impress.js), [tizen](https://www.tizen.org/), [zoomooz](http://jaukia.github.io/zoomooz/), [creativebloq's article](https://www.creativebloq.com/create-zoomable-user-interface-css-transforms-9114269), [google maps](http://maps.google.com), [bootstrap](https://getbootstrap.com/), [UIKit](https://getuikit.com/) and [bulma](https://bulma.io) among others. --- ## Table of contents - [Status](#status-beta) - [Documentation, examples and tutorial](#documentation-examples-and-tutorial) - [Installation](#installation) * [Direct download](#--direct-download) * [Content delivery networks (CDN)](#--content-delivery-networks-cdn) * [NPM or Yarn](#--npm-or-yarn) - [Quick Start](#quick-start) * [Code Sandbox](#--code-sandbox) * [Browser](#--browser) * [Single File Components and vue-cli](#--single-file-components-and-vue-cli) - [Contributing](#contributing) - [License](#license) --- ## Status: Despite **zircle-ui** could be considered **stable**, it will remains as beta for a while because I would like to hear feedbacks regarding its usability. ## Documentation, examples and tutorial Please checkout [**zircle.io**](http://zircle.io) to learn how to use **zircle-ui**. For early **zircle-ui** users a **easy-to-follow migration guide** [is available here](https://zircleui.github.io/docs/guide/migration.html) ## Installation ### - Direct download Just download **zircle-ui** from [Github](https://github.com/zircleUI/zircleUI/tree/master/dist). You need to download the zircle.umd.js or the zircle.umd.min.js file along with the zircle.css file. ### - Content delivery networks (CDN) Include `https://unpkg.com/zircle` in your project with `