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

improve docs

Browse source
This commit is contained in:
Leo Horie 2014-09-14 00:22:00 -04:00
parent 81fc994954
commit 8c3467b819
10 changed files with 171 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/mithril.md
View file

@ -1,5 +1,18 @@
## m
---
[Usage](#usage)
[Using HTML entities](#using-html-entities)
[Accessing the real DOM element](#accessing-the-real-dom-element)
[Persisting config data](#persisting-config-data)
[Destructors](#destructors)
[SVG](#svg)
[Dealing with focus](#dealing-with-focus)
[Signature](#signature)
---
This is a convenience method to compose virtual elements that can be rendered via [`m.render()`](mithril.render.md).
You are encouraged to use CSS selectors to define virtual elements. See "Signature" section for details.
@ -157,6 +170,22 @@ One caveat of using the CSS syntax is that it clobbers the `style` attribute in
---
### Using HTML entities
By default, Mithril escapes HTML strings in order to help prevent XSS attacks.
```javascript
m("div", "&times;") //becomes <div>&amp;times;</div>
```
You can unescape trusted HTML strings by using [`m.trust`](mithril.trust.md)
```javascript
m("div", m.trust("&times;"() //becomes <div>&times;</div>
```
---
#### Accessing the real DOM element
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.