https://github.com/doowb/layout-stack
Create a layout stack based on the given layout templates.
https://github.com/doowb/layout-stack
Last synced: about 1 month ago
JSON representation
Create a layout stack based on the given layout templates.
- Host: GitHub
- URL: https://github.com/doowb/layout-stack
- Owner: doowb
- License: mit
- Created: 2014-11-18T21:28:55.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-16T03:04:01.000Z (over 9 years ago)
- Last Synced: 2025-02-26T19:51:43.381Z (about 2 months ago)
- Language: JavaScript
- Size: 141 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# layout-stack [](http://badge.fury.io/js/layout-stack)
> Create a layout stack based on the given layout templates.
## Install
### Install with [npm](npmjs.org)
```bash
npm i layout-stack --save
```
## Run tests
```bash
npm test
```
## Usage
```js
var stack = require('layout-stack');
```
## API
### [.createStack](index.js#L24)
Build a layout stack.
* `name` **{String}**: The name of the first layout to add to the stack.
* `layouts` **{Object}**: Possible layout templates tha could be used in the stack.
* `options` **{Object}**: Options to pass to `assertLayout`.
* `returns` **{Array}**: The layout stack starting with the given name.
```js
var stack = createStack('2-col-side-nav', layouts);
```
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/doowb/layout-stack/issues)
## Author
**Brian Woodward**
+ [github/doowb](https://github.com/doowb)
+ [twitter/doowb](http://twitter.com/doowb)
## License
Copyright (c) 2014 Brian Woodward
Released under the MIT license
***
_This file was generated by [verb](https://github.com/assemble/verb) on November 18, 2014._