@hoory/embed - npm Package Compare versions

Comparing version 1.0.23 to 1.0.24

package.json

 {
   "name": "@hoory/embed",
-  "version": "1.0.23",
+  "version": "1.0.24",
   "private": false,
@@ -5,0 +5,0 @@ "description": "Hoory script embedder",

README.md

@@ -79,4 +79,127 @@ <p align="center">
 
+## API
+
+<h3>Controller functions:</h3>
+
+<table style="width: 100%; border: 1px solid #a6a6a6">
+<thead>
+  <th style="padding: 12px;text-align: left;border-bottom: 1px solid #a6a6a6;background: #f1f1f1;">
+    Function
+  </th>
+  <th style="padding: 12px;text-align: left;border-bottom: 1px solid #a6a6a6;background: #f1f1f1;">
+    Description
+  </th>
+</thead>
+<tbody>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      showButton
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      to show toggle button
+    </td>
+  </tr>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      hideButton
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      to hide toggle button
+    </td>
+  </tr>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      openChat
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      to open chat frame
+    </td>
+  </tr>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      closeChat
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      to close chat frame
+    </td>
+  </tr>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      setUserInfo
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      to set user information after an async action
+    </td>
+  </tr>
+</tbody>
+</table>
+
+<hr />
+
+<h3>Callback functions:</h3>
+
+<table style="width: 100%;border: 1px solid #a6a6a6;">
+<thead>
+  <th style="padding: 12px;text-align: left;border-bottom: 1px solid #a6a6a6;background: #f1f1f1;">
+    Callback Function
+  </th>
+  <th style="padding: 12px;text-align: left;border-bottom: 1px solid #a6a6a6;background: #f1f1f1;" >
+    Description
+  </th>
+</thead>
+<tbody>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      onChatOpen
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      will be called after chat open
+    </td>
+  </tr>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      onChatClose
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      will be called after chat close
+    </td>
+  </tr>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      onShowButton
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      will be called after toggle button shown
+    </td>
+  </tr>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      onHideButton
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      will be called after toggle button goes hidden
+    </td>
+  </tr>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      onChatInit
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      will be called after chat initialized
+    </td>
+  </tr>
+  <tr>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      onScriptLoad
+    </td>
+    <td style="padding: 8px;border-bottom: 1px solid #eaeaea">
+      will be called after hoory embed scripts are loaded
+    </td>
+  </tr>
+</tbody>
+</table>
+
+
 ## Contributing Guidelines
 
 Read through our [Contributing guidelines](https://github.com/orgs/hoory-com/teams/hoory-business/discussions/1) to learn about our submission process, coding rules and more

No alert changes

Improved metrics

Total package byte prevSize

14115

increased by29.03%

Number of lines in readme file

205

increased by150%

No dependency changes