DoneJS StealJS jQuery++ FuncUnit DocumentJS
3.14.1
5.0.0 4.3.0 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-compute
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-stream
      • can-define-stream-kefir
      • can-event
      • can-event/async/async
      • can-event/batch/batch
      • can-event/lifecycle/lifecycle
      • can-kefir
      • can-list
      • can-map
      • can-map-backup
      • can-map-define
      • can-observation
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
    • Data Modeling
      • can-connect
      • can-connect-cloneable
      • can-connect-feathers
      • can-connect-ndjson
      • can-connect-signalr
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
        • static
          • extend
        • prototype
          • ViewModel
          • events
          • helpers
          • leakScope
          • tag
          • view
          • viewModel
        • elements
          • <can-slot>
          • <can-template>
          • <content>
        • special events
          • beforeremove
      • can-ejs
      • can-element
      • can-react-component
      • can-stache
      • can-stache/helpers/route
      • can-stache-bindings
      • can-stache-converters
      • can-view-autorender
      • can-view-callbacks
      • can-view-href
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-nodelist
      • can-view-parser
      • can-view-scope
      • can-view-target
      • react-view-model
      • react-view-model/component
      • steal-stache
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-globals
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-control
      • can-dom-events
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-jquery
    • Data Validation
      • can-define-validate-validatejs
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-namespace
      • can-reflect
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

<can-template>

  • Edit on GitHub

Pass templates declaratively to components.

<can-template name='NAME'/>

When building widget-like components, it's often useful to allow the consumer of the component to customize parts of the widget's layout. These components can accept templates passed to them using <can-template> and render these templates with <can-slot>. The name attribute of a <can-template> corresponds to the name attribute of a <can-slot>.

For example, the following passes a <my-modal> component a <can-template> of the modal content:

Component.extend({
    tag : 'my-modal',
    view : stache(
        '<div class="wrapper"><can-slot name="modal-content" /></div>'
    )
});

var renderer = stache(
    '<my-modal>' +
        '<can-template name="modal-content">' +
            'Hello World!' +
        '</can-template>' +
    '</my-modal>'
);

renderer() //-> <my-modal><div class="wrapper">Hello World!</div></my-modal>

By default, <can-template> is rendered with the surrounding scope like <content>. A different context (this) can be added to that scope with bindings. Read <can-slot> for more information.

Parameters

  1. NAME {String}:

    The name of the template that will be rendered by a corresponding <can-slot>.

Use

To use <can-template> elements we can create a Component that has <can-slot> elements in it's view and render that component with <can-template> elements in the LIGHT_DOM.

Any <can-template> that has a name attribute matching the name attribute of a <can-slot> will have it's inner contents rendered and replace the <can-slot>.

Component.extend({
    tag : 'my-email',
    view : stache(
        '<can-slot name="subject" />' +
        '<p>My Email</p>' +
        '<can-slot name="body" />'
    )
});

var renderer = stache(
    '<my-email>' +
        '<can-template name="subject">' +
            '<h1>{{subject}}</h1>' +
        '</can-template>' +
        '<can-template name="body">' +
            '<span>{{body}}</span>' +
        '</can-template>' +
    '</my-email>'
);

renderer({
    subject: 'Hello World',
    body: 'The email body'
});

/*
<my-email>
    <h1>Hello World</h1>
    <p>My Email</p>
    <span>The email body</span>
</my-email>
*/

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 3.14.1.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news