https://github.com/rafaelcamargo/ng-surprise

An easy way to put Easter eggs in your AngularJS application
https://github.com/rafaelcamargo/ng-surprise

Last synced: 10 days ago
JSON representation

An easy way to put Easter eggs in your AngularJS application

• Host: GitHub
• URL: https://github.com/rafaelcamargo/ng-surprise
• Owner: rafaelcamargo
• License: mit
• Created: 2015-07-26T15:31:07.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-20T23:05:20.000Z (over 7 years ago)
• Last Synced: 2024-10-13T03:12:33.891Z (about 1 month ago)
• Language: HTML
• Homepage: http://rafaelcamargo.github.io/ng-surprise
• Size: 288 KB
• Stars: 34
• Watchers: 6
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ng-surprise

[![Code Climate](https://codeclimate.com/github/rafaelcamargo/ng-surprise/badges/gpa.svg)](https://codeclimate.com/github/rafaelcamargo/ng-surprise)

[![Test Coverage](https://codeclimate.com/github/rafaelcamargo/ng-surprise/badges/coverage.svg)](https://codeclimate.com/github/rafaelcamargo/ng-surprise/coverage)

[![Build Status](https://travis-ci.org/rafaelcamargo/ng-surprise.svg?branch=master)](https://travis-ci.org/rafaelcamargo/ng-surprise)

This is a AngularJS module to put Easter eggs in your application. Sometimes you need an Easter egg to allow your dev staff to skip some *configuration step* or close an *uncloseable* modal in your app. So, ng-surprise is an easy way to do that.

## Demo

You can see ng-surprise in action on http://rafaelcamargo.github.io/ng-surprise

## Installation

```

npm install ng-surprise --save

```

Once `ng-surprise` dependency is installed, declare the *ngSurprise* module as your app dependency:

```javascript

var app = angular.module('App', ['ngSurprise']);

```

## Usage

Wherever in your application, you can inform an **action** and a **trigger** to be performed:

```html



```


### Action

Should be a function in your scope:

```javascript

$scope.showSomething = function(){

  alert('Gotcha!');

};

```

### Trigger

Should be a sequence of keycodes to be performed by the user. It's not an Array. It should be necessarily a String with keycodes separeted by comma with no spaces between them. The event attribute responsible to inform which code user has performed is `keydown`. You can easily discover the keycodes you want to use as your trigger on the following page: http://www.w3.org/2002/09/tests/keys.html

## Release History

- 2017/05/20 **v0.3.0** : Removed bower.json and locked angular on version 1.4.9

- 2015/08/09 **v0.2.0** : Unit tests added

- 2015/07/29 **v0.1.0** : Initial release *tests still in progress*