Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tiagodanin/nuxt-vuikit
Vuikit Module for Nuxt.js
https://github.com/tiagodanin/nuxt-vuikit
nuxt nuxt-module nuxt-plugin nuxtjs uikit uikit-components uikit3 vue vue-plugin vuejs vuejs-plugin vuikit
Last synced: 4 months ago
JSON representation
Vuikit Module for Nuxt.js
- Host: GitHub
- URL: https://github.com/tiagodanin/nuxt-vuikit
- Owner: TiagoDanin
- License: mit
- Created: 2019-04-22T14:11:22.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T10:45:25.000Z (5 months ago)
- Last Synced: 2024-10-14T18:20:11.282Z (4 months ago)
- Topics: nuxt, nuxt-module, nuxt-plugin, nuxtjs, uikit, uikit-components, uikit3, vue, vue-plugin, vuejs, vuejs-plugin, vuikit
- Language: JavaScript
- Homepage: https://tiagodanin.github.io/Nuxt-Vuikit/
- Size: 677 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt Vuikit
[](https://travis-ci.org/TiagoDanin/Nuxt-Vuikit) [](https://npmjs.org/package/nuxt-vuikit) [](https://npmjs.org/package/nuxt-vuikit) [](https://npmjs.org/package/nuxt-vuikit) [](https://github.com/xojs/xo)
Vuikit Module for Nuxt.js
## Installation
Module available through the [npm registry](https://www.npmjs.com/). It can be installed using the [`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) or [`yarn`](https://yarnpkg.com/en/) command line tool.
```sh
# 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`
```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`:
```sh
# 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](https://github.com/TiagoDanin/Nuxt-Vuikit/issues). [List of all contributors](https://github.com/TiagoDanin/Nuxt-Vuikit/graphs/contributors).
## License
[MIT](LICENSE) © [Tiago Danin](https://TiagoDanin.github.io)