An modular inspection tool for your DoneJS application
MIT License
An modular inspection tool for your DoneJS application
npm install --save-dev done-inspect
or
yarn add done-inspect --dev
Use ES6 import
or CommonJS require
to load done-inspect
. After which,
it can be used in your template.
// ES6
import plugin from 'done-inspect';
// CommonJS
var plugin = require('done-inspect');
Or import it directly into your can-stache
template with can-import
and stealjs
:
<can-import from="done-inspect" />
<done-inspect />
{{!-- With configuration options and an application title --}}
<done-inspect {options}="anObject" {title}="aString" />
The options
parameter is expected to be an object and accepts only two properties:
expanded
and modules
.
expanded
is a boolean and expects true
or false
as valuesmodules
is expected to be an Array
of Object
where each object matches the interfaceThe title
parameter take a string and will be displayed at the top of the inspector. The idea
for this was to display the package.json's name + version
at the top of the inspector but
any string is accepted.
Two modules come with the current version of done-inspect
:
Writing a done-inspect
module requires an exported object with three properties and one function.
import './module-name.less';
export default {
group: '<string :: The group the module belongs to>',
title: '<string :: The short title shown to the User>',
description: '<string :: What function the module performs>',
onChange() {
/**
* Currently done-inspect's interface only supports checkboxes.
*
* This function will be called each time the User clicks the
* module's checkbox. Therefore, it needs to account for being
* checked and unchecked.
*/
},
};
In order to reduce the change of style conflict, I use the following class name convention:
.done-inspect-module-name-class-name {
// ALL THE STYLES
}