@ekolabs/iframily
Advanced tools
Comparing version 0.1.5 to 0.1.6
{ | ||
"name": "@ekolabs/iframily", | ||
"version": "0.1.5", | ||
"version": "0.1.6", | ||
"description": "Modern iframes communication", | ||
@@ -5,0 +5,0 @@ "main": "dist/iframily.min.js", |
@@ -35,3 +35,3 @@ # Iframily | ||
Iframily is a singleton and will allow you to initialize parent/child [iframily instances](#⭒-iframily-singleton). | ||
Iframily is a singleton and will allow you to initialize parent/child [iframily instances](#-iframily-instance). | ||
@@ -42,7 +42,7 @@ #### `Iframily.initParent(id, msgHandler, options) -> iframily instance` | ||
Creates a parent/child [iframily instance](#⭒-iframily-singleton) respectively (to be used in the parent/child frame) and returns it, if successful. | ||
Creates a parent/child [iframily instance](#-iframily-instance) respectively (to be used in the parent/child frame) and returns it, if successful. | ||
| Param | Type | Description | | ||
| :-------------: |:--------------:| :------------| | ||
| id | `string` | A unique id to identify this [iframily instance](#⭒-iframily-singleton), this is used in order to match parent and child iframilies. Will abort and log an error if the id already exists in the current frame. | | ||
| id | `string` | A unique id to identify this [iframily instance](#-iframily-instance), this is used in order to match parent and child iframilies. Will abort and log an error if the id already exists in the current frame. | | ||
| msgHandler | `function` | Optional - A handler for incoming messages from the paired iframily in the parent/child frame. The `msgHandler` can return back a response value or a promise that will be resolved/rejected with a response value. | | ||
@@ -49,0 +49,0 @@ | options | `object` | Optional - Additional options, see possible options below: | |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
20635