viewloader
v2.0.2
Published
Simplifying the process of binding DOM nodes to JavaScript functions
Downloads
670
Readme
viewloader
A teensy package that simplifies the process of binding DOM nodes to JavaScript functions. It does this by creating a convention for mapping between the DOM and your JavaScript and ensures that only the functions for the components in the DOM are executed.
Installation
% npm install --save viewloader
Development
To build a standalone version:
% npm run build
Example
<div data-view-my-bar-chart='{"data":[1,2,3]}'></div>
// bar-chart.js
export default function myBarChart (el, props) {
console.log(el, props); //=> div {data: [1,2,3]}
return {
reset: () => { ... },
destroy: () => { ... }
}
};
// index.js
import viewloader from "viewloader";
import myBarChart from "./bar-chart";
import myLineChart from "./line-chart";
const views = {
myBarChart,
myLineChart
};
// Create the instance
const manager = viewloader(views);
// Call the view functions
manager.callViews();
// Call the `reset` methods of each view function
manager.resetViews();
// Call the `destroy` methods of each view function
manager.resetViews();
API
viewloader(views, scope, includeScope);
- views — An
object
of view functions mapped todata-view-[name]
attributes. (Required) - scope — An
element
ornodelist
to scope the view loader to. (Optional. Defaults todocument
) - includeScope — A
boolean
to indicate if the scoped element should be included in the scoped views. (Optional: Defaults tofalse
)
Promises
Viewloader supports view functions that return a Promise
, automatically setting the resolved return value from any promises once that value is resolved. This means you can call viewloader synchronously with underlying code in your views that is asynchronous:
import viewloader from "viewloader";
const views = {
asyncView: (el, props) => {
return import("./async-import")
.then((asyncImport) => {
return asyncImport(el, props);
});
}
}