outbrain / Postit
Licence: mit
An elegant wrapper for postMessage
Stars: ✭ 52
Programming Languages
javascript
184084 projects - #8 most used programming language
PostIt
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
object
.add(id) => Creates and manages a PostIt
instance (id
).
Param | Type |
---|---|
id | string |
PostIt.add('baz');
object
.remove(id) => Removes a PostIt
instance (id
).
Param | Type |
---|---|
id | string |
PostIt.remove('baz');
object
.removeAll() => Removes all PostIt
instances.
PostIt.removeAll();
number
.size() => Returns the length of all PostIt
instances.
PostIt.size();
object
| void
.get(id) => Gets a PostIt
instance (id
).
Param | Type |
---|---|
id | string |
PostIt.get('baz');
object
.getAll() => Gets all PostIt
instances.
PostIt.getAll();
object
.on(id, event, listener) => 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) {
// ...
});
object
.off(id, event[, listener]) => - If a
listener
is not provided, then unregister all listeners from aPostIt
instance (id
), for a givenevent
. - If a
listener
is provided, then unregister alistener
from aPostIt
instance (id
), for a givenevent
.
Param | Type |
---|---|
id | string |
event | string |
[listener] | function |
PostIt.off('baz', 'bar');
function bazBar() {}
PostIt.off('baz', 'bar', bazBar);
object
.emit(id, event, target, message, origin) => - If
event
is an asterisk (*), then emit anevent
to all listeners registered to aPostIt
instance (id
), for all givenevent
s. - If
event
is not an asterisk (*), then emit anevent
to all listeners registered to aPostIt
instance (id
), for a givenevent
.
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');
object
.openWindow(url, name, options) => 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
Contributing
Changelog
License
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].