summaryrefslogtreecommitdiff
path: root/www/lib/angular-circular-navigation/README.md
diff options
context:
space:
mode:
authorPliablePixels <pliablepixels@gmail.com>2015-06-30 19:43:10 -0400
committerPliablePixels <pliablepixels@gmail.com>2015-06-30 19:43:10 -0400
commitec224285320d38b3007fb469c10fffbca1294c10 (patch)
tree8915a65f13913d1bc1d5b67d081330684d69c3fd /www/lib/angular-circular-navigation/README.md
parent89cd2015ebfcb08803c2ff6e2f9384a86f4f1ecd (diff)
set 50K limit for logs, separated my modifications for angular-circular-navigations
Diffstat (limited to 'www/lib/angular-circular-navigation/README.md')
-rw-r--r--www/lib/angular-circular-navigation/README.md179
1 files changed, 0 insertions, 179 deletions
diff --git a/www/lib/angular-circular-navigation/README.md b/www/lib/angular-circular-navigation/README.md
deleted file mode 100644
index b219a99d..00000000
--- a/www/lib/angular-circular-navigation/README.md
+++ /dev/null
@@ -1,179 +0,0 @@
-# angular-circular-navigation [![Build Status](https://travis-ci.org/maxklenk/angular-circular-navigation.svg?branch=master)](https://travis-ci.org/maxklenk/angular-circular-navigation) [![Coverage Status](https://coveralls.io/repos/maxklenk/angular-circular-navigation/badge.png?branch=master)](https://coveralls.io/r/maxklenk/angular-circular-navigation?branch=master)
-
-**** THE CSS FILE WAS MODIFIED BY PLIABLE PIXELS TO ALLOW FOR PERFECTLY ALIGNED ANGLES FOR PTZ -- PLEASE DON'T REPLACE WITH ORIGINAL LIBRARY ****
-
-angular-circular-navigation is a [AngularJS](https://github.com/angular/angular.js) directive, which is build on top of the Tutorial [Building a circular navigation with css transform](http://tympanus.net/codrops/2013/08/09/building-a-circular-navigation-with-css-transforms/) by [Sara Soueidan](http://sarasoueidan.com/).
-
-
-## Usage [![Dependency Status](https://gemnasium.com/maxklenk/angular-circular-navigation.svg)](https://gemnasium.com/maxklenk/angular-circular-navigation)
-
-You can get it from [Bower](http://bower.io/):
-```sh
-bower install angular-circular-navigation
-```
-
-Add everything to your index.html:
-```html
-<link rel="stylesheet" href="bower_components/angular-circular-navigation/angular-circular-navigation.css">
-
-<script src="bower_components/angular/angular.js"></script>
-<script src="bower_components/angular-circular-navigation/angular-circular-navigation.js"></script>
-```
-
-And specify the directive in your module dependencies:
-```javascript
-angular.module('myApp', ['angularCircularNavigation'])
-```
-
-Add the corresponding options in your controller:
-```javascript
-$scope.options = {
- content: 'Menu',
- isOpen: false,
- toggleOnClick: true,
- items: [
- {
- content: 'About',
- onclick: function () {console.log('About');}
- }
- ]
-};
-```
-
-Then you are ready to use the directive in your view:
-```html
-<div ng-controller="Controller">
- <circular
- options="options">
- </circular>
-</div>
-```
-
-### Options
-
-The following attributes define the circular navigation menu itself and how to display each item.
-
----
-#### isOpen : boolean (default: `false`)
-Shows if the items are currently displayed or not.
-
----
-#### toggleOnClick : boolean (default: `false`)
-If `true` the menu will close when an item is clicked.
-
----
-#### background : String
-Sets the css attribute `background` for the whole menu.
-
----
-#### color : String
-Sets the css attribute `color` for the whole menu.
-
----
-#### size : String (default: `normal`)
-Possible values: `small, normal, big`
-
-
----
-#### button : Object
-Configuration of the central button which toggles the menu.
-
----
-##### button.content : String
-The text that will be rendered in the button.
-
----
-##### button.cssClass : String
-Adds css classes to the button.
-
----
-##### button.background : String
-Sets the css attribute `background` for the button.
-
----
-##### button.color : String
-Sets the css attribute `color` for the button.
-
----
-##### button.size : String (default: `normal`)
-Possible values: `small, normal, big`
-
-
----
-#### items : Array of Objects
-
----
-##### items.content : String
-The text that will be rendered in this item.
-
----
-##### items.isActive : boolean (default: `false`)
-If `true` the item is rendered more prominent.
-
----
-##### items.onclick : function
-This function will called when the item is clicked and gets the option and the item itself as attribute.
-
----
-##### items.cssClass : String
-Adds css classes to this item.
-
----
-##### items.background : String
-Sets the css attribute `background` for this item.
-
----
-##### items.color : String
-Sets the css attribute `color` for this item.
-
----
-##### button.empty : boolean (default: `false`)
-If `true` the item is not rendered.
-
-
-
-## Development
-
-We use Karma and jshint to ensure the quality of the code. The easiest way to run these checks is to use grunt:
-```sh
-npm install -g bower grunt-cli
-npm install
-grunt
-```
-
-
-## Contributing
-
-Please submit all pull requests the against develop branch. Make sure it passes the CI [![Build Status](https://travis-ci.org/maxklenk/angular-circular-navigation.svg?branch=develop)](https://travis-ci.org/maxklenk/angular-circular-navigation) and add tests to cover your code [![Coverage Status](https://coveralls.io/repos/maxklenk/angular-circular-navigation/badge.png?branch=develop)](https://coveralls.io/r/maxklenk/angular-circular-navigation?branch=develop). Thanks!
-
-## Authors
-
-**Max Klenk**
-
-+ http://github.com/maxklenk
-
-
-
-## Copyright and license
-
- The MIT License
-
- Copyright (c) 2014 Max Klenk
-
- 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.