DoneJS StealJS jQuery++ FuncUnit DocumentJS
4.3.0
5.0.0 3.13.1 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-bind
      • can-compute
      • can-debug
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-backup
      • can-define-stream
      • can-define-stream-kefir
      • can-event-queue
      • can-kefir
      • can-list
      • can-map
      • can-map-define
      • can-observation
      • can-observation-recorder
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
      • can-value
    • Data Modeling
      • can-connect
      • can-connect-feathers
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
      • can-stache
      • can-stache-bindings
      • can-stache-converters
      • can-stache-route-helpers
      • can-view-autorender
      • can-view-callbacks
      • 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-hash
      • can-route-mock
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-diff
      • can-globals
      • can-join-uris
      • can-key
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-queues
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-child-nodes
      • can-control
      • can-dom-data
      • can-dom-events
      • can-dom-mutate
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-fragment
    • 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-data-types
      • can-namespace
      • can-reflect
      • can-reflect-dependencies
      • 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-view-model

  • npm package badge
  • Star
  • Edit on GitHub

Gets the ViewModel of an element.

canViewModel(element)

Gets the map instance associated with element, creating one as a DefaultMap if it doesn’t already exist, and returns the map.

const vm = canViewModel( element );

const vm2 = canViewModel( "#element2id" );

const vm3 = canViewModel( $( [ element3 ] ) );

const vm4 = canViewModel( document.querySelectorAll( ".element4class" ) );

Parameters

  1. element {HTMLElement|String|ArrayLike}:

    Any element in the DOM, represented by a reference to the element itself, a query selector string, or an Array-like holding the element in its zero index.

Returns

{can-map|can-define/map/map|Object}:

The ViewModel associated with this element.

canViewModel(element, property)

Gets the map instance associated with element, creating one as a DefaultMap if it doesn’t already exist. Then, gets the property inside of the ViewModel and returns that.

var foo = canViewModel(element, "foo");

console.log(foo); // -> "bar"

Parameters

  1. element {HTMLElement|String|ArrayLike}:

    Any element in the DOM, represented by a reference to the element itself, a query selector string, or an Array-like holding the element in its zero index.

  2. property {String}:

    The property to get from the ViewModel.

Returns

{*}:

The value of the property on the ViewModel or undefined if the property doesn’t exist.

canViewModel(element, property, value)

Gets the map instance associated with element, creating one as a DefaultMap if it doesn’t already exist. Sets the property on that map to value.

canViewModel( element, "foo", "bar" );

const foo = canViewModel( element, "foo" );

console.log( foo ); // -> "bar"

Parameters

  1. element {HTMLElement|String|ArrayLike}:

    Any element in the DOM, represented by a reference to the element itself, a query selector string, or an Array-like holding the element in its zero index.

  2. property {String}:

    The property that is being set on the ViewModel.

  3. value {*}:

    The value being set on the property.

Returns

{HTMLElement}:

The element.

Use

can-view-model is used to get and set properties on an element’s ViewModel. Each element in the DOM can have an associated ViewModel. An example of this is a can-component and its associated ViewModel.

This shows a Component and getting its ViewModel:

<my-tabs>
 ...
</my-tabs>
import canViewModel from "can-view-model";

const element = document.querySelector( "my-tabs" );
const vm = canViewModel( element );

The other signatures provide the ability to get and set properties on the ViewModel. For example, this sets the foo property on a component’s viewModel:

import canViewModel from "can-view-model";

const element = document.querySelector( "my-tabs" );
const vm = canViewModel( element );

canViewModel( element, "foo", "bar" );

console.log( vm.foo, "bar" );

Setting an element’s ViewModel

One thing that can-view-model does not do is provide a way to set what an element’s ViewModel should be. To do that, use data instead like so:

import domData from "can-util/dom/data/data";
import DefineMap from "can-define/map/map";

const element = document.querySelector( "#my-id" );

const myVm = new DefineMap();

domData.set.call( element, "viewModel", myVm );

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

On this page

Get help

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