Commit graph

27 commits

Author SHA1 Message Date
Chad Whitacre
ef5ed9d70c fix typo: contoller → controller 2016-01-26 17:44:07 -05:00
Luis Felipe Souza
e083aaac9e Issue #938 Fixing typo 2016-01-22 14:21:41 -02:00
impinball
b218f5156f Reapply docs fix 2016-01-22 08:20:26 -05:00
Isiah Meadows
a8eb0fb082 Revert "Fix docs error" 2016-01-22 08:18:19 -05:00
impinball
90aa355795 Merge branch 'master' of https://github.com/lhorie/mithril.js into next 2016-01-22 08:13:53 -05:00
Christian Natis
a3410b8f3e Fixed syntax error in example 2015-11-12 10:56:46 -05:00
ly
414e80a1c9 FIX: document error on master branch according to #839 2015-11-12 17:59:15 +08:00
Leo Horie
ed3f3f0686 document component shorthand syntax 2015-07-23 23:43:19 -04:00
pelonpelon
648343c01c Help users find documentation on unmounting components
It's a common question on Gitter: How do I unmount a component?
Presently this Google Search: `unmount site:http://lhorie.github.io/`
returns one result: `mithril.route.html` -- I have no idea why, there's no "unmount" on the page.

Adding the words unmounting and unmount to this doc page will make them discoverable directly and through Google.
2015-07-02 18:54:59 -05:00
Christopher Venning
00db0b1ec0 Fixed typos in doc links 2015-06-16 16:15:42 -04:00
Christopher Venning
6ec6ede38a DOCS: missing comma in example 2015-06-09 19:10:51 -04:00
Brendon Murphy
7288afc18e Fix conversion in component stateless example 2015-05-08 20:16:12 -07:00
Yoshiki Shibukawa
b70b4191b7 Update mithril.component.md 2015-05-03 18:29:57 +09:00
Leo Horie
cafedae62f Merge remote-tracking branch 'origin/next' into next 2015-04-29 21:44:00 -04:00
Leo Horie
6f1bdc916c fixed typo 2015-04-29 21:43:38 -04:00
pelonpelon
b48f8bf79c Docs: mithril.component.md - Recommended changes
These changes make the the text clearer to me. I did not want to change the voice of the text, but I tried to clear out some verbosity and improve consistency. I did my best not to interfere with the logic of the prose.

This document seems written to stand on its own, so I recommend the following changes:

- a general explanation of the args param as in `controller: function(args) {` and `view: function(ctrl, args) { ...` (when first used, well before the signature)
- a specific explanation of {data: args} in m.request() (mithril.request.md could use the same treatment)
- an explanation of the extras param as in `controller: function(args, extras) {` and `view: function(ctrl, args, extras) { ...`
- the term *rollback* should be explained or replaced
- caveat #3/#4: Should *root element* be changed to *top-most element* so as not to be confused with the element the component is mounted on ?
- in testing, explain why the first param to view is `null`

I hope you can find some of this useful.
2015-04-29 12:39:10 -05:00
pelonpelon
9d20a7cd8a Update mithril.component.md 2015-04-29 11:57:51 -05:00
pelonpelon
9c6cbab43e Update mithril.component.md
- The term *rollback* should be explained or replaced
- caveat #3/#4: Should *root element* be changed to *top-most element* so as not to be confused with the element the component is mounted on ?
2015-04-29 11:50:07 -05:00
pelonpelon
62e38287f7 Docs: mithril.component.m - Recommended changes
These changes make the the text clearer to me. I did not want to change the voice of the text, but I tried to clear out some verbosity and improve consistency. I did my best not to interfere with the logic of the prose.

This document seems written to stand on its own, so I recommend the following additions:

- a general explanation of the args param as in `controller: function(args) {` and `view: function(ctrl, args) { ...`
- a specific explanation of how {data: args} in m.request() becomes url parameters (mithril.request.md could use the same treatment)
- an explanation of the extras param as in `controller: function(args, extras) {` and `view: function(ctrl, args, extras) { ...`
2015-04-28 23:26:18 -05:00
Leo Horie
5ec440da21 add more caveats to docs 2015-04-28 16:23:38 -04:00
Leo Horie
3137b63b12 add docs about infinite loop pitfall 2015-04-21 21:45:21 -04:00
Leo Horie
c9be4b30ce improve docs about redrawing 2015-04-20 22:16:27 -04:00
Arthur Clemens
b3411f9509 Typo: redundant parens 2015-04-15 00:46:56 +02:00
Leo Horie
6a9bfdca88 improve docs 2015-04-10 22:27:50 -04:00
Leo Horie
9e8dc6998d rework api 2015-04-09 22:44:45 -04:00
Leo Horie
d5619d412e changes in the docs: rename modules to components, change idiomatic controller and view usage 2015-04-06 22:41:38 -04:00
Leo Horie
0addce57ba docs for m.component and m.mount 2015-04-03 13:31:20 -04:00