layout - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

lib/layout.js

@@ -10,3 +10,3 @@ // Load in packing.smith (from spritesmith) and create algorithm store
  * @param {String|Function} [algorithm="top-down"] Name of algorithm or custom algorithm to use
- * Algorithms available: top-down, bottom-up, left-right, right-left, diagonal, negative-diagonal, reverse-diagonal
+ * Algorithms available: top-down, left-right, diagonal, alt-diagonal
  */
@@ -13,0 +13,0 @@ function Layout(algorithmName) {

lib/smiths/packing.smith.js

@@ -92,2 +92,8 @@ function PackingSmith(algorithm) {
   },
+  /**
+   * @returns {Object} retObj
+   * @returns {Number} retObj.height Height of the processed layout
+   * @returns {Number} retObj.width Width of the processed layout
+   * @returns {Mixed[]} retObj.items Organized items
+   */
   'export': function () {
@@ -100,4 +106,4 @@ // Grab the stats, coordinates, and items
     var retObj = {
+          'height': stats.maxY,
           'width': stats.maxX,
-          'height': stats.maxY,
           'items': items
@@ -104,0 +110,0 @@ };

package.json

 {
   "name": "layout",
   "description": "Organize and layout items based on various algorithms",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "homepage": "https://github.com/twolfson/layout",
@@ -6,0 +6,0 @@ "author": {

README.md

@@ -9,20 +9,88 @@ # layout
 ```javascript
+// Load in layout
 var layout = require('layout');
-layout.awesome(); // "awesome"
+
+// Generate a new layer to organize items on
+var layer = layout('top-down');
+
+// Add items that you want to organize
+layer.addItem({'height': 20, 'width': 10, 'meta': 'medium'});
+layer.addItem({'height': 10, 'width': 10, 'meta': 'small'});
+layer.addItem({'height': 50, 'width': 40, 'meta': 'large'});
+
+// Export the info
+var info = layer['export']();
+
+// We get back the width and height of the pack as well as organized items
+{
+    height: 80,
+    width: 40,
+    items: [{
+        height: 10,
+        width: 10,
+        meta: 'small',
+        x: 0,
+        y: 0
+    }, {
+        height: 20,
+        width: 10,
+        meta: 'medium',
+        x: 0,
+        y: 10
+    }, {
+        height: 50,
+        width: 40,
+        meta: 'large',
+        x: 0,
+        y: 30
+    }]
+}
 ```
 
 ## Documentation
-_(Coming soon)_
+Layout is a constructor function
+```js
+/**
+ * Layout adds items in an algorithmic fashion
+ * @constructor
+ * @param {String|Function} [algorithm="top-down"] Name of algorithm or custom algorithm to use
+ * Algorithms available: top-down, left-right, diagonal, alt-diagonal
+ */
+```
 
-## Examples
-_(Coming soon)_
+Items can be added via `addItem` which are required to have a `height` and `width`. Any additional info should be stored inside of `meta`.
+```js
+/**
+ * @param {Object} item Item to store -- this currently is mutated in-memory
+ * @param {Number} item.width Width of the item
+ * @param {Number} item.height Height of the item
+ * @param {Mixed} [item.meta] Any meta data you would like to store related to the item
+ */
+```
 
+`export` is how you take your items and organize them.
+```js
+/**
+ * @returns {Object} retObj
+ * @returns {Number} retObj.height Height of the processed layout
+ * @returns {Number} retObj.width Width of the processed layout
+ * @returns {Mixed[]} retObj.items Organized items
+ */
+```
+
+### Custom algorithms
+You can add your own algorithm via `layout.addAlgorithm`
+```js
+/**
+ * Method to add new algorithms via
+ * @param {String} name Name of algorithm
+ * @param {Function} algorithm Algorithm to bind under name
+ */
+```
+
 ## Contributing
 In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt).
 
-## Release History
-_(Nothing yet)_
-
 ## License
-Copyright (c) 2012 Todd Wolfson  
+Copyright (c) 2012 Todd Wolfson
 Licensed under the MIT license.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19990

increased by11.61%

Lines of code

426

increased by1.43%

Number of lines in readme file

96

increased by242.86%

No dependency changes