UNPKG

can

Version:

MIT-licensed, client-side, JavaScript framework that makes building rich web applications easy.

698 lines (445 loc) 22.2 kB
<!DOCTYPE html> <!--#################################################################### THIS IS A GENERATED FILE -- ANY CHANGES MADE WILL BE OVERWRITTEN INSTEAD CHANGE: source: [object Object] @module can-view-import ######################################################################## --> <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - can-view-import</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> &nbsp; </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=" parent expanded"> <a class="page" href="can-ecosystem.html" title="Useful libraries that extend or add important features to the core collection."> Ecosystem </a> <ul> <li class=" "> <a class="module" href="can-construct-super.html" title="can.Construct.super is a plugin that makes it easier to call base functions from inside inheriting functions."> can-construct-super </a> </li> <li class=" "> <a class="module" href="can-define-stream.html" title="Define property values using streams. can-stream is used internally to provide the stream functionality."> can-define-stream </a> </li> <li class=" "> <a class="module" href="can-fixture.html" title="can-fixture intercepts an AJAX request and simulates the response with a file or function."> can-fixture </a> </li> <li class=" "> <a class="module" href="can-fixture-socket.html" title="Simulate socket.io services."> can-fixture-socket </a> </li> <li class=" "> <a class="module" href="can-jquery.html" title="Extensions to the event system so that can events and jQuery events are cross-bound. Importing can-jquery will return the jQuery object and wire up the event system. var $ = require(&quot;can-jquery&quot;); var div = $(&quot;&lt;div&gt;&quot;); div.on(&quot;inserted&quot;, function(){ // it inserted! }); $(&quot;body&quot;).append(div);"> can-jquery </a> </li> <li class=" "> <a class="module" href="can-stache-converters.html" title="Provides a set of converters useful for two-way binding with form elements such as &lt;input&gt; and &lt;select&gt;."> can-stache-converters </a> </li> <li class=" "> <a class="module" href="can-stream.html" title="Convert observable values into streams. Kefir is used internally to provide the stream functionality."> can-stream </a> </li> <li class=" "> <a class="module" href="can-vdom.html" title="A browser-lite environment for Node.js or a worker thread."> can-vdom </a> </li> <li class="current parent expanded"> <a class="module" href="can-view-import.html" title=""> can-view-import </a> <ul> <li> <span>Pages</span> <ul> <li class=" "> <a class="page" href="can-view-import.pages.dynamic.html" title="Dynamic imports are used in conditional situations such as within a can-stache.helpers.if, to prevent unnecessarily fetching resources that might not be needed in all cases."> Dynamic Imports </a> </li> <li class=" "> <a class="page" href="can-view-import.pages.static.html" title="Static imports reflect direct dependencies of this template. Most uses of can-view-import will be to static imports."> Static Imports </a> </li> </ul> </li> <li> <span>Attributes</span> <ul> <li class=" "> <a class="function" href="can-view-import.can-tag.html" title="Use another can-view-callbacks.tag (such as a can-component) to control the &lt;content&gt; of a can-view-import."> can-tag </a> </li> <li class=" "> <a class="function" href="can-view-import.from.html" title="Set the module name that will be imported into the template."> from </a> </li> <li class=" "> <a class="function" href="can-view-import.value.html" title="Set the value that is returned from the can-import Promise to a reference scope variable."> {^value} </a> </li> </ul> </li> </ul> </li> <li class=" "> <a class="module" href="can-zone.html" title=""> can-zone </a> </li> <li class=" "> <a class="module" href="steal-stache.html" title="A StealJS extension that allows stache templates as dependencies."> steal-stache </a> </li> </ul> </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-ecosystem.html">Ecosystem</a></li> / <li><a href="can-view-import.html">can-view-import</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-import</h1> <div>module</div> </div> <section class="description"> </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-view-import"> <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-view-import" data-count-href="/canjs/can-view-import/stargazers" data-count-api="/repos/canjs/can-view-import#stargazers_count">Star</a> </li> </ul> <ul class="title-links"> <!-- <li><a href="#">docco</a></li> --> <li><a href="//github.com/canjs/can-view-import/tree/v3.0.1/docs/can-view-import.md">source</a></li> <!-- <li><a href="#">download</a></li> --> <!-- <li><a href="#">tests</a></li> --> </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>&lt;can-import from=&quot;MODULE_NAME&quot; /&gt;</code> </h2> <p>Statically import a module from with a <a href="can-stache.html" title="Live binding Mustache and Handlebars-compatible templates.">can-stache</a> template. <em>MODULE_NAME</em> will be imported before the template renders.</p> <pre><code>&lt;can-import from=&quot;components/tabs&quot; /&gt; &lt;tabs-widget /&gt; </code></pre> <div class="parameters"> <h3 class="parameters-title">Parameters</h3> <ol> <li><b>MODULE_NAME</b> <code>{moduleName}</code>: <p>A module that this template depends on.</p> </li> </ol> </div> </div> <div class="signature"> <h2 class="signature-title"> <code>&lt;can-import from=&quot;MODULE_NAME&quot;&gt;content&lt;/can-import&gt;</code> </h2> <p>Dynamically import a module. <em>MODULE_NAME</em> will be imported dynamically; the scope within the template is a <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>.</p> <pre><code>&lt;can-import from=&quot;components/tabs&quot;&gt; {{#if isResolved}} &lt;tabs-widget /&gt; {{/if}} &lt;/can-import&gt; </code></pre> <div class="parameters"> <h3 class="parameters-title">Parameters</h3> <ol> <li><b>MODULE_NAME</b> <code>{moduleName}</code>: <p>A module that this template depends on.</p> </li> </ol> </div> </div> <section class="body"> <h2>Use</h2> <p>A template might depend on component or helper modules. <code>&lt;can-import&gt;</code> allows you to specify these dependencies.</p> <p>Example:</p> <pre><code>&lt;can-import from=&quot;components/my_tabs&quot;/&gt; &lt;can-import from=&quot;helpers/prettyDate&quot;/&gt; &lt;my-tabs&gt; &lt;my-panel title=&quot;{{prettyDate start}}&quot;&gt;...&lt;/my-panel&gt; &lt;my-panel title=&quot;{{prettyDate end}}&quot;&gt;...&lt;/my-panel&gt; &lt;/my-tabs&gt; </code></pre> <p>Currently this <strong>only</strong> works with <a href="can-view-autorender.html" title="A module that automatically renders script and other elements with the autorender.can-autorender attribute. This function is useful to know when the templates have finished rendering.">can-view-autorender</a> or the <a href="steal-stache.html" title="A StealJS extension that allows stache templates as dependencies.">steal-stache</a> plugin.</p> <h2>Progressive Loading</h2> <p>A template may load or conditionally load a module after the initial page load. <code>&lt;can-import&gt;</code> allows progressive loading by using an end tag.</p> <p>The first example below shows a component being loaded ad hoc. The second illustrates conditionally loading modules based on some application state.</p> <p>Example:</p> <pre><code>&lt;can-import from=&quot;components/home&quot;&gt;&lt;/can-import&gt; </code></pre> <pre><code>{{#eq location 'home'}} &lt;can-import from=&quot;components/home&quot;&gt; ... &lt;/can-import&gt; {{/eq}} {{#eq location 'away'}} &lt;can-import from=&quot;components/away&quot;&gt; ... &lt;/can-import&gt; {{/eq}} </code></pre> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-view-import/docs/can-view-import.md"},"description":"\n","type":"module","title":"can-view-import","types":[{"type":"function","returns":{"types":[{"type":"undefined"}]},"params":[]}],"name":"can-view-import","parent":"can-ecosystem","package":{"_args":[[{"raw":"can-view-import@3.0.1","scope":null,"escapedName":"can-view-import","name":"can-view-import","rawSpec":"3.0.1","spec":"3.0.1","type":"version"},"/Users/kevin/dev/canjs"]],"_from":"can-view-import@3.0.1","_id":"can-view-import@3.0.1","_inCache":true,"_location":"/can-view-import","_nodeVersion":"6.9.1","_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/can-view-import-3.0.1.tgz_1478793032162_0.24558368604630232"},"_npmUser":{"name":"phillipskevin","email":"kphillips86@gmail.com"},"_npmVersion":"3.10.8","_phantomChildren":{},"_requested":{"raw":"can-view-import@3.0.1","scope":null,"escapedName":"can-view-import","name":"can-view-import","rawSpec":"3.0.1","spec":"3.0.1","type":"version"},"_requiredBy":["/","/steal-stache"],"_resolved":"https://registry.npmjs.org/can-view-import/-/can-view-import-3.0.1.tgz","_shasum":"7de4ff25e6f8f1fc4ed484ff07203ef4f35fc33a","_shrinkwrap":null,"_spec":"can-view-import@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":[{"can-view-import":["can-view-import.from","can-view-import.can-tag","can-view-import.value"]}]},"parent":"can-view-import"},"browser":{"transform":["cssify"]},"browserify":{"transform":["cssify"]},"bugs":{"url":"https://github.com/canjs/can-view-import/issues"},"dependencies":{"can-event":"^3.0.1","can-stache":"^3.0.1","can-util":"^3.0.1","can-view-callbacks":"^3.0.0","can-view-nodelist":"^3.0.0","steal-stache":"^3.0.0"},"description":"Import dependencies in CanJS views","devDependencies":{"bit-docs":"0.0.6","can-component":"^3.0.0-pre.3","can-compute":"^3.0.0-pre.2","can-map":"^3.0.0-pre.3","can-stache":"^3.0.0-pre.2","cssify":"^0.6.0","done-serve":"^0.2.0","donejs-cli":"^0.9.4","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.2.4"},"directories":{},"dist":{"shasum":"7de4ff25e6f8f1fc4ed484ff07203ef4f35fc33a","tarball":"https://registry.npmjs.org/can-view-import/-/can-view-import-3.0.1.tgz"},"gitHead":"7f13cc4ad8e802c8fdee7850c4dcfcd235033fe9","homepage":"https://canjs.com","keywords":[],"main":"dist/cjs/can-view-import","maintainers":[{"name":"daffl","email":"daff@neyeon.de"},{"name":"justinbmeyer","email":"justin@bitovi.com"},{"name":"matthewp","email":"matthew@matthewphillips.info"},{"name":"phillipskevin","email":"kphillips86@gmail.com"}],"name":"can-view-import","optionalDependencies":{},"readme":"ERROR: No README data found!","repository":{"type":"git","url":"git://github.com/canjs/can-view-import.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/test.html --browsers firefox","version":"git commit -am \"Update dist for release\" && git checkout -b release && git add -f dist/"},"system":{"main":"can-view-import","configDependencies":["live-reload"],"npmIgnore":["documentjs","testee","generator-donejs","donejs-cli","steal-tools"],"npmAlgorithm":"flat"},"version":"3.0.1"},"signatures":[{"code":"<can-import from=\"MODULE_NAME\" />","description":"\n\nStatically import a module from with a [can-stache] template. *MODULE_NAME* will be imported before the template renders.\n\n```\n<can-import from=\"components/tabs\" />\n<tabs-widget />\n```\n","params":[{"types":[{"type":"moduleName"}],"optional":true,"name":"MODULE_NAME","description":"A module that this template depends on.\n"}]},{"code":"<can-import from=\"MODULE_NAME\">content</can-import>","description":"\n\nDynamically import a module. *MODULE_NAME* will be imported dynamically; the scope within the template is a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise).\n\n```\n<can-import from=\"components/tabs\">\n\t{{#if isResolved}}\n\t\t<tabs-widget />\n\t{{/if}}\n</can-import>\n```\n","params":[{"types":[{"type":"moduleName"}],"optional":true,"name":"MODULE_NAME","description":"A module that this template depends on.\n"}]}],"_curParam":{"types":[{"type":"moduleName"}],"optional":true,"name":"MODULE_NAME","description":"A module that this template depends on.\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>