Git Product home page Git Product logo

angular-post-message's Introduction

AngularJS postMessage API

Allow angularJS to listen and publish cross-document messages though window.postMessage API.

Cross-document messaging is compatible with the following browsers as seen on Can I Use:

  • Internet Explorer 8+
  • Firefox 3+
  • Chrome 4+
  • Safari 4+
  • Opera 9.5+
  • iOS Safari 3.2+
  • Opera Mini 5+
  • Android Browser 2.1+
  • Blackberry Browser 7+
  • Opera Moble 10+
  • Chrome for Android 30+
  • Firefox for Android 25+
  • Internet Exploer Mobile 10+

Partial support in IE8-9 refers to only working in frames/iframes (not other tabs/windows). Also in IE 9 and below an object cannot be sent using postMessage. Partial support in IE10 refers to limitations in certain conditions

Tested on AngularJS versions 1.2, 1.3 and 1.4 in Chrome, Firefox, Opera, and IE9+.

IE8 is not officially supported by AngularJS

Installation

The repository comes with the modules pre-built and compressed into the dist/ directory.

Install the component via bower

bower install angular-post-message

Or alternatively checkout this repo into your project.

Then include dist/angular-post-message.min.js into your project.

Example

This is a simple example which uses postMessage to deliver messages between two origins. There is a gist which will deliver a message every second

index.html

<html>
  <head>
    <script src="bower_components/angular/angular.js"></script>
    <script src="bower_components/angular-post-message/angular-post-message.js"></script>
  </head>
  <body>
    <iframe src="https://rawgit.com/kylewelsby/585b3a5395c6731acc50/raw/f661e856adbccf39549ed7c550661f09158f8d55/index.html"></iframe>
    <br>
    <button ng-click="sendMessage();">Send response</button>
    <br>
    <ol>
      <li ng-repeat="message in messages">{{message}}</li>
    </ol>
  </body>
</html>

app.js

var app = angular.module('app',['ngPostMessage']);
app.controller('MainCtrl', function($scope) {
  $scope.messages = [];
  $scope.$root.$on('$messageIncoming', function (event, data){
    $scope.messages.push(angular.fromJson(data));
  });
  $scope.sendMessage = function (){
    $scope.$emit(
      '$messageOutgoing',
      angular.toJson({"response":"hi"})
    );
  };
});

Development

You do not need to build the project to use it, but if you are working on it then this is what you need to know.

Requirements

Testing

To run all the tests

npm test

To run tests while developing (limited to latest Angular version on Google Chrome)

karma start

or run tests once

./scripts/ci

angular-post-message's People

Contributors

kylewelsby avatar royts avatar benmarch avatar veewee avatar yonatankarni avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.