traitify-widgets 3.0.0-alpha.9 → 3.0.0

package/README.md

@@ -117,8 +117,27 @@ export default function Personality({id}) {
 
 ## Events
 
-Most components trigger an initialized and updated event. Some components offer additional events. Event handlers must be set before the render command, or they will not be called.
+- Most components trigger an initialized and updated event
+- Event handlers must be set before the render command or they will not be called
+- Some events may fire multiple times, once for each target specified (such as the Survey and Results)
 
+The widgets are capable of showing multiple kinds of surveys to users in order to satisfy benchmark requirements. To handle the event when all surveys have been finished you should use this event:
+
+```
+Traitify.listener.on("Surveys.finished", (surveys) => {
+  console.log("Surveys.finished", surveys);
+});
+```
+
+To handle the event when each survey has been finished, maybe to record total progress in a backend system:
+
+```
+Traitify.listener.on("Survey.finished", ({response}) => {
+  console.log("Survey.finished", response);
+});
+```
+
+Here are some other events that can be handled:
 ```
 Traitify.listener.on("Survey.initialized", () => {
   console.log("Survey.initialized");
@@ -129,14 +148,11 @@ Traitify.listener.on("Survey.updated", () => {
 });
 
 Traitify.listener.on("Survey.updateSlide", ({response}) => {
-  console.log("Survey.finished", response);
-});
-
-Traitify.listener.on("Survey.finished", ({response}) => {
-  console.log("Survey.finished", response);
+  console.log("Survey.updateSlide", response);
 });
 ```
 
+
 ## Options
 
 ### Internationalization Options