diff --git a/index.html b/index.html index dffcc2c..7602f5c 100644 --- a/index.html +++ b/index.html @@ -642,11 +642,11 @@
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)
+ opacity: 0.75, // Overlay 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
- overlayColor: 'rgb(0,0,0)', // Background color for the overlay element
+ overlayColor: 'rgb(0,0,0)', // Fill color for the overlay
doneBtnText: 'Done', // Text on the final button
closeBtnText: 'Close', // Text on the close button for this step
nextBtnText: 'Next', // Next button text for this step
diff --git a/readme.md b/readme.md
index 5bfa82f..5b64abf 100644
--- a/readme.md
+++ b/readme.md
@@ -260,11 +260,11 @@ Here are the options that Boarding understands:
const boarding = new Boarding({
className: "scoped-class", // className to wrap boarding.js popover
animate: true, // Whether to animate or not
- opacity: 0.75, // Background opacity (0 means only popovers and without overlay)
+ opacity: 0.75, // Overlay opacity (0 means only popovers and without overlay)
padding: 10, // Distance of element from around the edges
allowClose: true, // Whether the click on overlay should close or not
overlayClickNext: false, // Whether the click on overlay should move next
- overlayColor: "rgb(0,0,0)", // Background color for the overlay element
+ overlayColor: "rgb(0,0,0)", // Fill color for the overlay
doneBtnText: "Done", // Text on the final button
closeBtnText: "Close", // Text on the close button for this step
nextBtnText: "Next", // Next button text for this step
diff --git a/src/lib/core/overlay.ts b/src/lib/core/overlay.ts
index fd70718..7a87640 100644
--- a/src/lib/core/overlay.ts
+++ b/src/lib/core/overlay.ts
@@ -38,7 +38,7 @@ export interface OverlayTopLevelOptions {
*/
opacity?: number;
/**
- * Background color for the overlay element
+ * Fill color for the overlay
* @default rgb(0,0,0)
*/
overlayColor?: string;