onorix

Yet another NodeCG plugin for Vue

Usage no npm install needed!

<script type="module">
  import onorix from 'https://cdn.skypack.dev/onorix';
</script>

README

Onorix

Yet another NodeCG plugin for Vue.

Table of Contents

Installation

npm install onorix

import Vue from "vue";
import Onorix from "onorix";

Vue.use(Onorix);

Usage

Replicants

const app = new Vue({
  replicants: {
    /**
     * Declares a `lorem` replicant.
     */
    lorem: {},

    /**
     * Declares a `dolor` replicant but accessible from `ipsum`.
     */
    ipsum: {
      name: "dolor",
    },

    /**
     * Declares a `sit` replicant with the given options.
     */
    sit: {
      defaultValue: "Spark",
      persistent: false,
    },

    /**
     * Declares a `amet` replicant from the `acta` namespace.
     */
    amet: {
      namespace: "acta",
    },
  },
  created() {
    console.log(this.$replicants.lorem);
  },
});

Decorators

If prefer decorators, you can declare replicants with @Replicant. The main difference with the previous example is that a computed property is being defined as well.

import { Replicant } from "onorix";
import { Component, Vue } from "vue-property-decorators";

@Component
class App extends Vue {
  @Replicant() lorem;
  @Replicant({ name: "dolor" }) ipsum;
  @Replicant({ defaultValue: "Spark", persistent: false }) sit;
  @Replicant({ namespace: "acta" }) amet;

  created() {
    console.log(this.$replicants.lorem.value === this.lorem);
  }
}

Author

Alexandre Breteau - @0xSeldszar

License

MIT © Alexandre Breteau