https://github.com/vuikit/vuikit

A responsive Vue UI library for web site interfaces
https://github.com/vuikit/vuikit

ui uikit vue vuejs

Last synced: 29 days ago
JSON representation

A responsive Vue UI library for web site interfaces

• Host: GitHub
• URL: https://github.com/vuikit/vuikit
• Owner: vuikit
• License: mit
• Created: 2015-12-20T15:05:47.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-04-29T01:52:09.000Z (over 4 years ago)
• Last Synced: 2024-10-01T18:05:54.170Z (about 1 month ago)
• Topics: ui, uikit, vue, vuejs
• Language: JavaScript
• Homepage: https://vuikit.js.org
• Size: 12 MB
• Stars: 1,485
• Watchers: 32
• Forks: 105
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Vuikit](https://user-images.githubusercontent.com/513275/37552738-b8fcea74-29f5-11e8-9300-5e9532271bf8.png)](http://vuikit.js.org/)

# Vuikit

A responsive [Vue](https://vuejs.org/) 2 UI library for web site interfaces based on the [UIkit](https://getuikit.com/) 3 framework.

> If you are enjoying Vuikit and want to support the project consider making a small [donation](https://www.paypal.me/MiljanAleksic). It means a lot :)

# Getting Started

```vue

import Vue from 'vue'

import Vuikit from 'vuikit'

import VuikitIcons from '@vuikit/icons'

Vue.use(Vuikit)

Vue.use(VuikitIcons)

  MyButton

  

```

## Packages

`vuikit` repository is a [monorepo](https://danluu.com/monorepo/) managed by [Yarn Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/). Click on package name to see specific docs.

| Package | Version | Description |

|---|---|---|

| [`vuikit`](packages/vuikit) | [![NPM version](https://img.shields.io/npm/v/vuikit.svg?style=flat-square)](https://npmjs.org/package/vuikit) | The main package |

| [`vuikit-icons`](packages/vuikit-icons) | [![NPM version](https://img.shields.io/npm/v/@vuikit/icons.svg?style=flat-square)](https://npmjs.org/package/@vuikit/icons) | Icons collection |

| [`vuikit-theme`](packages/vuikit-theme) | [![NPM version](https://img.shields.io/npm/v/@vuikit/theme.svg?style=flat-square)](https://npmjs.org/package/@vuikit/theme) | Default theme |

## Semver

Until a v1.0.0 is reached, breaking changes will be released with a new minor version. For example 0.4.0 and 0.4.1 would have the same API and it's safe to update, but 0.5.0 would have breaking changes and the integration may require a review.

## Acknowledgments

A special thanks to:

 - [ZOOlanders](https://zoolanders.com/) for sponsoring Vuikit.

 - [YOOtheme](https://yootheme.com/) for creating and open sourcing UIkit.

## License

[MIT](./LICENSE) © [Miljan Aleksic](https://github.com/miljan-aleksic)