@whppt/layouts

A layout plugin for @whppt/nuxt. Implement configurable layouts in seconds.

📖 Release Notes

Table of Contents

• Features
• Installation
• Usage
• Options
• License

Features

• Split Content Component

Usage

1. Add @whppt/layouts dependency to your project

yarn add @whppt/layouts # or npm install @whppt/layouts

2. Add @whppt/layouts to the modules section of nuxt.config.js

{
  modules: [
    // Simple usage
    '@whppt/layouts',

    // With options
    ['@whppt/layouts', { /* module options */ }]
  ]
}

3. create a nuxt plugin, eg. ~/plugins/layouts.js

import Vue from 'vue'
import layouts from '@whppt/layouts'

Vue.use(layouts)

4. Make a few updates to your ~/nuxt.config.js file.

export default {
  /* Rest of your config */
  plugins: {
    '~/plugins/layouts.js',
    /* Rest of your plugins */
  },
  /*
   * Note: the transpile step is only required if using the Vue.use() method,
   * if using Vue.component() to register the components omit the following.
   */
  build: {
    transpile: ['@whppt/layouts'],
  },
}

5. Check the documentation for any layout components you wish to use on how to register and initialise each component in whppt.

Options

License

MIT License