Skip to content

Latest commit

 

History

History
98 lines (74 loc) · 2.7 KB

README.md

File metadata and controls

98 lines (74 loc) · 2.7 KB

xui-module

npm (scoped with tag) npm CircleCI Codecov Dependencies

js-standard-style

Light module to help design websites with Nuxt. demo source

📖 Release Notes

Features

This module install several libraries to make designing a website with Vue and Nuxt easy, including:

Setup

  • Add xui-module dependency using yarn or npm to your project
yarn add xui-module

or

npm install xui-module --save
  • Add xui-module to modules section of nuxt.config.js
{
  modules: [
    // Simple usage
    'xui-module',

    // With options
    ['xui-module', { /* module options */ }],
 ]
}
  • If needed, add sass-loader
yarn add sass-loader node-sass

or

npm install sass-loader node-sass --save-dev

Module Options

You can parametrize Xui-module with these variables:

  • 'bulma'
  • 'mdi'
  • 'animate.css'
  • 'hover.css'
  • 'animate'
  • 'spacing'
  • 'vue-in-viewport-directive'
  • 'vue-scrollactive'
  • 'vue-headroom'

example:

{
  'bulma': {
    options: { /* bulma options */ }
  },
  'mdi': {
    active: false // Do not load Material Design Icons
  },
  'vue-scrollactive': {
    ssr: false // Turn off ssr for vue-scrollactive
  }
}

License

MIT License

Copyright (c) Meta l.szabatura@gmail.com