神刀安全网

An elegant wrapper for postMessage.

PostIt

An elegant wrapper for .postMessage .

An elegant wrapper for postMessage.

Installation

Install postit-js as a dependency.

$ npm install --save postit-js

Run PostIt in a Browser

HTML Script Element

<script src="path/to/postit.js"></script>

CommonJS Browser Shimming (Browserify and Other Flavors)

var PostIt = require('postit');

API Documentation

.add(id) => object

Creates and manages a PostIt instance ( id ).

Param Type
id string
PostIt.add('baz');

.remove(id) => object

Removes a PostIt instance ( id ).

Param Type
id string
PostIt.remove('baz');

.removeAll() => object

Removes all PostIt instances.

PostIt.removeAll();

.size() => number

Returns the length of all PostIt instances.

PostIt.size();

.get(id) => object | void

Gets a PostIt instance ( id ).

Param Type
id string
PostIt.get('baz');

.getAll() => object

Gets all PostIt instances.

PostIt.getAll();

.on(id, event, listener) => object

Registers a listener to a PostIt instance ( id ), for a given event .

Param Type
id string
event string
listener function
PostIt.on('baz', 'bar', function(event) {     // ... });

.off(id, event[, listener]) => object

  • If a listener is not provided, then unregister all listeners from a PostIt instance ( id ), for a given event .
  • If a listener is provided, then unregister a listener from a PostIt instance ( id ), for a given event .
Param Type
id string
event string
[listener] function
PostIt.off('baz', 'bar');  function bazBar() {}  PostIt.off('baz', 'bar', bazBar);

.emit(id, event, target, message, origin) => object

  • If event is an asterisk (*), then emit an event to all listeners registered to a PostIt instance ( id ), for all given event s.
  • If event is not an asterisk (*), then emit an event to all listeners registered to a PostIt instance ( id ), for a given event .
Param Type
id string
event string
target object
message string array object
origin string
PostIt.emit('baz', 'bar', window.parent.opener, { baz: 'bar' }, 'http://www.baz.com');

.openWindow(url, name, options) => object

Loads a resource into a new browsing context ( window ).

Param Type
url string
name string
options object
options.width number
options.height number

See: window.open for more options.

PostIt.openWindow('http://www.foo.com', 'foo', {     width: 700,     height: 500 });

Example

Example

Contributing

Contributing

Changelog

Changelog

License

MIT License

转载本站任何文章请注明:转载至神刀安全网,谢谢神刀安全网 » An elegant wrapper for postMessage.

分享到:更多 ()

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址