Added callback for when popover is about to reset
Browse files- readme.md +1 -0
- src/core/overlay.js +5 -0
- src/index.js +2 -0
- types/index.d.ts +5 -0
readme.md
CHANGED
@@ -170,6 +170,7 @@ const driver = new Driver({
|
|
170 |
onHighlightStarted: (Element) {}, // Called when element is about to be highlighted
|
171 |
onHighlighted: (Element) {}, // Called when element is fully highlighted
|
172 |
onDeselected: (Element) {}, // Called when element has been deselected
|
|
|
173 |
});
|
174 |
```
|
175 |
Note that all the button options that you provide in the driver definition can be overridden for a specific step by giving them in the step definition
|
|
|
170 |
onHighlightStarted: (Element) {}, // Called when element is about to be highlighted
|
171 |
onHighlighted: (Element) {}, // Called when element is fully highlighted
|
172 |
onDeselected: (Element) {}, // Called when element has been deselected
|
173 |
+
onReset: () {}, // Called when element has been deselected
|
174 |
});
|
175 |
```
|
176 |
Note that all the button options that you provide in the driver definition can be overridden for a specific step by giving them in the step definition
|
src/core/overlay.js
CHANGED
@@ -132,6 +132,11 @@ export default class Overlay {
|
|
132 |
* @public
|
133 |
*/
|
134 |
clear(immediate = false) {
|
|
|
|
|
|
|
|
|
|
|
135 |
// Deselect the highlighted element if any
|
136 |
if (this.highlightedElement) {
|
137 |
const hideStage = true;
|
|
|
132 |
* @public
|
133 |
*/
|
134 |
clear(immediate = false) {
|
135 |
+
// Callback for when overlay is about to be reset
|
136 |
+
if (this.options.onReset) {
|
137 |
+
this.options.onReset();
|
138 |
+
}
|
139 |
+
|
140 |
// Deselect the highlighted element if any
|
141 |
if (this.highlightedElement) {
|
142 |
const hideStage = true;
|
src/index.js
CHANGED
@@ -38,6 +38,8 @@ export default class Driver {
|
|
38 |
},
|
39 |
onDeselected: () => { // When the element has been deselected
|
40 |
},
|
|
|
|
|
41 |
...options,
|
42 |
};
|
43 |
|
|
|
38 |
},
|
39 |
onDeselected: () => { // When the element has been deselected
|
40 |
},
|
41 |
+
onReset: () => { // When overlay is about to be cleared
|
42 |
+
},
|
43 |
...options,
|
44 |
};
|
45 |
|
types/index.d.ts
CHANGED
@@ -701,6 +701,11 @@ declare module 'driver.js' {
|
|
701 |
* @returns any
|
702 |
*/
|
703 |
onDeselected?: (element: Driver.Element) => void,
|
|
|
|
|
|
|
|
|
|
|
704 |
}
|
705 |
|
706 |
interface ElementOptions extends Driver.DriverOptions {
|
|
|
701 |
* @returns any
|
702 |
*/
|
703 |
onDeselected?: (element: Driver.Element) => void,
|
704 |
+
|
705 |
+
/**
|
706 |
+
* Is called when the overlay is about to reset
|
707 |
+
*/
|
708 |
+
onReset?: () => void,
|
709 |
}
|
710 |
|
711 |
interface ElementOptions extends Driver.DriverOptions {
|