Never Print Magazines

    angular-eha.back-button

    3.10.1 • Public • Published

    angular-eha.back-button

    Build Status Dependecy Status Dev Dependecy Status

    Angular.js <eha-back-button /> Back button directive. Provides a simple interface to window.history.

    Optionally supports transitioning to ui.router states if $state is available as an injectable and a valid state name is passed as an attribute, you can even pass parameters e.g.

    <eha-back-button state="validState" params="someParams"/>

    Usage

    Installation

    Install with npm:

    npm install --save angular-eha.back-button
    

    Or alternatively bower:

    bower install --save angular-eha.back-button
    

    The distribution bundle comes in 2 flavours, one with templates, one without - as well as providing both minified and unminfied versions of both, so take your pick:

    • dist/angular-eha.back-button.js
    • dist/angular-eha.back-button.min.js
    • dist/angular-eha-back-button.template.js (default)
    • dist/angular-eha-back-button.template.min.js

    Then simply add eha.back-button as a dependency somewhere in your project that makes sense and you're ready to time travel.

    A note on wiredep

    If you're using wiredep dist/angular-eha.back-button.template.js will be injected by default. If you don't want that to happen you'll like want to employ something along the following lines in your Gruntfile:

    wiredep: {
     ...
      options: {
        exclude: [
          'bower_components/angular-eha.back-button/dist/angular-eha.back-button.templates.js'
        ]
      }
      ...
    }

    Then you're free to include whichever bundle you prefer in what ever manner you prefer.

    Example

    <html ng-app="backButtonExample">
      <head>
        <title>Back Button Example</title>
        <script src="bower_components/angular/angular.js"></script> 
        <script src="bower_components/angular/angular-eha.back-button.js"></script> 
        <script>
        angular.module('backButtonExample', [
            'eha.back-button.directive'
        ]);
        </script> 
      </head>
      <body>
        <eha-back-button />
      </body>
    </html>

    Contributing

    Prerequisites

    • Firefox (for running test suite)
    • node (0.12.0)
    • bower (1.3.12)
    • grunt-cli (0.1.7)
    • grunt (0.4.5)

    Installation

    # Fork the upstream repo on github and pull down your fork 
    git clone git@github.com:yourusername/angular-eha.back-button.git
    cd angular-eha.back-button.git
    # Add the upstream as a remote 
    git remote add upstream  git@github.com:eHealthAfrica/angular-eha.back-button.git
    # Install the dev dependencies 
    npm install

    Docs

    Code should be documented following the guidelines set out by jsdoc and ngdoc. We can then leverage Dgeni or something simlary to generate documentation in any format we like.

    Test Suite

    The test suite is configured to run in Firefox and is powered by:

    • Karma
    • Mocha
    • Chai (as promised)
    • Sinon (chai)

    The library is conducive to TDD. grunt test:watch is your friend. As modules (and templates) are exposed on their own namespaces you can easily isolate areas of the codebase for true unit testing without being forced to pull in the whole library or stub/mock modules irrelevent to the feature(s) you're testing.

    Running Tests

    Single run
    grunt test
    Watch
    grunt test:watch

    Transpiling templates (html2js)

    Transpiling our html templates into js allows us to neatly push them into the $templateCache.

    To transpile the templates it's another simple grunt command:

    grunt templates

    This will compile the templates to the dist/ folder. But it's probably best to avoid this all together. Both the grunt test and grunt release commands take care of all of this for you.

    If you need to override the default template, simply replace what's already in the $templateCache with what ever you want. One way to achieve this is like this:

    <script id="templates/back-button.directive.tpl.html" type="text/html">
        <button>I'm a button!</button>
    </script> 

    Release Process

    To make a release, ensure you have issued grunt build, committed the distribution package and tagged the commit with an appropriate version according to the SemVer spec.

    To make this easy for you, there's a handy grunt task. Simply issue grunt release:major|minor|patch and grunt will take care of building, committing and tagging for you. Then make a PR to the master branch of the upstream, merge upon CI build success and then all that's left to do is to push the tags to the upstream.

    e.g:

      grunt release:minor
      git pull-request -b eHealthAfrica:master

    Publishing to npm

    To publish a new version to npm, simply issue from the command line prior making a release (i.e.issuing a grunt release and pushing both commits and tags to the upstream):

    npm publish
    

    Publishing to bower

    Publishing to bower is slightly simpler in so far that you only have to do it once, and not explicitly for every release like npm:

    e.g.

    bower register angular-eha.back-button https://github.com/eHealthAfrica/angular-eha.back-button.git
    

    License

    Copyright 2015 Matt Richards

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    Install

    npm i angular-eha.back-button

    DownloadsWeekly Downloads

    5

    Version

    3.10.1

    License

    Apache-2.0

    Last publish

    Collaborators