nodecg-vue

NodeCG Vue

Drop-in Vue UI components for use in a NodeCG dashboard panel

Using Vuetify components as a base, this project is designed to make dashboard development quicker and less cluttered when using Vue, by abstracting away repeated boilerplate code. The idea (and some replicant targeting code) was taken from the Polymer component library, NodeCGElements. Thanks Lange.

Component	Base Component	Status
nodecg-text	v-text-field
nodecg-toggle	v-button
nodecg-select	v-select
nodecg-combobox	v-combobox
nodecg-list	v-list
nodecg-menu	v-menu
nodecg-time-picker	v-time-picker

Install

• npm install nodecg-vue
• Setup your base component:

import Vue from 'vue';
import Vuetify from 'vuetify';
import NodeCGVue from 'nodecg-vue';

import 'vuetify/dist/vuetify.min.css';

Vue.use(Vuetify);
Vue.use(NodeCGVue);

import MyComponent from './MyComponent.vue';

new Vue({
	render: h => h(MyComponent)
}).$mount('#app');

Usage

Examples and description for the components can be found in each component's README. Click the name of an element above to go there.

As each component is just an extended Vuetify component, all the props, slots and events that you would expect are available.

Every component has at least the following props added to interface with the replicant:

• String: replicantName - The name of the target replicant. Required
• String: replicantBundle - The bundle namespace of the target replicant. If a NodeCG API context is available (window.nodecg), this defaults to the current bundle (window.nodecg.bundleName).
• Object: replicantOpts - The desired options to be passed to the Replicant upon declaration. See the NodeCG docs for more info on this. Defaults to an empty object. Cannot changed after component is mounted.

Contributing

The most needed thing at this stage is testing and feedback. If you encounter any bugs or have a feature request, an issue or PR would be much appreciated.