v0.2.2-rc.1
This commit is contained in:
Leo Horie
parent
484a9d6c70
commit
270b20a2b0
110 changed files with 17357 additions and 3070 deletions
151
archive/v0.2.1/mithril.withAttr.html
Normal file
151
archive/v0.2.1/mithril.withAttr.html
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<title>m.withAttr
- Mithril</title>
|
||||
<meta name="description" value="Mithril.js - a Javascript Framework for Building Brilliant Applications" />
|
||||
<link href="lib/prism/prism.css" rel="stylesheet" />
|
||||
<link href="style.css" rel="stylesheet" />
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<nav class="container">
|
||||
<a href="index.html" class="logo"><span>○</span> Mithril</a>
|
||||
<a href="getting-started.html">Guide</a>
|
||||
<a href="mithril.html">API</a>
|
||||
<a href="community.html">Community</a>
|
||||
<a href="http://lhorie.github.io/mithril-blog">Learn</a>
|
||||
<a href="installation.html">Download</a>
|
||||
<a href="http://github.com/lhorie/mithril.js" target="_blank">Github</a>
|
||||
</nav>
|
||||
</header>
|
||||
<main>
|
||||
<section class="content">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="col(3,3,12)">
|
||||
<h2 id="api">API (v0.2.1)</h2>
|
||||
<h3 id="core">Core</h3>
|
||||
<ul>
|
||||
<li><a href="mithril.html" title="A utility to create virtual elements">m</a></li>
|
||||
<li><a href="mithril.component.html" title="Parameterizes a component">m.component</a></li>
|
||||
<li><a href="mithril.mount.html" title="Renders a component">m.mount</a></li>
|
||||
<li><a href="mithril.prop.html" title="A getter-setter utility">m.prop</a></li>
|
||||
<li><a href="mithril.withAttr.html" title="A event handler factory utility">m.withAttr</a></li>
|
||||
</ul>
|
||||
<h3 id="routing">Routing</h3>
|
||||
<ul>
|
||||
<li><a href="mithril.route.html" title="A routing utility">m.route</a>
|
||||
<ul>
|
||||
<li><a href="mithril.route.html#defining-routes" title="Defines what routes exist">m.route(rootElement, defaultRoute, routes)</a></li>
|
||||
<li><a href="mithril.route.html#redirecting" title="Redirects to a route">m.route(path, params, replaceHistory)</a></li>
|
||||
<li><a href="mithril.route.html#reading-current-route" title="Read the current route">m.route()</a></li>
|
||||
<li><a href="mithril.route.html#mode-abstraction" title="Routing mode abstraction">m.route(element)</a></li>
|
||||
<li><a href="mithril.route.html#mode" title="Whether routing uses location hash, querystring or pathname">m.route.mode</a></li>
|
||||
<li><a href="mithril.route.html#param" title="Read an argument from a parameterized route">m.route.param</a></li>
|
||||
<li><a href="mithril.route.html#buildQueryString" title="Serialize data into querystring format">m.route.buildQueryString</a></li>
|
||||
<li><a href="mithril.route.html#parseQueryString" title="Read an argument from a parameterized route">m.route.parseQueryString</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="data">Data</h3>
|
||||
<ul>
|
||||
<li><a href="mithril.request.html" title="A high-level AJAX utility">m.request</a></li>
|
||||
<li><a href="mithril.deferred.html" title="A Promise factory">m.deferred</a></li>
|
||||
<li><a href="mithril.sync.html" title="A Promise aggregator">m.sync</a></li>
|
||||
</ul>
|
||||
<h3 id="html">HTML</h3>
|
||||
<ul>
|
||||
<li><a href="mithril.trust.html" title="A method to unescape HTML">m.trust</a></li>
|
||||
</ul>
|
||||
<h3 id="rendering">Rendering</h3>
|
||||
<ul>
|
||||
<li><a href="mithril.render.html" title="The lowest level rendering method">m.render</a></li>
|
||||
<li><a href="mithril.redraw.html" title="A high-level explicit rendering method">m.redraw</a>
|
||||
<ul>
|
||||
<li><a href="mithril.redraw.html#strategy" title="A flag that drives the rendering strategy for the next redraw">m.redraw.strategy(strategy)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="mithril.computation.html" title="Utilities to integrate asynchronous contexts to the rendering system">m.startComputation / m.endComputation</a></li>
|
||||
</ul>
|
||||
<h3 id="data">Testing</h3>
|
||||
<ul>
|
||||
<li><a href="mithril.deps.html" title="The dependency injector">m.deps</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="archive">History</h2>
|
||||
<ul>
|
||||
<li><a href="roadmap.html">Roadmap</a></li>
|
||||
<li><a href="change-log.html">Change log</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col(9,9,12)">
|
||||
<h2 id="m-withattr">m.withAttr</h2>
|
||||
<p>This is an event handler factory. It returns a method that can be bound to a DOM element's event listener.</p>
|
||||
<p>Typically, it's used in conjunction with <a href="mithril.prop.html"><code>m.prop</code></a> to implement data binding in the view-to-model direction.</p>
|
||||
<p>This method is provided to decouple the browser's event model from the controller/logic model.</p>
|
||||
<p>You should use this method and implement similar ones when extracting values from a browser's Event object, instead of hard-coding the extraction code into controllers (or model methods).</p>
|
||||
<hr>
|
||||
<h3 id="usage">Usage</h3>
|
||||
<pre><code class="lang-javascript">//standalone usage
|
||||
document.body.onclick = m.withAttr("title", function(value) {
|
||||
//alerts the title of the body element when it's clicked
|
||||
alert(value);
|
||||
})
|
||||
</code></pre>
|
||||
<p>A contrived example of bi-directional data binding</p>
|
||||
<pre><code class="lang-javascript">var user = {
|
||||
model: function(name) {
|
||||
this.name = m.prop(name);
|
||||
},
|
||||
controller: function() {
|
||||
return {user: new user.model("John Doe")};
|
||||
},
|
||||
view: function(controller) {
|
||||
m.render("body", [
|
||||
m("input", {onchange: m.withAttr("value", controller.user.name), value: controller.user.name()})
|
||||
]);
|
||||
}
|
||||
};
|
||||
</code></pre>
|
||||
<hr>
|
||||
<h3 id="signature">Signature</h3>
|
||||
<p><a href="how-to-read-signatures.html">How to read signatures</a></p>
|
||||
<pre><code class="lang-clike">EventHandler withAttr(String property, void callback(any value) [, any callbackThis])
|
||||
|
||||
where:
|
||||
EventHandler :: void handler(Event e)
|
||||
</code></pre>
|
||||
<ul>
|
||||
<li><p><strong>String property</strong></p>
|
||||
<p>Defines the property of the DOM element whose value will be passed to the callback.</p>
|
||||
</li>
|
||||
<li><p><strong>void callback(any value)</strong></p>
|
||||
<p>This function will be called with the value of the defined property as an argument.</p>
|
||||
<ul>
|
||||
<li><p><strong>any value</strong></p>
|
||||
<p>This is the value of the defined DOM element's property.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><strong>any callbackThis</strong></p>
|
||||
<p>The object which the <code>this</code> keyword points to for the callback</p>
|
||||
</li>
|
||||
<li><p><strong>returns EventHandler handler</strong></p>
|
||||
<p>This handler method can be assigned to properties like <code>onclick</code>, or passed as callbacks to <code>addEventListener</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</main>
|
||||
<footer>
|
||||
<div class="container">
|
||||
Released under the <a href="http://opensource.org/licenses/MIT" target="_blank">MIT license</a>
|
||||
<br />© 2014 Leo Horie
|
||||
</div>
|
||||
</footer>
|
||||
<script src="lib/prism/prism.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue