Git Product home page Git Product logo

bw-vm's Introduction

bw-vm

browser support

experimental

bw-vm is a view manager. It's main purpose is to bring in and take out views/sections.

bw-vm has no ties to the browser and so can be used in environments that have no ties to the browser. For instance you could use it in a command line application or cocoonjs.

Views/sections are objects which may have the functions init, resize, aniIn, aniOut, destroy defined.

bw-vm will call those functions in sequence init, resize, aniIn, aniOut, destroy. aniOut and destroy will not be called until the next view/section comes in.

Usage

NPM

Example

var viewmanager = require( 'bw-vm' )();

var optionalDataYouCanPass = {

  someData: './someImage.jpg' 
};

var optionalCallbackForWhenSectionIsIn = function() {};

var section1 = new Section(); // section 1 will be the initial view
var section2 = new Section(); // section 2 will be the second view

viewmanager.show( section1, optionalDataYouCanPass, optionalCallbackForWhenSectionIsIn );
viewmanager.show( section2 ); // will take out the first section and bring in the second



function Section() {};

Section.prototype = {
  
  init: function( data, done ) {

    // data == optionalCallbackForWhenSectionIsIn

    done(); // call done to ensure the viewmanager knows initialization is done
  },

  resize: function( width, height ) {

    // there is a function on the view manager which can be called to resize
    // current section it's holding.

    // by default 980x570 is passed
  },

  aniIn: function( data, done ) {

    // data == optionalCallbackForWhenSectionIsIn

    done(); // call done to ensure the viewmanager knows animate in is done
  },

  aniOut: function( data, done ) {

    // data == is the data used to bring in the next section

    done(); // call done to ensure the viewmanager knows animate out is done
  },

  destroy: function( data, done ) {

    // data == is the data used to bring in the next section

    done(); // call done to ensure the viewmanager knows when destrou is done
  }
};

License

MIT, see LICENSE.md for details.

bw-vm's People

Contributors

mikkoh avatar njam3 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.