dashy/src/mixins/WidgetMixin.js

54 lines
1.4 KiB
JavaScript

/**
* Mixin that all pre-built and custom widgets extend from.
* Manages loading state, error handling, data updates and user options
*/
import ProgressBar from 'rsup-progress';
import ErrorHandler from '@/utils/ErrorHandler';
const WidgetMixin = {
props: {
options: {
type: Object,
default: {},
},
},
data: () => ({
progress: new ProgressBar({ color: 'var(--progress-bar)' }),
}),
/* When component mounted, fetch initial data */
mounted() {
this.fetchData();
},
methods: {
/* Re-fetches external data, called by parent. Usually overridden by widget */
update() {
this.startLoading();
this.fetchData();
},
/* Called when an error occurs. Logs to handler, and passes to parent component */
error(msg, stackTrace) {
ErrorHandler(msg, stackTrace);
this.$emit('error', msg);
},
/* When a data request update starts, show loader */
startLoading() {
this.$emit('loading', true);
this.progress.start();
},
/* When a data request finishes, hide loader */
finishLoading() {
this.$emit('loading', false);
setTimeout(() => { this.progress.end(); }, 500);
},
/* Overridden by child component. Will make network request, then end loader */
fetchData() {
this.finishLoading();
},
tooltip(content) {
return { content, trigger: 'hover focus', delay: 250 };
},
},
};
export default WidgetMixin;