Information

Package	dermis
Description	Sugar
Size	5.5K

Introduction

Dermis exists to provide an easy to use wrapper around routing and rendering. If you find yourself requesting data from the server then rendering it throughout your application dermis can help clean up your workflow.

Dependencies

Dermis comes with Rooter (routing) and RequireJS (AMD) baked in.

Routing

Passing a single route to dermis will automatically load routes/(base) and routes/(template) when triggered.

require(["dermis"], function (dermis) {
  // This will load routes/test.js and templates/test.js
  dermis.route('/test/:id');
  dermis.init();
});

You can optionally specify the action/template locations for your second and third arguments.

require(["dermis"], function (dermis) {
  dermis.route('/test/:id', 'tasks/runtest', 'tmpl/rendertest');
  dermis.init();
});

Structure

routes/test.js

Your route function will receive two arguments. The first argument is an object that contains the parameters from your route - the second argument is your template function wrapped in a dermis view. dermis view functions can be chained.

define(function () {
  return function (args, view) {
    $('#content').html(view(args));
  };
});

templates/test.js

Your template function will receive any arguments that were passed in from your route function. Your template files MUST be valid AMD modules. If you use jade templates have a look at jaded which will compile your templates to AMD modules.

define(function () {
  return function (args) {
    return "User" + args.user + " triggered this!";
  }
});

Examples

You can see examples in the example folder.

LICENSE

(MIT License)

Copyright (c) 2012 Fractal contact@wearefractal.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.