traitify-widgets 1.10.2 → 1.12.0-alpha.1

package/README.md

@@ -22,11 +22,13 @@ The widgets can be installed through our CDN or npm. Usage through the CDN will
 ### npm
 
 #### Installation
+
 ```
 npm i --save traitify-widgets
 ```
 
 #### Usage
+
 ```
 import traitify from "traitify-widgets";
 
@@ -43,26 +45,31 @@ assessment.render();
 ### All Decks
 
 #### SlideDeck
+
 ```
 assessment.render("SlideDeck"); // Render just the SlideDeck in the target element
 ```
 
 #### Results
+
 ```
 assessment.render("Results"); // Render just the Results in the target element
 ```
 
 #### Personality Types/Dimensions
+
 ```
 assessment.render("PersonalityTypes"); // Render just the Type/Dimensions in the target element
 ```
 
 #### Personality Traits
+
 ```
 assessment.render("PersonalityTraits"); // Render just the Traits in the target element
 ```
 
 #### Personality Details
+
 ```
 assessment.render("PersonalityDetails"); // Render just the details in the target element
 ```
@@ -70,6 +77,7 @@ assessment.render("PersonalityDetails"); // Render just the details in the targe
 ### Type Based Decks (ex. career-deck, core, heroes)
 
 #### Personality Blend
+
 ```
 assessment.render("PersonalityBlend"); // Render just the Blend in the target element
 ```
@@ -77,6 +85,7 @@ assessment.render("PersonalityBlend"); // Render just the Blend in the target el
 ### Careers Deck Components (career-deck)
 
 #### Render All Career Components
+
 ```
 assessment.render("Careers"); // Render all the career components
 ```
@@ -84,16 +93,19 @@ assessment.render("Careers"); // Render all the career components
 #### Specific Career Components
 
 #### Career Filter
+
 ```
 assessment.render("CareerFilter"); // Render the career filter
 ```
 
 #### Career Results
+
 ```
 assessment.render("CareerResults"); // Render the career list
 ```
 
 #### Career Modal
+
 ```
 assessment.render("CareerModal"); // Render the career modal
 ```
@@ -101,6 +113,7 @@ assessment.render("CareerModal"); // Render the career modal
 ### Additional Career Component Customizations
 
 #### Add content to the Career Filter
+
 ```
 // Add content to the career filter
 Traitify.ui.on("CareerFilter.updated", function(context){
@@ -109,6 +122,7 @@ Traitify.ui.on("CareerFilter.updated", function(context){
 ```
 
 #### Add content to the Career Modal
+
 ```
 // Add content to the career modal
 Traitify.ui.on("CareerModal.updated", function(context){
@@ -118,23 +132,28 @@ Traitify.ui.on("CareerModal.updated", function(context){
 ```
 
 #### Trigger a refresh of the career results with different params
+
 ```
 // Update parameters and re-request careers
 Traitify.ui.trigger("Careers.mergeParams", this, {experienceLevels: [4, 5], page: 1});
 ```
 
 #### Get your careers from a different endpoint
+
 This is useful if you want to get the career results server side and modify the data returned or just want to proxy through your own server.
+
 ```
 Traitify.ui.options.careerOptions.path = "/my-career-endpoint";
 ```
 
 #### Change which experience levels are in the filter
+
 ```
 Traitify.ui.options.careerOptions.experienceLevels = [4, 5];
 ```
 
 #### Change how many results to show per page
+
 ```
 Traitify.ui.options.careerOptions.perPage = 10;
 ```
@@ -142,88 +161,99 @@ Traitify.ui.options.careerOptions.perPage = 10;
 ### Dimension Based Decks (big-five)
 
 #### Radar Graph
+
 ```
 assessment.render("Radar"); // Render just the Radar graph in the target element
 ```
 
 #### Personality Heading
+
 ```
 assessment.render("PersonalityHeading"); // Render just the archetype in the target element
 ```
 
 ### Interview Guide
+
 #### Interview questions for big-five assessments
+
 ```
 assessment.render("Guide"); // Given an assessmentID with results, render just the Interview in the target element
 ```
 
 ### Render multiple components in specific elements
+
 ```
-  assessment.targets({
-    "SlideDeck": "#slide-deck",
-    "PersonalityTypes": "#personality-types",
-    "PersonalityTraits": "#personality-traits",
-    "Results": "#results",
-    "Careers": "#careers",
-    "Guide": "#guide",
-  });
+assessment.targets({
+  "SlideDeck": "#slide-deck",
+  "PersonalityTypes": "#personality-types",
+  "PersonalityTraits": "#personality-traits",
+  "Results": "#results",
+  "Careers": "#careers",
+  "Guide": "#guide",
+});
 
-  assessment.render();
+assessment.render();
 ```
 
 ## Events
+
 ```
-  // Event handlers must be set before the render command, or they will not be called.
-  assessment.on("SlideDeck.Finished", function(){
-    console.log("SlideDeck.Finished");
-  });
+// Event handlers must be set before the render command, or they will not be called.
+assessment.on("SlideDeck.Finished", function(){
+  console.log("SlideDeck.Finished");
+});
 
-  assessment.on("SlideDeck.Initialized", function(){
-    console.log("SlideDeck.Initialized");
-  });
+assessment.on("SlideDeck.Initialized", function(){
+  console.log("SlideDeck.Initialized");
+});
 
-  assessment.on("SlideDeck.IsReady", function(){
-    console.log("SlideDeck.IsReady");
-  });
+assessment.on("SlideDeck.IsReady", function(){
+  console.log("SlideDeck.IsReady");
+});
 
-  assessment.on("SlideDeck.UpdateSlide", function(event, slideResponse){
-    console.log("SlideDeck.UpdateSlide");
-    console.log(slideResponse);
-  });
+assessment.on("SlideDeck.UpdateSlide", function(event, slideResponse){
+  console.log("SlideDeck.UpdateSlide");
+  console.log(slideResponse);
+});
 
-  assessment.on("SlideDeck.BackSlide", function(){
-    console.log("SlideDeck.BackSlide");
-  });
+assessment.on("SlideDeck.BackSlide", function(){
+  console.log("SlideDeck.BackSlide");
+});
 
-  assessment.on("SlideDeck.Fullscreen", function(event, isFullScreen){
-    console.log("SlideDeck.Fullscreen");
-    console.log(isFullScreen);
-  });
+assessment.on("SlideDeck.Fullscreen", function(event, isFullScreen){
+  console.log("SlideDeck.Fullscreen");
+  console.log(isFullScreen);
+});
 
-  assessment.on("Results.Initialized", function(){
-    console.log("Results.Initialized");
-  });
+assessment.on("Results.Initialized", function(){
+  console.log("Results.Initialized");
+});
 
-  assessment.on("PersonalityTypes.Initialized", function(){
-    console.log("PersonalityTypes.Initialized");
-  });
+assessment.on("PersonalityTypes.Initialized", function(){
+  console.log("PersonalityTypes.Initialized");
+});
 
-  assessment.on("PersonalityTraits.Initialized", function(){
-    console.log("PersonalityTraits.Initialized");
-  });
+assessment.on("PersonalityTraits.Initialized", function(){
+  console.log("PersonalityTraits.Initialized");
+});
 ```
 
 ## Options
+
 ### Internationalization Options
+
 ```
 // Set globally
 Traitify.ui.setLocale("es-us");
 ```
+
 or
+
 ```
 // Set just for the instance of the widget
 assessment.locale("nl-nl");
 ```
+
 Here is a list of the available locales (`en-us` is the default):
   - Chinese - `zh-cn`
   - Creole - `ht-us`
@@ -239,31 +269,68 @@ Here is a list of the available locales (`en-us` is the default):
   - Swedish - `sv-se`
 
 ### Render a back button to allow users to change answers during the test
+
 ```
-  assessment.allowBack();
+assessment.allowBack();
 ```
 
 ### Allow the user to click a button to go full screen
+
 ```
-  assessment.allowFullscreen();
+assessment.allowFullscreen();
 ```
 
 ### Allow the user to view section results section headers
+
 ```
-  assessment.allowHeaders();
+assessment.allowHeaders();
 ```
 
 ### Render results using specific perspective
+
 \* currently only the `big-five` assessment has perspective content
+
 ```
-  assessment.perspective("firstPerson");
+assessment.perspective("firstPerson");
 
-  OR
+OR
 
-  assessment.perspective("thirdPerson");
+assessment.perspective("thirdPerson");
+```
+
+## Reports
+
+Set the perspective and view options to display our Big Five Personality Reports.
+
+### Big Five Hiring Manager Report
+
+```
+assessment.perspective("thirdPerson");
+assessment.view("manager");
+```
+
+This report also makes use of a benchmark/recommendation. It will default to the benchmark used to create an assessment. To use a different benchmark, you can pass the ID as an option.
+
+```
+assessment.benchmarkID(benchmarkID);
+```
+
+### Big Five Candidate Report
+
+```
+assessment.perspective("firstPerson");
+assessment.view("candidate");
+```
+
+### Engage Employee Report
+
+```
+assessment.perspective("thirdPerson");
+assessment.view("employee");
 ```
 
 ## Traitify Client
+
 We expose our JavaScript api client that you can use to make additional calls to our API from the client side. We make available `get`, `put`, and `post` functions. These methods will use the api key and url you configured when you initialized the Traitify library. Here is an example that returns career matches for a `career-deck` assessment. Further documentation on the API methods available can be found at https://app.traitify.com/developer/documentation.
 
 ```