1
0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2024-12-04 15:24:23 +01:00
fab-manager/vendor/assets/components/angular-aside/README.md

56 lines
1.4 KiB
Markdown

angular-aside ![bower version](http://img.shields.io/bower/v/angular-aside.svg) [![npm version](https://badge.fury.io/js/angular-aside.svg)](https://www.npmjs.com/package/angular-aside)
=============
Off canvas side menu for use with ui-bootstrap 0.14+. Extends ui-bootstrap's `$uibModal` provider.
:information_desk_person: Please use v1.2.x for ui-bootstrap versions 0.13 and below.
###[Live Demo](http://plnkr.co/edit/G7vMSv?p=preview)
##Install
#### Bower:
```bash
$ bower install angular-aside
```
Then, include css/js in html.
#### NPM
```bash
$ npm install angular-aside
```
##Usage
```js
angular.module('myApp', ['ui.bootstrap', 'ngAside']);
```
```js
angular.module('myApp')
.controller('MyController', function($scope, $aside) {
var asideInstance = $aside.open({
templateUrl: 'aside.html',
controller: 'AsideCtrl',
placement: 'left',
size: 'lg'
});
});
```
Supports all configuration that `$uibModal` has. Can be used with both `template` and `templateUrl`. For more info hit **Modal** section on [angular-ui bootstrap](http://angular-ui.github.io/bootstrap) documentation.
##Additional Config
- `placement` - Aside placement can be `'left'`, `'right'`, `'top'`, or `'bottom'`.
##Credits
- [Angular UI Bootstrap](angular-ui.github.io/bootstrap/)
- [Animate.css](http://daneden.github.io/animate.css/)
##Author
İsmail Demirbilek ([@dbtek](https://twitter.com/dbtek))