# vue-cli-plugin-uikit

> A Vue CLI plugin to add UIKit to a project

Latest version **1.0.15** (published 2019-01-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-cli-plugin-uikit
pnpm add vue-cli-plugin-uikit
yarn add vue-cli-plugin-uikit
bun add vue-cli-plugin-uikit
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.15 |
| Published | 2019-01-24 |
| First published | 2019-01-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Tim Chambers |
| Maintainers | srv-bpxio, timchambers.com |
| Keywords | vue, vue-cli, uikit |

## Links

- npm: https://www.npmjs.com/package/vue-cli-plugin-uikit
- Repository: https://github.com/BPXIO/vue-cli-plugin-uikit
- Issues: https://github.com/BPXIO/vue-cli-plugin-uikit/issues
- npm.io page: https://npm.io/package/vue-cli-plugin-uikit

## Recent versions

- 1.0.15 (latest) — 2019-01-24
- 1.0.14 — 2019-01-23
- 1.0.13 — 2019-01-23
- 1.0.12 — 2019-01-23
- 1.0.11 — 2019-01-23
- 1.0.10 — 2019-01-23
- 1.0.9 — 2019-01-23
- 1.0.8 — 2019-01-23
- 1.0.7 — 2019-01-23
- 1.0.6 — 2019-01-23

## README

# vue-cli-plugin-uikit
A [vue-cli plugin](https://cli.vuejs.org/guide/plugins-and-presets.html) to add [UIKit](https://getuikit.com) to a Vue project.

## Requires `@vue/cli`

Make sure [`@vue/cli` is installed](https://cli.vuejs.org/guide/installation.html) globally

```sh
yarn global add @vue/cli
```

## Add this plugin to an existing project

```sh
vue add uikit
```

— Or —

```sh
yarn add --dev vue-cli-plugin-uikit 
vue invoke uikit
```

## Changes to your project made by this plugin

_**[When installing any vue-cli plugin](https://cli.vuejs.org/guide/plugins-and-presets.html#installing-plugins-in-an-existing-project), you should first commit any other changes you’ve made to your project, so you can `diff` this plugin’s changes.**_

This plugin makes the following changes to your project, which you can review in [/generator](./generator):

- Adds `uikit` to `package.json` dependencies
- Adds the `UIkit` global to `package.json` eslint globals
- `include`s UIKit (and optionally UIKit Icons) in `src/main.js`
- Adds `src/assets/styles/styles.scss` and `include`s that in `src/main.js`
- Sets the global `window.UIkit` in `src/main.js` to allow UIKit’s JavaScript components to be used globally

## Customize styles.scss

This plugin creates `src/assets/styles/styles.scss` which `@includes` the UIKit sass styles in the right order. You can customize the styles / theme according to the [UIKit documentation](https://getuikit.com/docs/sass), or switch the `src/main.js` include to include the `less` styles or rendered css styles as you wish.

## TODO:
- [ ] Prompt for desired style language (scss, less, css)
- [ ] Detect if eslint is enabled before adding global
- [ ] Detect if separate config files are used and make changes appropriately?

---
_Source: https://npm.io/package/vue-cli-plugin-uikit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._