Backbone.Overview

    0.0.2 • Public • Published

    Backbone.Overview

    An Overview is a View that references and keeps track of sub-views (i.e. just normal Backbone.Views) Kind of like what a Collection is to a Model.

    An Overview provides methods for handling the views it keeps track of:

    • add(id, view)
    • get(id)
    • getAll()
    • keys()
    • remove(id)
    • removeAll()

    Usage

    Include Backbone.Overview after having included Backbone.js:

        <script type="text/javascript" src="backbone.js"></script> 
        <script type="text/javascript" src="backbone.overview.js"></script> 

    Create your overview like this:

        this.RosterView = Backbone.Overview.extend({
        // ... same customizations as you would make for a normal Backbone.View
        });

    Underscore

    You can use the usual underscore methdods, like you can with Backbone Collections.

    For example:

        this.rosterview = new this.RosterView();
        this.rosterview.add(new Backbone.View({model: new Backbone.Model()));
     
        this.rosterview.each(function (view) {
            // Do something
        });

    RequireJS

    Include RequireJS:

        <script type="text/javascript" src="lib/require.js"></script> 

    RequireJS config:

        require.config({
            paths: {
                jquery: "lib/jquery",
                underscore: "lib/underscore",
                backbone: "lib/backbone",
                backbone.overview: "lib/backbone.overview"
            }
        });
        define(["backbone.overview"], function() {
            this.RosterView = Backbone.Overview.extend({
            // ... same customizations as you would make for a normal Backbone.View
            });
        });

    Real-world example

    Overviews are used in converse.js

    Install

    npm i Backbone.Overview

    DownloadsWeekly Downloads

    2

    Version

    0.0.2

    License

    MIT

    Last publish

    Collaborators

    • jcbrand