can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - can-EVENT</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> </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="can-stache-bindings.can-EVENT.html">can-EVENT</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-EVENT</h1> <div>function</div> </div> <section class="description"> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-links">  <li><a href="//github.com/canjs/canjs/tree/v3.0.0/node_modules/can-stache-bindings/docs/can-event.md">source</a></li>   </ul> </section> <section class='warnings'> <div class='deprecated warning'> <h3>Deprecated 2.2</h3> <div class='signature-wrapper'> <p>Use [can.view.bindings.event event binding] (<code>($EVENT)="METHOD()"</code>) instead.</p> </div> </div> </section> <div class="signature"> <h2 class="signature-title"> <code>(EVENT)='{methodKey [argKey..] [hashName=hashKey...]}'</code> </h2> <p>Specify a callback function to be called on a particular event. This is a shorthand for <code>can-EVENT</code> attributes.</p> </div> <div class="signature"> <h2 class="signature-title"> <code>can-EVENT='{methodKey [argKey..] [hashName=hashKey...]}'</code> </h2> <p>Specify a callback function to be called on a particular event. You can create your own special event types.</p> <div class="parameters"> <h3 class="parameters-title">Parameters</h3> <ol> <li><b>EVENT</b> <code>{String}</code>: <p>A event name like <code>click</code> or <code>keyup</code>. If you are using jQuery, you can listen to jQuery special events too.</p> </li> <li><b>methodKey</b> <code>{<a href="can-stache.key.html" title="A named reference to a value in the scope or helper scope in a template.">key</a>}</code>: <p>A named key value in the current scope. The value should be a function.</p> </li> <li><b>argKey</b> <code>{<a href="can-stache.key.html" title="A named reference to a value in the scope or helper scope in a template.">key</a>}</code>: <p>Key values that will be passed as arguments to the <code>methodKey</code> function value. Key values can be read from the scope, or literals like <code>"foo"</code>, <code>1</code>, etc.</p> <p>The following key values are also supported:</p> <ul> <li><code>@element</code> - The element the event happened upon.</li> <li><code>@event</code> - The event object.</li> <li><code>@viewModel</code> - If the element is a <a href="can-component.html" title="Create a custom element that can be used to manage widgets or application logic.">can-component</a>, the component's [can-component::viewModel viewModel].</li> <li><code>@context</code> - The current context.</li> <li><code>@scope</code> - The current <a href="can-view-scope.html" title="Create a lookup node for keys.">Scope</a>.</li> </ul> <p>If no <code>argKey</code>s or <code>hashKey</code>s are provided, the methodKey will be called with the <code>@context</code>, <code>@element</code> and <code>@event</code> as arguments.</p> </li> <li><b>hashName</b> <code>{String}</code>: <p>A property name that gets added to the <code>hash</code> argument. The hash argument is the last value passed to the function specified by <code>methodKey</code>.</p> </li> <li><b>hashKey</b> <code>{<a href="can-stache.key.html" title="A named reference to a value in the scope or helper scope in a template.">key</a>}</code>: <p>Specifies value that is added to the <code>hash</code> argument for a <code>hashName</code> value. <code>hashKey</code> supports the same key values as <code>argKey</code>.</p> </li> </ol> </div> </div> <section class="body"> <h2>Use</h2> <p>By adding <code>can-EVENT='methodKey'</code> to an element, the function pointed to by <code>methodKey</code> is bound to the element's <code>EVENT</code> event. The function can be passed any number of arguments from the surrounding scope, or <code>name=value</code> attributes for named arguments. Direct arguments will be provided to the handler in the order they were given, except <code>name=value</code> arguments, which will all be given as part of a <code>hash</code> argument inserted after all direct arguments.</p> <p>If no <code>argKey</code>s or <code>hashKey</code>s are provided, the methodKey will be called with the <code>@content</code>, <code>@element</code> and <code>@event</code> as arguments.</p> <p>The following uses <code>can-click={items.splice @index 1}</code> to remove a item from <code>items</code> when that item is clicked on.</p> <div class='demo_wrapper' data-demo-src='can/view/bindings/doc/can-event-args.html'></div> <h2>Special Event Types</h2> <p>can.view.bindings supports creating special event types (events that aren't natively triggered by the DOM), which are bound by adding attributes like <code>can-SPECIAL='KEY'</code>. This is similar to <a href="http://benalman.com/news/2010/03/jquery-special-events/">$.special</a>.</p> <h3>can-enter / (enter)</h3> <p>can-enter is a special event that calls its handler whenever the enter key is pressed while focused on the current element. For example:</p> <pre><code><input type='text' can-enter='{save}' /> </code></pre> <p>The above template snippet would cause the save method (in the [can.mustache Mustache] <a href="can-view-scope.html" title="Create a lookup node for keys.">scope</a>) whenever the user hits the enter key on this input.</p> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-stache-bindings/docs/can-event.md"},"description":"\n","title":"can-EVENT","name":"can-stache-bindings.can-EVENT","type":"function","deprecated":[{"version":"2.2","description":"Use [can.view.bindings.event event binding] (`($EVENT)=\"METHOD()\"`) instead.\n"}],"signatures":[{"code":"(EVENT)='{methodKey [argKey..] [hashName=hashKey...]}'","description":"\n\nSpecify a callback function to be called on a particular event. This is a shorthand for `can-EVENT` attributes.\n","params":[]},{"code":"can-EVENT='{methodKey [argKey..] [hashName=hashKey...]}'","description":"\n\nSpecify a callback function to be called on a particular event. You can create your own special event types.\n","params":[{"types":[{"type":"String"}],"name":"EVENT","description":"A event name like `click` or `keyup`. If you are\nusing jQuery, you can listen to jQuery special events too.\n"},{"types":[{"type":"can-stache.key"}],"name":"methodKey","description":"A named key value in the current scope. The value\nshould be a function.\n"},{"types":[{"type":"can-stache.key"}],"optional":true,"name":"argKey","variable":true,"description":"Key values that will be passed as\narguments to the `methodKey` function value. Key values can \nbe read from the scope, or literals like `\"foo\"`, `1`, etc.\n\nThe following key values are also supported:\n\n - `@element` - The element the event happened upon.\n - `@event` - The event object.\n - `@viewModel` - If the element is a [can-component], the component's [can-component::viewModel viewModel].\n - `@context` - The current context.\n - `@scope` - The current [can-view-scope Scope].\n\nIf no `argKey`s or `hashKey`s are provided, the methodKey will be called with the\n`@context`, `@element` and `@event` as arguments.\n"},{"types":[{"type":"String"}],"name":"hashName","description":"A property name \nthat gets added to the `hash` argument. The hash argument is the\nlast value passed to the function specified by `methodKey`.\n"},{"types":[{"type":"can-stache.key"}],"name":"hashKey","description":"Specifies value that is added \nto the `hash` argument for a `hashName` value. `hashKey` supports\nthe same key values as `argKey`.\n"}]}],"_curParam":{"types":[{"type":"can-stache.key"}],"name":"hashKey","description":"Specifies value that is added \nto the `hash` argument for a `hashName` value. `hashKey` supports\nthe same key values as `argKey`.\n"},"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>