nuxt-vuikit

Vuikit Module for Nuxt.js

Usage no npm install needed!

<script type="module">
  import nuxtVuikit from 'https://cdn.skypack.dev/nuxt-vuikit';
</script>

README

Nuxt Vuikit

Travis Downloads Node Version XO code style

Vuikit Module for Nuxt.js

Installation

Module available through the npm registry. It can be installed using the npm or yarn command line tool.

# Yarn (Recomend)
yarn add nuxt-vuikit
# NPM 
npm install nuxt-vuikit --save

Documentation

Setup

  • Add nuxt-vuikit to modules section of your nuxt.config.js
{
    modules: [
        'nuxt-vuikit'
    ],
    vuikit: {
        defaultTheme: true,
        icons: true
    }
}

Module options

defaultTheme

Load UiKit3 default theme

  • Default: true
  • Type: Boolean

icons

Load UiKit3 icons

  • Default: true
  • Type: Boolean

Tests

To run the test suite, first install the dependencies, then run test:

# Using Yarn
yarn test

Dependencies

@vuikit/icons: UIkit icons as Vue functional components Author: Miljan Aleksic
License: MIT
Version: ^0.8.1
@vuikit/theme: Vuikit default theme based on UIkit Author: Miljan Aleksic
License: MIT
Version: ^0.8.1
debug: small debugging utility Author: TJ Holowaychuk
License: MIT
Version: ^4.1.1
vuikit: A responsive Vue UI library for web site interfaces based on UIkit Author: Miljan Aleksic
License: MIT
Version: ^0.8.10

Dev Dependencies

ava: Node.js test runner that lets you develop with confidence. Author: novemberborn, sindresorhus, vdemedes
License: MIT
Version: ^3.8.2
got: Human-friendly and powerful HTTP request library for Node.js Author: sindresorhus, szmarczak
License: MIT
Version: ^11.1.4
nuxt: A minimalistic framework for server-rendered Vue.js applications (inspired by Next.js) Author: atinux, pi0
License: MIT
Version: ^2.12.2
vue: Reactive, component-oriented view layer for modern web interfaces. Author: Evan You
License: MIT
Version: ^2.6.11
xo: JavaScript/TypeScript linter with great defaults Author: Sindre Sorhus
License: MIT
Version: ^0.30.0

Contributors

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. List of all contributors.

License

MIT © Tiago Danin