Documentation

Welcome to the official Falcon.js documentation! Please, explore.

Falcon.Object is the base-most class that all other Falcon classes (Model, Collection, View, Adapter) inherit from. It provides functionality for event handling, defaults/observables creation, and the definition for extend that exists on all subclasses.

Falcon.Model is Falcon's class that is used to represent individual data objects (eg. Dog, Cat, User, etc). Models can be used to interact with data to/from a backend API, provide data specific validation, and create general data definitions.

Falcon.Collection is Falcon's class that is used to represent a list of models. Collections can be used to retrieve a list of models from a backend API and they provide numerous sorting and filtering methods.

Falcon.View is Falcon's class that is used to represent an individual view which is bound to a Knockout template. Views can be used to organize individual application components and their specific data representations and functionality. Views can also be used to trigger certain functionality when being displayed or hidden from the DOM.

Falcon.Adapter is Falcon's class that defines how we send, retrieve, and respond to requests from a back-end data source. Adapters should be a singleton and assigned to Falcon.adapter. In previous version fo Falcon, we were stuck assuming that we'd be using jQuery for our Ajax Calls with a RESTful interface. Adapters remove this assumption and dependency on jQuery and allow for us to write any interface that we would like depending on what backend service we have present.

Falcon provides new implementations for certain bindings in order to make Knockout templates compatable with Falcon views and data objects.

The conductor is an experimental plugin (and separate javascript file) that allows us to directly link any (custom or otherwise) HTML tag to a user-defined method or Falcon view. Additionally, the attributes of a custom tag processed by the conductor are evaluated against the current context and hence can be used to pass data from parent context into the generated views.

Utility methods are used to initialize your application, add custom bindings, and check data for specific Falcon related types.

The configuration documents and discusses all of the different configuration options available in Falcon.