can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - Routing</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="Routing.html">Routing</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>Routing</h1> <div>page</div> </div> <section class="description"> <p><a href="../docs/can.route.html">can.route</a> is the core of CanJS's routing functionality. It is a special Observe that updates <code>window.location.hash</code> when its properties change and updates its properties when <code>window.location.hash</code> changes. You can give <code>can.route</code> a template to translate URLs into property values, but if no route is provided, it just serializes the route into standard URL-encoded notation.</p> </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/docs/can-guides/route.md">source</a></li>   </ul> </section> <section class="body"> <p>Here is how you might use <code>can.route</code> without a template:</p> <pre><code>// Before we start, empty the hash. window.location.hash = ''; // This means that can.route is empty. can.route.attr(); // {} // Set the hash... window.location.hash = '#!id=7'; // ...and can.route reflects that. can.route.attr(); // {id: 7} // Set the route... can.route.attr({type: 'todos'}, true); // ...and the hash reflects that. window.location.hash; // #!type=todos // Set a new property on the route... can.route.attr('id', 6); // ...and the has changes again to reflect multiple properties. window.location.hash; // #!type=todos&id=6 </code></pre> <p>If you give <code>can.route</code> a template, you can make pretty URLs:</p> <pre><code>// Give can.route a template. can.route(':type/:id'); // If you set a hash that looks like the route... window.location.hash = '#!todos/5'; // ... the route data changes accordingly. can.route.attr(); // {type: 'todos', id: 5} // If the route data is changed... can.route.attr({type: 'users', id: 29}); // ...the hash is changed using the template. window.location.hash; // '#!users/7' // You can also supply defaults for routes. can.route('', {type: 'recipe'}); // Then if you change the hash... window.location.hash = ''; // ...the route data reflects the defaults. can.route.attr(); // {type: 'recipe'} </code></pre> <h2>Listening to events</h2> <p>Because <code>can.route</code> is an Observe, you can bind to it just like normal Observes:</p> <pre><code>can.route.bind('id', function(ev, newVal, oldVal) { console.log('The hash\'s id changed.'); }); </code></pre> <p>You can listen to routing events in Controls with the <em>route</em> event:</p> <pre><code>var Routing = can.Control({ 'route': function() { // Matches every routing change, but gets passed no data. }, 'todos/:id route': function(data) { // Matches routes like #!todos/5, // and will get passed {id: 5} as data. }, ':type/:id route': function(data) { // Matches routes like #!recipes/5, // and will get passed {id: 5, type: 'recipes'} as data. } }) </code></pre> <h2>Making URLs and links</h2> <p><code>can.route.url</code> takes a set of properties and makes a URL according to <code>can.route</code>'s current route.</p> <pre><code>can.route(':type/:id', {type: 'todos'}); can.route.url({id: 7}); // #!todos/7 </code></pre> <p><code>can.route.link</code> does the same thing as <code>can.route.url</code>, but it returns an anchor element (in string form) ready to be inserted into HTML. You can also specify extra propertires to be set on the element.</p> <pre><code>var a = can.route.link( 'Todo 5', {id: 7}, {className: 'button'} ); a; // <a href="#!todos/7" class="button">Todo 5</a> </code></pre> </section> <script type="text/javascript"> var docObject = {"src":{"path":"docs/can-guides/route.md"},"description":"\n[can.route](../docs/can.route.html) is the core of CanJS's routing functionality. It is a special\nObserve that updates `window.location.hash` when its properties change and\nupdates its properties when `window.location.hash` changes. You can give\n`can.route` a template to translate URLs into property values, but if no route\nis provided, it just serializes the route into standard URL-encoded notation.\n","name":"Routing","title":"Routing","type":"page","parent":"Tutorial","order":9,"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>