vue-options-api-constants-plugin

Adds a constants section to your Options API components.
6,571 6
vue api plugin options constants
Install
npm install vue-options-api-constants-plugin
Latest Version:1.0.3
License:MIT
Last Updated:Jan 21, 2025
Links: GitHub  ·  npm
Maintainer: thejaredwilcurt

Vue Options API Constants Plugin

Adds a constants section to your Options API components.

Under the hood the constants values are frozen (Object.freeze()) and returned as cached computed properties, accessible in the template.

Use

  1. npm install --save vue-options-api-constants-plugin
  2. Import the plugin into your main.js and then app.use it, like so: 
    import { createApp } from 'vue';
import constantsPlugin from 'vue-options-api-constants-plugin';

const app = createApp({});
app.use(constantsPlugin);
app.mount('#app');
  3. In any of your Options API components, you can now add a top level constants object, like so: 
    <template>
  <div>
    {{ BRAND_NAME }}
  </div>
</template>

<script>
import { BRAND_NAME } from './constants.js';

export default {
  name: 'AnExample',
  constants: {
    BRAND_NAME
  }
};
</script>

Use via CDN

<!DOCTYPE html>
<html>
  <head>
    <title>Example</title>
    <script src="https://unpkg.com/vue@3.3.4/dist/vue.global.prod.js"></script>
    <script src="https://unpkg.com/vue-options-api-constants-plugin@1.0.0/cdn.js"></script>
  </head>
  <body>
    <div id="app">
      {{ AN_EXAMPLE }}
    </div>
    <script>
      const AN_EXAMPLE = 'An example';

      const app = Vue.createApp({
        constants: {
          AN_EXAMPLE
        }
      });
      app.use(window.constantsPlugin);
      app.mount('#app');
    </script>
  </body>
</html>

Benefits

  • The constants are frozen as computed properties under the hood, so you cannot mutate them, and if you attempt, you'll get a warning in the console.
  • Gives you separation of concerns and code organization by having a place for all constants to live in each component.

Why not use data, setup, computed or methods?

  • data and setup sections would create reactive and mutatable variables, which you don't want for your constants.
  • computed section works, but adds a lot of boilerplate that this plugin is abstracting away for you.
  • methods section would have the same boilerplate as the computed, and additional boilerplate in the template ({{ AN_EXAMPLE() }}) and in the scripts (this.AN_EXAMPLE())

Downsides

  • Ctrl+Click from the template to the defintion doesn't work with Intellisense/VSCode. However, this may be fixable with some editor hints, as other tools, like Vuelidate and Pinia don't have this issue. If you know how to fix this, create a PR.

Related Packages

vue-youtube

YouTube IFrame Player API wrapper

629,279 333
api plugin player vue.js youtube
vue-youtube-vue-3

YouTube IFrame Player API wrapper

18,009 333
api plugin player vue.js youtube
v-api-fetch

Um plugin e composable para Vue 3 que simplifica chamadas de API com Axios, incl...

2,404 3
api plugin vue axios composable fetch
vue-plugin-axios

A wrapper for integrating axios to Vuejs

3,521 5
api plugin vue axios http vue.js wrapper
@21cnfe/onekit-mp-cli

小程序框架开发工具

1,063
plugin

Version History

Version Released License
1.0.3 MIT
1.0.2 MIT
1.0.1 MIT
1.0.0 MIT