Package Exports

vue-deprecate

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-deprecate) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vue-deprecate

Installation

npm install vue-deprecate

Setup

Default setup

import Vue from 'vue';
import VueDeprecate from 'vue-deprecate';

Vue.use(VueDeprecate);

Nuxt.js setup

Create file plugins/vue-deprecate.js:

import Vue from 'vue'
import VueDeprecate from 'vue-deprecate';

Vue.use(VueDeprecate);

Then add the file path inside the plugins key of nuxt.config.js:

export default {
  plugins: ['@/plugins/vue-deprecate.js']
}

Usage

Deprecate component:

{
  name: 'ExampleComponent',
  deprecated: true,  // this component is deprecated
  data: function () {
    return {
      count: 0
    }
  },
  template: '<div>this is deprecated component {{ count }}</div>'
}

Add custom message:

{
  name: 'ExampleComponent',
  deprecated: 'ExampleComponent is deprecated. Use another component.',  // this component is deprecated
  data: function () {
    return {
      count: 0
    }
  },
  template: '<div>this is deprecated component {{ count }}</div>'
}

Deprecate property:

{
  name: 'ExampleComponent',
  props: {
    title: String,
    header: {
      type: String,
      deprecated: true, // this property is deprecated
    },
  },
  data: function () {
      return {
        count: 0
      }
  },
  template: '<div>this is component {{ count }}</div>'
};

Usage with property decorators (like vue-property-decorator/nuxt-property-decorator)

import { Vue, Component } from 'nuxt-property-decorator'

@Component({
  deprecated: true,
})
export default class Test extends Vue {
}

Features

You can:

mark components as deprecated
mark component properties as deprecated

A warning with the name of component and/or property is displayed in the console when using deprecated components or properties.