can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - can-view-autorender</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-view-autorender.html">can-view-autorender</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-view-autorender</h1> <div>module</div> </div> <section class="description"> <p>A module that automatically renders script and other elements with the [can/view/autorender.can-autorender] attribute. This function is useful to know when the templates have finished rendering.</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/node_modules/can-view-autorender/can-view-autorender.md">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>autorender(success, error)</code> </h2> <p>Registers functions to callback when all templates successfully render or an error in rendering happens.</p> <div class="parameters"> <h3 class="parameters-title">Parameters</h3> <ol> <li><b>success</b> <code>{function}</code>: <p>A function to callback when all autorendered templates have been rendered successfully.</p> </li> <li><b>error</b> <code>{function}</code>: <p>A function to callback if a template was not rendered successfully.</p> </li> </ol> </div> </div> <section class="body"> <h2>Use</h2> <p>As long is this module is part of your CanJS build or imported with RequireJS, StealJS, or SystemJS, [can/view/autorender.can-autorender] will automatically look for <code>can-autorender</code> tags and render them. Once all templates have finished rendering, it will call any callbacks passed to <code>can.autorender()</code>.</p> <p>For example, you might have a page like:</p> <pre><code><body> <script type='text/stache' can-autorender id='main' message="Hello World"> <my-component> {{message}} </my-component> </script> <script src='jquery.js'></script>  <script src='can.custom.js'></script>  <script src='app.js'></script> <script> // Wait until everything has rendered. can.autorender(function(){ // Update the viewModel the template was rendred with: $("#main").viewModel().attr("message","Rendered!"); }) </script> </body> </code></pre> <h2>Rendered placement</h2> <p>If the template source is a <code><script></code> tag within the <code><body></code>, the rendered template is placed immediately following the template.</p> <p>For example:</p> <pre><code><body> <script type='text/stache' can-autorender message="Hi"> {{message}}! </script> <div>...</div> </body> </code></pre> <p>Becomes:</p> <pre><code><body> <script type='text/stache' can-autorender message="Hi"> {{message}}! </script> Hi! <div>...</div> </body> </code></pre> <p>If the <code><script></code> tag is outside the body, for example in the <code><head></code> tag, the rendered result will be placed just before the closing <code></body></code> tag.</p> <p>For example:</p> <pre><code><head> <script type='text/stache' can-autorender message="Hi"> {{message}}! </script> </head> <body> <div>...</div> </body> </code></pre> <p>Becomes:</p> <pre><code><head> <script type='text/stache' can-autorender message="Hi"> {{message}}! </script> </head> <body> <div>...</div> Hi! </body> </code></pre> <p>If the template source is any other element, the element's contents will be replaced with the rendered result. For example:</p> <pre><code><body> <div type='text/stache' can-autorender message="Hi"> {{message}}! </div> </body> </code></pre> <p>Becomes:</p> <pre><code><body> <div type='text/stache' can-autorender message="Hi"> Hi! </div> </body> </code></pre> <h2>Scope</h2> <p>The template is rendered with a [can.Map] made from the attributes of the template source element. That <code>map</code> is available on the template source element via [can.viewModel]. You can change the map at any time:</p> <pre><code><body> <script type='text/stache' can-autorender id='main'> {{message}}! </script> <script> var viewModel = can.viewModel(document.getElementById("main")); viewModel.attr("message","Hello There!"); </script> </body> </code></pre> <p>You can change attributes on the element and it will update the viewModel too:</p> <pre><code><body> <script type='text/stache' can-autorender id='main'> {{message}}! </script> <script> var main = document.getElementById("main"); main.setAttribute("message","Hello There!"); </script> </body> </code></pre> <h2>StealJS Use</h2> <p>For demo pages that require very little setup:</p> <pre><code><body> <script type='text/stache'> <can-import from="components/my-component"/> <my-component> {{message}} </my-component> </script> <script src='../node_modules/steal/steal.js' main='can/view/autorender/'> </script> </body> </code></pre> <p>For demo pages that require a little custom setup:</p> <pre><code><body> <script type='text/stache' can-autorender> <can-import from="components/my-component"/> <my-component> {{message}} </my-component> </script> <script src='../node_modules/steal/steal.js' main='@empty'> </script> <script> steal('can','jquery','can/view/autorender/', function(can, $){ $("my-component").viewModel().attr("message", "Hi"); }); </script> </body> </code></pre> <h2>Errors</h2> <p>Error callbacks will be called if a template has a parsing error or a [can/view/stache/system.import] fails.</p> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-view-autorender/can-view-autorender.md"},"description":"\nA module that automatically renders script and other elements with \nthe [can/view/autorender.can-autorender] attribute. This function is useful to know when the templates have finished rendering.\n","type":"module","title":"can-view-autorender","types":[{"type":"function","returns":{"types":[{"type":"undefined"}]},"params":[]}],"name":"can-view-autorender","signatures":[{"code":"autorender(success, error)","description":"\n\n Registers functions to callback when all templates successfully render or an error in rendering happens.\n","params":[{"types":[{"type":"function","returns":{"types":[{"type":"undefined"}]},"params":[]}],"name":"success","description":"A function to callback when all autorendered templates have been rendered\nsuccessfully.\n"},{"types":[{"type":"function","returns":{"types":[{"type":"undefined"}]},"params":[]}],"optional":true,"name":"error","description":"A function to callback if a template was not rendered successfully.\n"}]}],"_curParam":{"types":[{"type":"function","returns":{"types":[{"type":"undefined"}]},"params":[]}],"optional":true,"name":"error","description":"A function to callback if a template was not rendered successfully.\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>