can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - view</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=" parent expanded"> <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> <ul> <li> <span>static</span> <ul> <li class=" "> <a class="function" href="can-component.extend.html" title="Define the behavior of a custom element."> extend </a> </li> </ul> </li> <li> <span>prototype</span> <ul> <li class=" "> <a class="property" href="can-component.prototype.ViewModel.html" title="Provides or describes a constructor function that provides values and methods to the component's template. The constructor function is initialized with values specified by the component element's data bindings."> ViewModel </a> </li> <li class=" "> <a class="property" href="can-component.prototype.events.html" title="Listen to events on elements and observables."> events </a> </li> <li class=" "> <a class="property" href="can-component.prototype.helpers.html" title="Helper functions used with the component's template."> helpers </a> </li> <li class=" "> <a class="property" href="can-component.prototype.leakScope.html" title="Allow reading the outer scope values from a component's template and a component's viewModel values in the user content."> leakScope </a> </li> <li class=" "> <a class="property" href="can-component.prototype.tag.html" title="Specifies the HTML tag (or node-name) the can-component will be created on."> tag </a> </li> <li class="current parent expanded"> <a class="property" href="can-component.prototype.view.html" title="Provides a template to render directly within the component's element. The template is rendered with the component's can-component::ViewModel instance. <content/> elements within the template are replaced by the source elements within the component's tag."> view </a> </li> <li class=" "> <a class="function" href="can-component.prototype.view-model.html" title="Return the view model instance or type with which the component's can-component.prototype.view is rendered. This is used when more fine grained control is needed over can-component::ViewModel."> viewModel </a> </li> </ul> </li> <li> <span>elements</span> <ul> <li class=" "> <a class="typedef" href="can-component/content.html" title="Positions the LIGHT_DOM within a component's can-component.prototype.template."> <content> </a> </li> </ul> </li> <li> <span>special events</span> <ul> <li class=" "> <a class="typedef" href="can-component/beforeremove.html" title="An event called only on component's elements before they are removed from the document if live binding is performing the removal. It can be listened to within a component's can-component.prototype.events object or on a component element with can-stache-bindings.event bindings. This is an additional special event only on component elements. inserted and removed events are available on all elements."> beforeremove </a> </li> </ul> </li> </ul> </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=" "> <a class="module" href="can-stache-bindings.html" title="Provides template event, one-way, and two-way bindings."> can-stache-bindings </a> </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-component.html">can-component</a></li> / <li><a href="can-component.prototype.view.html">view</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>view</h1> <div>property</div> </div> <section class="description"> <p>Provides a template to render directly within the component's element. The template is rendered with the component's <a href="can-component.prototype.ViewModel.html" title="Provides or describes a constructor function that provides values and methods to the component's template. The constructor function is initialized with values specified by the component element's data bindings.">ViewModel</a> instance. <code><content/></code> elements within the template are replaced by the source elements within the component's tag.</p> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-links">  <li><a href="//github.com/canjs/can-component/tree/v3.0.2/docs/view.md">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code><a href="can-stache.renderer.html" title="A function returned by can-stache that renders a template into an html documentFragment.">renderer</a>(data, helpers, <a href="can-view-nodelist/types/NodeList.html" title="A collection of nodes being managed by a part of a live-bound template and references to other collections.">nodeList</a>)</code> </h2> <p>A <a href="can-stache.renderer.html" title="A function returned by can-stache that renders a template into an html documentFragment.">renderer</a> returned by <a href="can-stache.html" title="Live binding Mustache and Handlebars-compatible templates.">can-stache</a>. For example:</p> <pre><code>Component({ tag: "my-tabs", view: stache("<ul>{{#panels}}<li>{{title}}</li> ...") }); </code></pre> </div> <section class="body"> <h2>Use</h2> <p>The template specified by the <code>view</code> property works similar to the <a href="http://www.w3.org/TR/shadow-dom/" title="W3C Shadow DOM proposal">W3C Shadow DOM proposal</a>. It represents the contents of a custom element, while being able to reposition the user provided <strong>source</strong> elements with the <a href="can-component/content.html" title="Positions the LIGHT_DOM within a component's can-component.prototype.template."><content></a> tag.</p> <p>There are three things to understand about a <a href="can-component.html" title="Create a custom element that can be used to manage widgets or application logic.">can-component</a>'s template:</p> <ul> <li>It is inserted into the component's tag.</li> <li>It is rendered with access to the component instance's viewModel.</li> <li><a href="can-component/content.html" title="Positions the LIGHT_DOM within a component's can-component.prototype.template."><content></a> tags within the template act as insertion points for the source elements.</li> </ul> <p>The following example demonstrates all three features:</p> <div class='demo_wrapper' data-demo-src='demos/can-component/my_greeting_full.html'></div> <p>The following explains how each part works:</p> <p><strong>Component:</strong></p> <pre><code class="language-js">Component({ tag: "my-greeting", view: stache("<h1><content/> - {{title}}</h1>"), ViewModel: DefineMap.extend({ title: { value: "can-component" } }) }); </code></pre> <p>This registers a component for elements like <code><my-greeting></code>. Its template will place an <code><h1></code> element directly within <code><my-greeting></code> and put the original contents of <code><my-greeting></code> within the beginning of <code><h1></code>. The component's <a href="can-component.prototype.ViewModel.html" title="Provides or describes a constructor function that provides values and methods to the component's template. The constructor function is initialized with values specified by the component element's data bindings.">ViewModel</a> adds a title value.</p> <p><strong>Source template:</strong></p> <pre><code class="language-html"><header> <my-greeting> {{site}} </my-greeting> </header> </code></pre> <p>The source template is the template that uses <code><my-greeting></code>. In the demo, this is defined within a <code><script></code> tag.</p> <p>Notice:</p> <ul> <li>There is content within <code><my-greeting></code>. This is called the <strong>light</strong> or <strong>user</strong> content.</li> <li>The content looks for a <code>site</code> value.</li> </ul> <p><strong>Source data:</strong></p> <pre><code> stache("...")({ site: "CanJS" }) </code></pre> <p>This is how we render the source template that uses <code><my-greeting></code>. The template is rendered with <code>site</code> in its <a href="can-component.prototype.ViewModel.html" title="Provides or describes a constructor function that provides values and methods to the component's template. The constructor function is initialized with values specified by the component element's data bindings.">ViewModel</a>.</p> <p><strong>HTML Result:</strong></p> <pre><code><header> <my-greeting> <h1>CanJS - can-component</h1> </my-greeting> </header> </code></pre> <p>This is the result of the template transformations. The <strong>user</strong> content within the original <code><my-greeting></code> is placed within the start of the <code><h1></code> tag. Also, notice that the <strong>user</strong> content is able to access data from the source data.</p> <p>The following sections break this down more.</p> <h2>Template insertion</h2> <p>The template specified by <code>view</code> is rendered directly within the custom tag.</p> <p>For example the following component:</p> <pre><code>Component({ tag: "my-greeting", view: stache("<h1>Hello There</h1>") }); </code></pre> <p>With the following source html:</p> <pre><code><header> <my-greeting></my-greeting> </header> </code></pre> <p>Produces the following html:</p> <pre><code><header> <my-greeting><h1>Hello There</h1></my-greeting> </header> </code></pre> <p>However, if there was existing content within the source html, like:</p> <pre><code><header> <my-greeting>DO REMOVE ME!!!</my-greeting> </header> </code></pre> <p>that content is removed, and replaced by the component's template:</p> <pre><code><header> <my-greeting><h1>Hello There</h1></my-greeting> </header> </code></pre> <h3>The <code><content></code> element</h3> <p>Use the <code><content></code> element to place the source content in the component's element within the component's template. For example, if we change the component to look like:</p> <pre><code>Component({ tag: "my-greeting", view: stache("<h1><content/></h1>") }); </code></pre> <p>and rendered with source html, like:</p> <pre><code><my-greeting>Hello World</my-greeting> </code></pre> <p>it produces:</p> <pre><code><my-greeting><h1>Hello World</h1></my-greeting> </code></pre> <h3><code><content></code> element default content</h3> <p>If the user does not provide source content, the html between the <code><content></code> tags will be used. For example, if we change the component to look like:</p> <pre><code>Component({ tag: "my-greeting", view: stache("<h1><content>Hello World</content></h1>") }); </code></pre> <p>and rendered with source html like:</p> <pre><code><my-greeting></my-greeting> </code></pre> <p>it produces:</p> <pre><code><my-greeting><h1>Hello World</h1></my-greeting> </code></pre> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-component/docs/view.md"},"description":"\nProvides a template to render directly within the component's element. The template is rendered with the\ncomponent's [can-component::ViewModel] instance. `<content/>` elements within the template are replaced by the source elements within the component's tag.\n","types":[{"type":"can-stache.renderer","description":"A [can-stache.renderer] returned by [can-stache]. For example:\n\n Component({\n tag: \"my-tabs\",\n view: stache(\"<ul>{{#panels}}<li>{{title}}</li> ...\")\n });\n\n"}],"title":"view","name":"can-component.prototype.view","type":"property","parent":"can-component.prototype","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>