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

document vdom arg in config

Browse source
This commit is contained in:
Leo Horie 2015-04-10 22:32:54 -04:00
parent 6a9bfdca88
commit aa541bff79
2 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/mithril.md
View file

@ -13,7 +13,7 @@
- [Dealing with focus](#dealing-with-focus) - [Dealing with focus](#dealing-with-focus)
- [Dealing with sorting and deleting in lists](#dealing-with-sorting-and-deleting-in-lists) - [Dealing with sorting and deleting in lists](#dealing-with-sorting-and-deleting-in-lists)
- [Signature](#signature) - [Signature](#signature)
- [The `config` attribute](#the-config-attribute)
--- ---
This is a convenience method to compose virtual elements that can be rendered via [`m.render()`](mithril.render.md). This is a convenience method to compose virtual elements that can be rendered via [`m.render()`](mithril.render.md).
@ -475,7 +475,7 @@ VirtualElement m(String selector [, Attributes attributes] [, Children... childr
where: where:
VirtualElement :: Object { String tag, Attributes attributes, Children children } VirtualElement :: Object { String tag, Attributes attributes, Children children }
Attributes :: Object<any | void config(DOMElement element, Boolean isInitialized, Object context)> Attributes :: Object<any | void config(DOMElement element, Boolean isInitialized, Object context, VirtualElement vdom)>
Children :: String text | VirtualElement virtualElement | Component | SubtreeDirective directive | Array<Children children> Children :: String text | VirtualElement virtualElement | Component | SubtreeDirective directive | Array<Children children>
Component :: Object { Function? controller, Function view } Component :: Object { Function? controller, Function view }
SubtreeDirective :: Object { String subtree } SubtreeDirective :: Object { String subtree }
@ -539,7 +539,7 @@ where:
- #### The `config` attribute - #### The `config` attribute
**void config(DOMElement element, Boolean isInitialized, Object context)** (optional) **void config(DOMElement element, Boolean isInitialized, Object context, VirtualElement vdom)** (optional)
You can define a non-HTML-standard attribute called `config`. This special parameter allows you to call methods on the DOM element after it gets created. You can define a non-HTML-standard attribute called `config`. This special parameter allows you to call methods on the DOM element after it gets created.
@ -625,6 +625,10 @@ where:
m.render(document, m("a")); //logs `unloaded the div` and `alert` never gets called m.render(document, m("a")); //logs `unloaded the div` and `alert` never gets called
``` ```
- **VirtualElement vdom**
The virtual DOM element to which the `config` function is attached
- **Children children** (optional) - **Children children** (optional)

2
mithril.d.ts vendored
View file

@ -68,7 +68,7 @@ declare module _mithril {
// Configuration function for an element // Configuration function for an element
interface MithrilElementConfig { interface MithrilElementConfig {
(element: Element, isInitialized: boolean, context?: any): void; (element: Element, isInitialized: boolean, context?: any, vdom: MithrilVirtualElement): void;
} }
// Attributes on a virtual element // Attributes on a virtual element