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> <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=" "> <a class="page" href="can-core.html" title="The best, most hardened and generally useful libraries in CanJS."> Core </a> </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=" parent expanded"> <a class="page" href="can-infrastructure.html" title="Utility libraries that power the core and ecosystem collection."> Infrastructure </a> <ul> <li class=" "> <a class="module" href="can-construct.html" title="Provides a way to easily use the power of prototypal inheritance without worrying about hooking up all the particulars yourself. Use can-construct.extend to create an inheritable constructor function of your own."> can-construct </a> </li> <li class=" "> <a class="module" href="can-control.html" title="Create organized, memory-leak free, rapidly performing, stateful controls with declarative event binding. Use Control to create UI controls like tabs, grids, and context menus, and organize them into higher-order business rules with can.route. It can serve as both a traditional view and a traditional controller."> can-control </a> </li> <li class="current parent expanded"> <a class="module" href="can-event.html" title="Add event functionality into your objects. The canEvent object provides a number of methods for handling events in objects. This functionality is best used by mixing the canEvent object into an object or prototype. However, event listeners can still be used even on objects that don't include canEvent. All methods provided by canEvent assume that they are mixed into an object -- this should be the object dispatching the events."> can-event </a> <ul> <li> <span>static</span> <ul> <li class=" "> <a class="function" href="can-event.addEventListener.html" title="can-event.addEventListener"> addEventListener </a> </li> <li class=" "> <a class="function" href="can-event.bind.html" title="can-event.bind"> bind </a> </li> <li class=" "> <a class="function" href="can-event.delegate.html" title="can-event.delegate"> delegate </a> </li> <li class=" "> <a class="function" href="can-event.dispatch.html" title="can-event.dispatch"> dispatch </a> </li> <li class=" "> <a class="function" href="can-event.listenTo.html" title="can-event.listenTo"> listenTo </a> </li> <li class=" "> <a class="function" href="can-event.off.html" title="can-event.off"> off </a> </li> <li class=" "> <a class="function" href="can-event.on.html" title="can-event.on"> on </a> </li> <li class=" "> <a class="function" href="can-event.one.html" title="can-event.one"> one </a> </li> <li class=" "> <a class="function" href="can-event.removeEventListener.html" title="can-event.removeEventListener"> removeEventListener </a> </li> <li class=" "> <a class="function" href="can-event.stopListening.html" title="can-event.stopListening"> stopListening </a> </li> <li class=" "> <a class="function" href="can-event.trigger.html" title="can-event.trigger"> trigger </a> </li> <li class=" "> <a class="function" href="can-event.unbind.html" title="can-event.unbind"> unbind </a> </li> <li class=" "> <a class="function" href="can-event.undelegate.html" title="can-event.undelegate"> undelegate </a> </li> </ul> </li> </ul> </li> <li class=" "> <a class="module" href="can-event/async/async.html" title="Makes the event system asynchronous. WARNING: This is experimental technology."> can-event/async/async </a> </li> <li class=" "> <a class="module" href="can-event/batch/batch.html" title="Adds task batching abilities to event dispatching."> can-event/batch/batch </a> </li> <li class=" "> <a class="module" href="can-observation.html" title="Provides a mechanism to notify when an observable has been read and a way to observe those reads called within a given function."> can-observation </a> </li> <li class=" "> <a class="module" href="can-simple-map.html" title="A performant live-bound map."> can-simple-map </a> </li> <li class=" "> <a class="page" href="can-util.html" title="A set of utilities."> can-util </a> </li> <li class=" "> <a class="module" href="can-view-callbacks.html" title="Registered callbacks for behaviors"> can-view-callbacks </a> </li> <li class=" "> <a class="module" href="can-view-live.html" title="Setup live-binding between the DOM and a compute manually."> can-view-live </a> </li> <li class=" "> <a class="module" href="can-view-model.html" title="Gets the ViewModel of an element."> can-view-model </a> </li> <li class=" "> <a class="module" href="can-view-nodelist.html" title="Adds nesting of text nodes can.view.nodeLists are used to make sure "directly nested" live-binding sections update content correctly. Consider the following template: <div> {{#if items.length}} Items: {{#items}} <label></label> {{/items}} {{/if}} </div> The {{#if}} and {{#items}} seconds are "directly nested" because they share the same <div> parent element. If {{#items}} changes the DOM by adding more <labels>, {{#if}} needs to know about the <labels> to remove them if {{#if}} is re-rendered. {{#if}} would be re-rendered, for example, if all items were removed."> can-view-nodelist </a> </li> <li class=" "> <a class="module" href="can-view-parser.html" title="Parse HTML and mustache tokens."> can-view-parser </a> </li> <li class=" "> <a class="module" href="can-view-scope.html" title="Create a lookup node for keys."> can-view-scope </a> </li> <li class=" "> <a class="module" href="can-view-target.html" title=""> can-view-target </a> </li> </ul> </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-infrastructure.html">Infrastructure</a></li> / <li><a href="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>module</div> </div> <section class="description"> <p>Add event functionality into your objects.</p> <p>The <code>canEvent</code> object provides a number of methods for handling events in objects. This functionality is best used by mixing the <code>canEvent</code> object into an object or prototype. However, event listeners can still be used even on objects that don't include <code>canEvent</code>.</p> <p>All methods provided by <code>canEvent</code> assume that they are mixed into an object -- <code>this</code> should be the object dispatching the events.</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-event"> <img src="https://img.shields.io/badge/npm%20package-3.0.1-brightgreen.svg" alt="npm package badge" /> </a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/can-event" data-count-href="/canjs/can-event/stargazers" data-count-api="/repos/canjs/can-event#stargazers_count">Star</a> </li> </ul> <ul class="title-links">  <li><a href="//github.com/canjs/can-event/tree/v3.0.1/can-event.md">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>assign(YourClass.prototype, canEvent)</code> </h2> <p>Adds event functionality to <code>YourClass</code> objects. This can also be applied to normal objects: <code>assign(someObject, canEvent)</code>.</p> <p>The <code>assign</code> function can be any function that assigns additional properties on an object such as <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign">Object.assign</a> or lodash's <a href="https://lodash.com/docs#assign">_.assign</a> or <a href="can-util/js/assign/assign.html" title="can-util/js/assign/assign">assign</a>.</p> <pre><code class="language-js">var assign = require("can-util/js/assign/assign"); var canEvent = require("can-event"); function Thing(){ } assign(Thing.prototype, canEvent); var thing = new Thing(); thing.addEventListener("prop", function(){ ... }); </code></pre> </div> <section class="body"> <h2>Using as a mixin</h2> <p>The easiest way to add events to your classes and objects is by mixing <a href="can-event.html" title="Add event functionality into your objects. The canEvent object provides a number of methods for handling events in objects. This functionality is best used by mixing the canEvent object into an object or prototype. However, event listeners can still be used even on objects that don't include canEvent. All methods provided by canEvent assume that they are mixed into an object -- this should be the object dispatching the events.">can-event</a> into your object or prototype.</p> <pre><code>var SomeClass = Construct("SomeClass", { init: function() { this.value = 0; }, increment: function() { this.value++; this.dispatch("change", [this.value]); } }); Object.assign(SomeClass.prototype, canEvent); </code></pre> <p>Now that <code>canEvent</code> is included in the prototype, we can add/remove/dispatch events on the object instances.</p> <pre><code>var instance = new SomeClass(); instance.on("change", function(ev, value) { alert("The instance changed to " + value); }); // This will dispatch the "change" event and show the alert instance.increment(); </code></pre> <h2>Using without mixing in</h2> <p>The same event functionality from <code>canEvent</code> can be used, even if the given object doesn't include <code>canEvent</code>. Every method within <code>canEvent</code> supports being called with an alternate scope.</p> <pre><code>var obj = {}; canEvent.addEventListener.call(obj, "change", function() { alert("object change!"); }); // This will dispatch the "change" event and show the alert canEvent.dispatch.call(obj, "change"); </code></pre> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-event/can-event.md"},"description":" \nAdd event functionality into your objects.\n\nThe `canEvent` object provides a number of methods for handling events in objects. This functionality is best used by mixing the `canEvent` object into an object or prototype. However, event listeners can still be used even on objects that don't include `canEvent`.\n\nAll methods provided by `canEvent` assume that they are mixed into an object -- `this` should be the object dispatching the events.\n\n","type":"module","title":"","types":[{"type":"Object","options":[]}],"name":"can-event","parent":"can-infrastructure","test":"can/event/test.html","link":"../docco/event.html docco","release":"2.1","package":{"_args":[[{"raw":"can-event@3.0.1","scope":null,"escapedName":"can-event","name":"can-event","rawSpec":"3.0.1","spec":"3.0.1","type":"version"},"/Users/kevin/dev/canjs"]],"_from":"can-event@3.0.1","_id":"can-event@3.0.1","_inCache":true,"_location":"/can-event","_nodeVersion":"6.7.0","_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/can-event-3.0.1.tgz_1476483787975_0.032792590791359544"},"_npmUser":{"name":"daffl","email":"daff@neyeon.de"},"_npmVersion":"3.10.3","_phantomChildren":{},"_requested":{"raw":"can-event@3.0.1","scope":null,"escapedName":"can-event","name":"can-event","rawSpec":"3.0.1","spec":"3.0.1","type":"version"},"_requiredBy":["/","/can-compute","/can-connect","/can-control","/can-define","/can-define-stream/can-stream","/can-jquery","/can-legacy-view-helpers","/can-list","/can-map","/can-map-define","/can-observation","/can-route","/can-route-pushstate","/can-simple-map","/can-stache-bindings","/can-stream","/can-view-autorender","/can-view-import","/can-view-live"],"_resolved":"https://registry.npmjs.org/can-event/-/can-event-3.0.1.tgz","_shasum":"055ca10314d49c73d1f67274766b1ea0ea1613b8","_shrinkwrap":null,"_spec":"can-event@3.0.1","_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-event"},"bugs":{"url":"https://github.com/canjs/can-event/issues"},"dependencies":{"can-util":"^3.0.1"},"description":"[![Build Status](https://travis-ci.org/canjs/can-event.png?branch=master)](https://travis-ci.org/canjs/can-event)","devDependencies":{"bit-docs":"0.0.6","done-serve":"^0.2.4","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.3.0-pre.0"},"directories":{},"dist":{"shasum":"055ca10314d49c73d1f67274766b1ea0ea1613b8","tarball":"https://registry.npmjs.org/can-event/-/can-event-3.0.1.tgz"},"gitHead":"057e0cf1d927cc41449ba8ec4b9ef7f30a34a5c8","homepage":"http://canjs.com","keywords":["canjs","canjs-plugin","donejs"],"main":"can-event","maintainers":[{"name":"daffl","email":"daff@neyeon.de"},{"name":"justinbmeyer","email":"justin@bitovi.com"},{"name":"matthewp","email":"matthew@matthewphillips.info"},{"name":"sinjhin","email":"john@ardea.io"}],"name":"can-event","optionalDependencies":{},"readme":"ERROR: No README data found!","repository":{"type":"git","url":"git://github.com/canjs/can-event.git"},"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.html --browsers firefox","version":"git commit -am \"Update dist for release\" && git checkout -b release && git add -f dist/"},"system":{"npmAlgorithm":"flat"},"version":"3.0.1"},"signatures":[{"code":"assign(YourClass.prototype, canEvent)","description":"\n\nAdds event functionality to `YourClass` objects. This can also be applied to normal objects: `assign(someObject, canEvent)`.\n\nThe `assign` function can be any function that assigns additional properties on an object such as [Object.assign](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) or lodash's [_.assign](https://lodash.com/docs#assign) or [can-util/js/assign/assign].\n\n```js\nvar assign = require(\"can-util/js/assign/assign\");\nvar canEvent = require(\"can-event\");\n\nfunction Thing(){\n\n}\n\nassign(Thing.prototype, canEvent);\n\nvar thing = new Thing();\nthing.addEventListener(\"prop\", function(){ ... });\n```\n","params":[]}],"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>