@soyio/soyio-widget 0.0.1 → 0.0.2

package/README.md

@@ -1,2 +1,33 @@
 # soy-io-widget
-This is the library for include a soyio widget
+This is the library for include a soyio widget.
+
+This library contemplate that an iframe with the ID: soyio-widget-iframe should be created before instantiate the widget.
+
+## How to work
+
+For frontend frameworks, this should be imported as follows.
+
+``` VUE
+<script>
+import Widget from '@soyio/soyio-widget'
+
+// Vue syntax
+onMounted(() => {
+  const widget = new Widget()
+})
+</script>
+<template>
+  <iframe id="soyio-widget-iframe"></iframe>
+</template>
+
+```
+
+The widget class receive the following object:
+
+```JS
+{
+  userEmail?: string
+}
+```
+
+And if there is an email this is sended to the iframe.

package/dist/constants.d.ts

@@ -1,2 +1,2 @@
 export declare const IFRAME_ID = "soyio-widget-iframe";
-export declare const DEVELOPMENT_WIDGET_URL = "https://pl-soyio-staging-7a391ba45b99.herokuapp.com";
+export declare const DEVELOPMENT_WIDGET_URL = "https://pl-soyio-staging-7a391ba45b99.herokuapp.com/widget";

package/dist/events.d.ts

@@ -0,0 +1,3 @@
+declare function setReady(iframe: HTMLIFrameElement): void;
+declare function configUser(iframe: HTMLIFrameElement, userEmail: string): void;
+export { setReady, configUser };

package/dist/index.d.ts

@@ -1,4 +1,10 @@
-declare const soyioWidget: {
-    create(): HTMLIFrameElement;
-};
-export default soyioWidget;
+interface WidgetProps {
+    userEmail?: string;
+}
+declare class Widget {
+    private iframe;
+    userEmail?: string;
+    constructor({ userEmail }: WidgetProps);
+    initialize(): void;
+}
+export default Widget;