can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - can-stache-bindings</title> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <link rel="stylesheet" type="text/css" href="./static/bundles/bit-docs-site/static.css"> <link rel="shortcut icon" sizes="16x16 24x24 32x32 48x48 64x64" href="/docs/images/canjs_favicon.ico"> <link rel="apple-touch-icon" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon-precomposed" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon" sizes="72x72" href="../docs/images/canjs_favicon_72x72.png"> <link rel="apple-touch-icon" sizes="114x114" href="../docs/images/canjs_favicon_114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="../docs/images/canjs_favicon_128x128.png"> <link rel="apple-touch-icon" sizes="144x144" href="../docs/images/canjs_favicon_144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="../docs/images/canjs_favicon_152x152.png"> <meta content="yes" name="apple-mobile-web-app-capable"> <meta name="apple-mobile-web-app-status-bar-style" content="white-translucent"> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-2302003-11', 'auto'); ga('send', 'pageview'); </script> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger"/> <label for="nav-trigger">Menu</label> <div id="everything"> <div id="left" class="column"> <div class="top-left"> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> <div class="dropdown project-dropdown"> <a href="https://donejs.com/">DoneJS</a> <a href="http://stealjs.com/">StealJS</a> <a href="http://jquerypp.com/">jQuery ++</a> <a href="https://funcunit.com/">FuncUnit</a> <a href="http://documentjs.com/">DocumentJS</a> </div> </div> <div class="version"> <div class="version-number"> 3.0.0 </div> <div class="dropdown version-dropdown"> <a href="https://v2.canjs.com">2.3.27</a> </div> </div> </div> <div class="search-bar"> <p>   </p> </div> </div> <div class="bottom-left"> <div class="social-side-container"> <ul class="social-side"> <li> <a class="header-mobile github" href="https://github.com/canjs/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/github.png">Github</a> </li> <li> <a class="header-mobile twitter" href="https://twitter.com/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/twitter.png">Twitter</a> </li> </ul> <ul class="social-side"> <li> <a class="header-mobile" href="https://gitter.im/canjs/canjs" target="_blank">Chat</a> </li> <li> <a class="header-mobile" href="http://forums.donejs.com/c/canjs" target="_blank">Forum</a> </li> </ul> </div> <ul> <li class=" "> <a class="page" href="guides.html" title="Welcome to CanJS! These guides are here to help you develop and improve your relationship with CanJS. After all, picking a JavaScript framework is a commitment. We want CanJS to be the framework you marry. This page helps you know how advance through the different stages of this relationship:"> Guides </a> </li> <li class=" parent expanded"> <a class="page" href="can-core.html" title="The best, most hardened and generally useful libraries in CanJS."> Core </a> <ul> <li class=" "> <a class="module" href="can-component.html" title="Create a custom element that can be used to manage widgets or application logic."> can-component </a> </li> <li class=" "> <a class="module" href="can-compute.html" title="Create an observable value."> can-compute </a> </li> <li class=" "> <a class="module" href="can-connect.html" title="can-connect provides persisted data middleware. Use it to assemble powerful model layers for any JavaScript project."> can-connect </a> </li> <li class=" "> <a class="module" href="can-define.html" title="Exports the define method that defines observable properties and their behavior on a prototype object."> can-define </a> </li> <li class=" "> <a class="module" href="can-define/list/list.html" title="Create observable lists."> can-define/list/list </a> </li> <li class=" "> <a class="module" href="can-define/map/map.html" title="Create observable objects."> can-define/map/map </a> </li> <li class=" "> <a class="function" href="can-route.html" title="Manage browser history and client state by synchronizing the window.location.hash with a map."> can-route </a> </li> <li class=" "> <a class="module" href="can-route-pushstate.html" title="Changes can-route to use pushstate to change the window's pathname instead of the hash. var route = require("can-route-pushstate"); route("{page}", { page: "home" }); route.ready(); route.attr("page", "user"); location.pathname; // -> "/user""> can-route-pushstate </a> </li> <li class=" "> <a class="module" href="can-set.html" title="can-set is a utility for comparing sets that are represented by the parameters commonly passed to service requests."> can-set </a> </li> <li class=" "> <a class="module" href="can-stache.html" title="Live binding Mustache and Handlebars-compatible templates."> can-stache </a> </li> <li class=" "> <a class="module" href="can-stache/helpers/route.html" title="Adds stache helpers that use can-route."> can-stache/helpers/route </a> </li> <li class="current parent expanded"> <a class="module" href="can-stache-bindings.html" title="Provides template event, one-way, and two-way bindings."> can-stache-bindings </a> <ul> <li> <span>Syntaxes</span> <ul> <li class=" "> <a class="function" href="can-stache-bindings.event.html" title="Response to events on elements or component ViewModels."> (event) </a> </li> <li class=" "> <a class="function" href="can-stache-bindings.toChild.html" title="One-way bind a value in the parent scope to the viewModel."> {to-child} </a> </li> <li class=" "> <a class="function" href="can-stache-bindings.toParent.html" title="One-way bind a value in the current viewModel to the parent scope."> {^to-parent} </a> </li> <li class=" "> <a class="function" href="can-stache-bindings.twoWay.html" title="Two-way bind a value in the viewModel or the element to the parent scope."> {(two-way)} </a> </li> <li class=" "> <a class="function" href="can-stache-bindings.reference.html" title="Export a viewModel into a template's references scope."> *REFERENCE </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class=" "> <a class="page" href="can-ecosystem.html" title="Useful libraries that extend or add important features to the core collection."> Ecosystem </a> </li> <li class=" "> <a class="page" href="can-infrastructure.html" title="Utility libraries that power the core and ecosystem collection."> Infrastructure </a> </li> <li class=" "> <a class="page" href="can-legacy.html" title="Former libraries that we still accept patches for, but are not under active development."> Legacy </a> </li> </ul> </div> </div> <div id="right" class="column"> <div class="top-right"> <div class="top-right-top"> <ul class="top-right-bitovi"> <li class="dropdown"> <a href="http://bitovi.com" class="bitovi icon-bits">Bitovi</a> <ul class="dropdown-menu"> <li><a href="http://bitovi.com">Bitovi.com</a></li> <li><a href="http://bitovi.com/blog/">Blog</a></li> <li><a href="http://bitovi.com/consulting/">Consulting</a></li> <li><a href="http://bitovi.com/training/">Training</a></li> <li><a href="http://bitovi.com/open-source/">Open Source</a></li> </ul> </li> </ul> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> </div> </div> <ul class="top-right-links"> <li> <a href="https://gitter.im/canjs/canjs">Chat</a> </li> <li> <a href="http://forums.donejs.com/c/canjs">Forum</a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/canjs" data-count-href="/canjs/canjs/stargazers" data-count-api="/repos/canjs/canjs#stargazers_count">Star</a> </li> <li> <a href="https://twitter.com/canjs" class="twitter-follow-button nav-social" data-show-count="true" data-show-screen-name="false">Follow @canjs</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </li> </ul> </div> <div class="breadcrumb"> <li><a href="../index.html">CanJS</a></li> / <li><a href="can-core.html">Core</a></li> / <li><a href="can-stache-bindings.html">can-stache-bindings</a></li> <li class="breadcrumb-dropdown">/ <a> On this page</a> <ul class="on-this-page"></ul> </li> <div class="nav-toggle" title="Back to top"></div> </div> </div> <div class="bottom-right"> <article> <section class="title"> <div class="page-type"> <h1>can-stache-bindings</h1> <div>module</div> </div> <section class="description"> <p>Provides template event, one-way, and two-way bindings.</p> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-social"> <li> <a class="npm-button" href="https://www.npmjs.com/package/can-stache-bindings"> <img src="https://img.shields.io/badge/npm%20package-3.0.4-brightgreen.svg" alt="npm package badge" /> </a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/can-stache-bindings" data-count-href="/canjs/can-stache-bindings/stargazers" data-count-api="/repos/canjs/can-stache-bindings#stargazers_count">Star</a> </li> </ul> <ul class="title-links">  <li><a href="//github.com/canjs/can-stache-bindings/tree/v3.0.4/docs/bindings.md">source</a></li>   </ul> </section> <section class="body"> <h2>Use</h2> <p>The <code>can-stache-bindings</code> plugin provides <a href="can-view-callbacks.attr.html" title="Register custom behavior for an attribute.">custom attributes</a> useful for template declarative event, one-way and two-way bindings on element attributes, component [can-component::viewModel viewModels], and the <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a>. Bindings look like:</p> <ul> <li><code>(event)="key()"</code> for event binding.</li> <li><code>{prop}="key"</code> for one-way binding to a child.</li> <li><code>{^prop}="key"</code> for one-way binding to a parent.</li> <li><code>{(prop)}="key"</code> for two-way binding.</li> </ul> <p>Prepending $ to a binding like <code>($event)="key()"</code> changes the binding from the <code>viewModel</code> to the element's attributes or properties.</p> <p>The following are the bindings that should be used with <a href="can-stache.html" title="Live binding Mustache and Handlebars-compatible templates.">can-stache</a> and are compatible with the upcoming 3.0 release:</p> <h4><a href="can-stache-bindings.event.html" title="Response to events on elements or component ViewModels.">event</a></h4> <p>Binds to <code>childEvent</code> on <code><my-component></code>'s [can-component::viewModel viewModel] and calls <code>method</code> on the <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a> with the specified arguments:</p> <pre><code><my-component (child-event)="method('primitive', key, hash1=key1)"/> </code></pre> <p>Binds to <code>domEvent</code> on <code><my-component></code> and calls <code>method</code> on the <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a> with the specified arguments.</p> <pre><code><my-component ($dom-event)="method('primitive', key, hash1=key1)"/> </code></pre> <h4><a href="can-stache-bindings.toChild.html" title="One-way bind a value in the parent scope to the viewModel.">one-way to child</a></h4> <p>Updates <code>childProp</code> in <code><my-component></code>'s [can-component::viewModel viewModel] with <code>value</code> in the <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a>:</p> <pre><code><my-component {child-prop}="value"/> </code></pre> <p>Updates the <code>child-attr</code> attribute or property on <code><my-component></code> with <code>value</code> in the <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a>:</p> <pre><code><my-component {$child-attr}="value"/> </code></pre> <h4><a href="can-stache-bindings.toParent.html" title="One-way bind a value in the current viewModel to the parent scope.">one-way to parent</a></h4> <p>Updates <code>value</code> in the <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a> with <code>childProp</code> in <code><my-component></code>'s [can-component::viewModel viewModel]:</p> <pre><code><my-component {^child-prop}="value"/> </code></pre> <p>Updates <code>value</code> in the <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a> with the <code>child-attr</code> attribute or property on <code><my-component></code>:</p> <pre><code><my-component {^$child-attr}="value"/> </code></pre> <h4><a href="can-stache-bindings.twoWay.html" title="Two-way bind a value in the viewModel or the element to the parent scope.">two-way</a></h4> <p>Updates <code>childProp</code> in <code><my-component></code>'s [can-component::viewModel viewModel] with <code>value</code> in the <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a> and vice versa:</p> <pre><code><my-component {(child-prop)}="value"/> </code></pre> <p>Updates the <code>child-attr</code> attribute or property on <code><my-component></code> with <code>value</code> in the <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a> and vice versa:</p> <pre><code><my-component {($child-attr)}="value"/> </code></pre> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-stache-bindings/docs/bindings.md"},"description":"\nProvides template event, one-way, and two-way bindings.\n","type":"module","title":"","name":"can-stache-bindings","parent":"can-core","package":{"_args":[[{"raw":"can-stache-bindings@3.0.4","scope":null,"escapedName":"can-stache-bindings","name":"can-stache-bindings","rawSpec":"3.0.4","spec":"3.0.4","type":"version"},"/Users/kevin/dev/canjs"]],"_from":"can-stache-bindings@3.0.4","_id":"can-stache-bindings@3.0.4","_inCache":true,"_location":"/can-stache-bindings","_nodeVersion":"6.9.1","_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/can-stache-bindings-3.0.4.tgz_1478729923181_0.11550585669465363"},"_npmUser":{"name":"phillipskevin","email":"kphillips86@gmail.com"},"_npmVersion":"3.10.8","_phantomChildren":{},"_requested":{"raw":"can-stache-bindings@3.0.4","scope":null,"escapedName":"can-stache-bindings","name":"can-stache-bindings","rawSpec":"3.0.4","spec":"3.0.4","type":"version"},"_requiredBy":["/","/can-component","/can-connect","/can-stache-converters","/steal-stache"],"_resolved":"https://registry.npmjs.org/can-stache-bindings/-/can-stache-bindings-3.0.4.tgz","_shasum":"e7186039fcd4d82099b3484503270d43af8236e6","_shrinkwrap":null,"_spec":"can-stache-bindings@3.0.4","_where":"/Users/kevin/dev/canjs","author":{"name":"Bitovi","email":"contact@bitovi.com","url":"http://bitovi.com"},"bit-docs":{"dependencies":{"bit-docs-glob-finder":"^0.0.5","bit-docs-dev":"^0.0.3","bit-docs-js":"^0.0.3","bit-docs-generate-readme":"^0.0.8"},"glob":{"pattern":"**/*.{js,md}","ignore":"node_modules/**/*"},"readme":{"apis":"./docs/apis.json"},"parent":"can-stache-bindings"},"dependencies":{"can-compute":"^3.0.0","can-event":"^3.0.1","can-observation":"^3.0.1","can-stache":"^3.0.0-pre.24","can-util":"^3.0.1","can-view-callbacks":"^3.0.0","can-view-live":"^3.0.0","can-view-model":"^3.0.0","can-view-scope":"^3.0.0"},"description":"Default binding syntaxes for can-stache","devDependencies":{"bit-docs":"0.0.7","can-define":"^1.0.1","can-list":"^3.0.0-pre.1","can-map":"^3.0.0-pre.2","can-vdom":"3.0.0","can-view-nodelist":"^3.0.0-pre.2 ","done-serve":"^0.2.0","donejs-cli":"^0.9.5","generator-donejs":"^0.9.0","jshint":"^2.9.1","steal":"^0.16.0","steal-qunit":"^0.1.1","steal-tools":"^0.16.0","testee":"^0.2.4"},"directories":{},"dist":{"shasum":"e7186039fcd4d82099b3484503270d43af8236e6","tarball":"https://registry.npmjs.org/can-stache-bindings/-/can-stache-bindings-3.0.4.tgz"},"gitHead":"c6e3441f91763e092d6809ec1462f050c2bc99ad","homepage":"http://canjs.com","keywords":["canjs","donejs"],"main":"dist/cjs/can-stache-bindings","maintainers":[{"name":"daffl","email":"daff@neyeon.de"},{"name":"garrettreed","email":"garrett@garrettreed.co"},{"name":"justinbmeyer","email":"justin@bitovi.com"},{"name":"matthewp","email":"matthew@matthewphillips.info"},{"name":"phillipskevin","email":"kphillips86@gmail.com"}],"name":"can-stache-bindings","optionalDependencies":{},"readme":"ERROR: No README data found!","scripts":{"build":"node build.js","develop":"done-serve --static --develop --port 8080","document":"bit-docs","jshint":"jshint ./*.js --config","postversion":"git push --tags && git checkout master && git branch -D release && git push","preversion":"npm test && npm run build","release:major":"npm version major && npm publish","release:minor":"npm version minor && npm publish","release:patch":"npm version patch && npm publish","release:pre":"npm version prerelease && npm publish","test":"npm run jshint && npm run testee","testee":"testee test/test.html --browsers firefox","version":"git commit -am \"Update dist for release\" && git checkout -b release && git add -f dist/"},"system":{"main":"can-stache-bindings","npmAlgorithm":"flat"},"version":"3.0.4"},"comment":" ","pathToRoot":".."}; </script> </article> <footer><p>CanJS is part of <a href="http://donejs.com" target="_blank">DoneJS</a>. Created and maintained by the core <a href="https://donejs.com/About.html#section=section_Team" target="_blank">DoneJS team</a> and <a href="http://bitovi.com" target="_blank">Bitovi</a>. <strong>Currently 3.0.0.</strong></p></footer> </div> </div> </div> <script> steal = { instantiated: { "bundles/bit-docs-site/static.css!$css" : null } }; </script> <script type='text/javascript' data-main="bit-docs-site/static" src="./static/node_modules/steal/steal.production.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script> </body> </html>