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
      • 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

API Docs

  • npm package badge
  • Star
  • Edit on GitHub

Welcome to the CanJS API documentation! Learn about all the packages that make-up CanJS and how they work together to help you build amazing applications!

Collections

CanJS is made of many independent packages and modules. Those packages and modules are organized within the following collections. Read on to get an overview of each collection’s packages. Please star what you like so we know where to put our effort.

Core Collection

The best, most hardened and generally useful libraries in CanJS.

  • can-compute 3.3.10 Observable values and observable composite values
    • npm install can-compute --save
    • Star
  • can-define 1.5.7 Observable objects
    • npm install can-define --save
    • Star
  • can-set 1.6.0 Service modeling
    • npm install can-set --save
    • Star
  • can-connect 1.5.18 Data connection
    • npm install can-connect --save
    • Star
  • can-stache 3.15.0 Live binding templates
    • npm install can-stache --save
    • Star
  • can-component 3.3.10 Custom elements
    • npm install can-component --save
    • Star
  • can-stache-bindings 3.11.12 View bindings
    • npm install can-stache-bindings --save
    • Star
  • can-route 3.3.4 Routing
    • npm install can-route --save
    • Star
  • can-route-pushstate 3.2.4 Pushstate routing
    • npm install can-route-pushstate --save
    • Star

Infrastructure Collection

Utility libraries that power the core collection.

  • can-event 3.7.7 Event mixin
    • npm install can-event --save
    • Star
  • can-control 3.2.4 DOM widget constructor
    • npm install can-control --save
    • Star
  • can-util 3.14.0 Low-level JS and DOM utilities
    • npm install can-util --save
    • Star
  • can-construct 3.5.3 Extensible constructors
    • npm install can-construct --save
    • Star
  • can-observation 3.3.6 Observation notification
    • npm install can-observation --save
    • Star
  • can-simple-map 3.3.2 Simple observable object
    • npm install can-simple-map --save
    • Star
  • can-simple-observable 1.0.2 Create an observable value
    • npm install can-simple-observable --save
    • Star
  • can-view-callbacks 3.2.5 Register custom elements or attributes in can-stache
    • npm install can-view-callbacks --save
    • Star
  • can-view-model 3.5.2 Read a view-model from a custom element
    • npm install can-view-model --save
    • Star
  • can-view-scope 3.6.0 Scope lookup
    • npm install can-view-scope --save
    • Star
  • can-view-parser 3.8.3 Parses HTML and magic tags
    • npm install can-view-parser --save
    • Star
  • can-view-target 3.1.6 A fast-path DOM fragment compile target
    • npm install can-view-target --save
    • Star
  • can-view-live 3.2.6 Update the DOM with a compute
    • npm install can-view-live --save
    • Star
  • can-view-nodelist 3.1.1 Maintains live-binding relationships
    • npm install can-view-nodelist --save
    • Star
  • can-cid 1.3.0 Get a unique identifier for objects
    • npm install can-cid --save
    • Star
  • can-deparam 1.2.0 Deserialize a query string into an array or object
    • npm install can-deparam --save
    • Star
  • can-param 1.1.0 Serialize an array or object into a query string
    • npm install can-param --save
    • Star
  • can-types 1.4.0 A stateful container for CanJS type information
    • npm install can-types --save
    • Star
  • can-namespace 1.0.0 Namespace where can-* packages are registered
    • npm install can-namespace --save
    • Star
  • can-symbol 1.6.1 Symbols used to detail how CanJS may operate on different objects
    • npm install can-symbol --save
    • Star
  • can-reflect 1.17.5 Perform reflection on unknown data types
    • npm install can-reflect --save
    • Star
  • can-react-component 0.1.11 Create a React component out of a CanComponent.
    • npm install can-react-component --save
    • Star
  • react-view-model 0.5.11 Create an auto-rendering container component with an observable view-model.
    • npm install react-view-model --save
    • Star
  • can-ajax jQuery-inspired AJAX request library.
    • npm install can-ajax --save
    • Star
  • can-globals 1.2.0 An environment agnostic container for global variables.
    • npm install can-globals --save
    • Star
  • can-define-lazy-value 1.1.0 An environment agnostic container for global variables.
    • npm install can-define-lazy-value --save
    • Star
  • can-assign A simplified version of Object.assign.
    • npm install can-assign --save
    • Star
  • can-dom-events 1.3.0 Listen for native and custom DOM events.
    • npm install can-dom-events --save
    • Star
  • can-event-dom-enter 1.0.4 Watch for enter keys presses on a DomEventTarget.
    • npm install can-event-dom-enter --save
    • Star
  • can-event-dom-radiochange 1.0.5 A custom event for listening to changes of inputs with type "radio".
    • npm install can-event-dom-radiochange --save
    • Star
  • can-parse-uri Parse a URI into its components.
    • npm install can-parse-uri --save
    • Star
  • can-validate-interface 0.1.2 Utility to validate property existence.
    • npm install can-validate-interface --save
    • Star
  • can-zone-storage 1.0.1 Implement a Zone-safe memory-based storage solution.
    • npm install can-zone-storage --save
    • Star

Ecosystem Collection

Useful libraries that add important features or extend the core collection.

  • can-fixture 1.2.2 Simulate AJAX requests
    • npm install can-fixture --save
    • Star
  • can-fixture-socket 0.7.2 Simulate sockets
    • npm install can-fixture-socket --save
    • Star
  • can-connect-feathers 3.7.1 Create connections to a FeathersJS API server.
    • npm install can-connect-feathers --save
    • Star
  • can-connect-signalr 0.2.3 Create connections to a FeathersJS API server.
    • npm install can-connect-signalr --save
    • Star
  • can-connect-cloneable 0.2.4 Make clones of Maps.
    • npm install can-connect-cloneable --save
    • Star
  • can-connect-ndjson 0.1.3 Create connection to an NDJSON stream service
    • npm install can-connect-ndjson --save
    • Star
  • can-zone 0.6.22 Track asynchronous activity
    • npm install can-zone --save
    • Star
  • can-stache-converters 3.3.1 Form two-way binding helpers
    • npm install can-stache-converters --save
    • Star
  • steal-stache 3.1.3 Import can-stache templates as dependencies with StealJS
    • npm install steal-stache --save
    • Star
  • can-view-import 3.2.9 Import modules within can-stache templates
    • npm install can-view-import --save
    • Star
  • can-view-autorender 3.1.4 Automatically render templates in script tags
    • npm install can-view-autorender --save
    • Star
  • can-jquery 3.2.5 jQuery integrations
    • npm install can-jquery --save
    • Star
  • can-construct-super 3.2.0 Call can-construct base methods easily
    • npm install can-construct-super --save
    • Star
  • can-vdom 3.2.5 A virtual DOM that supports can-stache
    • npm install can-vdom --save
    • Star
  • can-kefir 0.2.3 Use streams in can-stache.
    • npm install can-kefir --save
    • Star
  • can-stream-kefir 0.3.3 Convert observable values into streams
    • npm install can-stream-kefir --save
    • Star
  • can-define-stream 0.2.2 Define property values using streams
    • npm install can-define-stream --save
    • Star
  • can-validate 1.2.0 Validation tools and types definitions
    • npm install can-validate --save
    • Star
  • can-validate-validatejs 0.1.3 Create validators with ValidateJS
    • npm install can-validate-validatejs --save
    • Star
  • can-define-validate-validatejs 0.1.4 Validation for DefineMaps using the ValidateJS library
    • npm install can-define-validate-validatejs --save
    • Star
  • can-ndjson-stream 0.1.8 Convert ndjson stream into a ReadableStream of JS objects
    • npm install can-ndjson-stream --save
    • Star
  • can-observe 1.0.1 Create plain observable objects
    • npm install can-observe --save
    • Star
  • can-element 0.2.4 Create custom elements
    • npm install can-element --save
    • Star

Legacy Collection

Former libraries that are not under active development, but we still accept patches.

  • can-map 3.6.1 Observable map
    • npm install can-map --save
    • Star
  • can-list 3.2.2 Observable lists
    • npm install can-list --save
    • Star
  • can-map-define 3.1.2 Define property behavior
    • npm install can-map-define --save
    • Star
  • can-map-backup 3.1.1 Save the last state
    • npm install can-map-backup --save
    • Star
  • can-ejs 3.2.1 EJS templates
    • npm install can-ejs --save
    • Star
  • can-view-href 3.1.1 Older routing view helpers
    • npm install can-view-href --save
    • Star
  • can-validate-legacy 1.4.0 Validation plugin for can-map's.
    • npm install can-validate-legacy --save
    • Star

The can Package

While CanJS is designed to be used and should be used as independent packages, we still publish a can package with a version number, currently 3.14.1. We do this so there is a specified version of all of the sub-project packages that are integration tested to work together.

The can package uses semantic versioning with respect to the Core and Infrastructure collections only. Read the Release Guide for more information on CanJS’s release process.

The sub-project package versions for can 3.14.1 are listed below. Copy the ones you use into your package.json if you want to use the same packages that were tested as part of CanJS 3.14.1’s release.

Core Collection

  "can-component": "3.3.10",
  "can-compute": "3.3.10",
  "can-connect": "1.5.18",
  "can-define": "1.5.7",
  "can-route": "3.3.4",
  "can-route-pushstate": "3.2.4",
  "can-set": "1.6.0",
  "can-stache": "3.15.0",
  "can-stache-bindings": "3.11.12",

Infrastructure Collection

  "can-construct": "3.11.12",
  "can-control": "3.2.4",
  "can-event": "3.7.7",
  "can-observation": "3.3.6",
  "can-simple-map": "3.3.2",
  "can-simple-observable": "1.0.2",
  "can-util": "3.14.0",
  "can-view-callbacks": "3.2.5",
  "can-view-live": "3.2.6",
  "can-view-model": "3.5.2",
  "can-view-nodelist": "3.1.1",
  "can-view-parser": "3.8.3",
  "can-view-scope": "3.6.0",
  "can-view-target": "3.1.6",

Ecosystem collection

  "can-construct-super": "3.2.0",
  "can-define-stream": "0.2.2",
  "can-fixture": "1.2.2",
  "can-fixture-socket": "0.7.2",
  "can-jquery": "3.2.5",
  "can-stache-converters": "3.3.1",
  "can-stream-kefir": "0.3.3",
  "can-vdom": "3.2.5",
  "can-view-autorender": "3.1.4",
  "can-view-import": "3.2.9",
  "can-zone": "0.6.22",
  "steal-stache": "3.1.3",

Legacy Collection

  "can-ejs": "3.2.1",
  "can-list": "3.2.2",
  "can-map": "3.6.1",
  "can-map-backup": "3.1.1",
  "can-map-define": "3.1.2",
  "can-view-href": "3.1.1",

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