chore!: rename onHighlightStarted to onBeforeHighlighted to make …

…the naming more intuitive
josias-r · Nov 3, 2022 · d530133 · d530133
1 parent 8ae590d
commit d530133
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/index.html b/index.html
@@ -521,7 +521,7 @@ <h4>Boarding Definition</h4>
   showButtons: false, // Do not show control buttons in footer
   keyboardControl: true, // Allow controlling through keyboard (escape to close, arrow keys to move)
   scrollIntoViewOptions: {}, // We use `scrollIntoView()` when possible, pass here the options for it if you want any
-  onHighlightStarted: (Element) {}, // Called when element is about to be highlighted
+  onBeforeHighlighted: (Element) {}, // Called when element is about to be highlighted
   onHighlighted: (Element) {}, // Called when element is fully highlighted
   onDeselected: (Element) {}, // Called when element has been deselected
   onReset: (Element) {},        // Called when overlay is about to be cleared

diff --git a/readme.md b/readme.md
@@ -260,7 +260,7 @@ const boarding = new Boarding({
   showButtons: false, // Do not show control buttons in footer
   keyboardControl: true, // Allow controlling through keyboard (escape to close, arrow keys to move)
   scrollIntoViewOptions: {}, // We use `scrollIntoView()` when possible, pass here the options for it if you want any
-  onHighlightStarted: (HighlightElement) => {}, // Called when element is about to be highlighted
+  onBeforeHighlighted: (HighlightElement) => {}, // Called when element is about to be highlighted
   onHighlighted: (HighlightElement) => {}, // Called when element is fully highlighted
   onDeselected: (HighlightElement) => {}, // Called when element has been deselected
   onReset: (HighlightElement) => {}, // Called when overlay is about to be cleared

diff --git a/src/lib/boarding.ts b/src/lib/boarding.ts
@@ -454,8 +454,8 @@ class Boarding {
       highlightDomElement: domElement,
       options: {
         scrollIntoViewOptions: this.options.scrollIntoViewOptions,
-        onHighlightStarted:
-          currentStep.onHighlightStarted || this.options.onHighlightStarted,
+        onBeforeHighlighted:
+          currentStep.onBeforeHighlighted || this.options.onBeforeHighlighted,
         onHighlighted: currentStep.onHighlighted || this.options.onHighlighted,
         onDeselected: currentStep.onDeselected || this.options.onDeselected,
         onNext: currentStep.onNext || this.options.onNext,

diff --git a/src/lib/core/highlight-element.ts b/src/lib/core/highlight-element.ts
@@ -14,7 +14,7 @@ export interface HighlightElementHybridOptions
   /**
    * Callback to be called when element is about to be highlighted
    */
-  onHighlightStarted?: (element: HighlightElement) => void;
+  onBeforeHighlighted?: (element: HighlightElement) => void;
   /**
    * Callback to be called when element has been highlighted
    */
@@ -96,8 +96,8 @@ class HighlightElement {
   /**
    * Is called when the element is about to be highlighted
    */
-  public onHighlightStarted() {
-    this.options.onHighlightStarted?.(this);
+  public onBeforeHighlighted() {
+    this.options.onBeforeHighlighted?.(this);
   }
 
   /**

diff --git a/src/lib/core/overlay.ts b/src/lib/core/overlay.ts
@@ -84,7 +84,7 @@ class Overlay {
     // window.clearTimeout(this.hideTimer);
 
     // Trigger the hook for highlight started
-    element.onHighlightStarted();
+    element.onBeforeHighlighted();
 
     // Old element has been deselected
     if (