diff --git a/index.html b/index.html index 232e739..2b6b954 100644 --- a/index.html +++ b/index.html @@ -509,9 +509,9 @@
Here are the options that Boarding understands
const boarding = new Boarding({
className: 'scoped-class', // className to wrap boarding.js popover
- animate: true, // Animate while changing highlighted element
- opacity: 0.75, // Background opacity (0 means only popovers and without overlay)
- padding: 10, // Distance of element from around the edges
+ animate: true, // Animate while changing highlighted element
+ opacity: 0.75, // Background opacity (0 means only popovers and without overlay)
+ padding: 10, // Distance of element from around the edges
allowClose: true, // Whether clicking on overlay should close or not
overlayClickNext: false, // Should it move to next step on overlay click
doneBtnText: 'Done', // Text on the final button
@@ -524,9 +524,11 @@ Boarding Definition
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
- onNext: (Element) => {}, // Called when moving to next step on any step
- onPrevious: (Element) => {}, // Called when moving to next step on any step
+ onReset: (Element) {}, // Called when overlay is about to be cleared
+ onNext: (Element) => {}, // Called when moving to next step on any step
+ onPrevious: (Element) => {}, // Called when moving to next step on any step
+ strictClickHandling: "block-all", // Can also be `true` or if not wanted at all, `false`. Either block ALL pointer events, or isolate pointer-events to only allow on the highlighted element (`true`). Popover and overlay pointer-events are of course always allowed to be clicked
+
});
diff --git a/readme.md b/readme.md
index e30034b..8bf4b76 100644
--- a/readme.md
+++ b/readme.md
@@ -260,12 +260,13 @@ 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
- onBeforeHighlighted: (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
onNext: (HighlightElement) => {}, // Called when moving to next step on any step
onPrevious: (HighlightElement) => {}, // Called when moving to previous step on any step
+ strictClickHandling: true, // Can also be `"block-all"` or if not wanted at all, `false`. Either block ALL pointer events, or isolate pointer-events to only allow on the highlighted element (`true`). Popover and overlay pointer-events are of course always allowed to be clicked
});
```