README.md

TatuJS

Convert your simple static site into a single-page application with a resource queue, history handling, content pre-loading and local storage cache, using this configurable and extensible Javascript library.

Installation

Add the latest build files to your HTML page and write your configuration object. Check out the example included.

Configuration

This example configuration shows how to enable the HTML loader for page contents together with some nested media loaders.

tatu.configuration.extractor = 'silent';
tatu.configuration.reload = false;
tatu.configuration.targetSymbol = '>>';
tatu.configuration.concurrency = 42;

tatu.configuration.sources = {
  /*
   * Pages of the menu
   */
  '.navbar a': {  // <- Links selectors
    'loader': 'html',

    'selectors': 'title,.container,.navbar',  // <- Sections of the page to download
    'handlers': 'title,outer,history,inspect,event',  // <- Handlers to call when a link is clicked
    'cache': 'object',  // <- Cache implementation to use

    'sources': {  // <- Nested media loaders
      'img': {
        'loader': 'image'
      },
      'video': {
        'loader': 'video',
        'minBuffered': 10
      }
    }
  },

  /*
   * Tabs inside Page 0
   */
  '.tatu-tabs a': {
    'loader': 'html',

    'selectors': 'title,.tatu-tab-content,.tatu-tabs',
    'handlers': 'title,outer,inspect,event',
    'cache': 'object'
  }
};

License

Tatujs is Copyright (c) 2017 sophilabs, inc. It is free software, and may be redistributed under the terms specified in the license file.

About

Tatujs is maintained and funded by sophilabs, inc. The names and logos for sophilabs are trademarks of sophilabs, inc.