vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update docs about components

Browse source
This commit is contained in:
Leo Horie 2014-09-26 21:42:36 -04:00
parent c16350de5a
commit 4184da27c8
6 changed files with 270 additions and 242 deletions
Download patch file Download diff file Expand all files Collapse all files

61
docs/mithril.module.md
View file

@ -49,67 +49,26 @@ Typically, however, modules and namespaces are used interchangeably.
//`dashboard` is both a namespace and a module
var dashboard = {}
//controller class
//view-model
dashboard.vm = {}
//controller
dashboard.controller = function() {
this.greeting = "Hello";
dashboard.vm.greeting = "Hello";
};
//view class
dashboard.view = function(ctrl) {
return m("h1", ctrl.greeting);
//view
dashboard.view = function(vm) {
return m("h1", dashboard.vm.greeting);
};
//initialize it
m.module(document.body, dashboard);
```
The example below shows a component module called `user` being included in a parent module `dashboard`.
Modules can also be used as components in order to assemble bigger systems. You can [read more about componentization here](components.md)
```javascript
//this is a sample module
var dashboard = {
controller: function() {
this.greeting = "Hello";
this.user = new user.controller();
},
view: function(controller) {
return [
m("h1", controller.greeting),
user.view(controller.user)
];
}
};
//this module is being included as a component
var user = {
//model
User: function(name) {
this.name = name;
},
//controller
controller: function() {
this.user = new user.User("John Doe");
},
//view
view: function(controller) {
return m("div", controller.user.name);
}
};
//activate the dashboard module
m.module(document.body, dashboard);
```
yields:
```markup
<body>
<h1>Hello</h1>
<div>John Doe</div>
</body>
```
---
### Unloading modules