nuxt-bulma-breakpoints

Resize observer breakpoints with Nuxt.js module. Bulma edition

Setup

1. Add nuxt-bulma-breakpoints dependency to your project

yarn add nuxt-bulma-breakpoints # or npm install nuxt-breakpoints

2. Add nuxt-bulma-breakpoints to the modules section of nuxt.config.js

{
  modules: [
    // Simple usage
    'nuxt-breakpoints',

    // With options
    ['nuxt-breakpoints', { /* module options */ }]
  ]

  // Another way to use options
  breakpoints: {
    // default options
    tablet: 769,
    desktop: 1024,
    widescreen: 1216,
    fullhd: 1408,
    options: {
      polyfill: true,
      throttle: 200
    }
  }
}

Usage

// components.vue
export default {
  computed: {
    isMobile() {
      return this.$breakpoints.mobile
    },
    untilWidescreen(){
      return this.$breakpoints.untilWidescreen
    }
    current() {
      return this.$breakpoints.current
    }
  }
}

Breakpoints and helpers

| Helper | Note | |-----------------|----------------------------------------------------------| | mobile | width < 769px (tablet) | | tablet | width >= 769px (tablet) | | tabletOnly | width >= 769px (tablet) && width < 1024 (desktop) | | touch | width < 1024px (desktop) | | desktop | width >= 1024px (desktop) | | desktopOnly | width >= 1024px (desktop) && width < 1216px (widescreen) | | untilWidescreen | width < 1216px (widescreen) | | widescreen | width >= 1216px (widescreen) | | widescreenOnly | width >= 1216px (widescreen) && width < 1408px (fullhd) | | untilFullhd | width < 1408px (fullhd) | | fullhd | width >= 1408px (fullhd) |

Options

| Property | Type | Default | |------------|--------|-----------------------------------| | mobile | none | none | | tablet | number | 769 | | desktop | number | 1024 | | widescreen | number | 1216 | | fullhd | number | 1408 | | options | object | { polyfill: true, throttle: 200 } |

Note: polyfill default by true, which means auto-import resize-observer-polyfill when the browser doesn't support ResizeObserver more information below, throttle will slow down when Window has resizing trigger speed.

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using yarn dev or npm run dev

Ref

Nuxt.js

MDN - ResizeObserver

ResizeObserver Polyfill

License

MIT License

Copyright (c) Steven Ho [email protected]