docs: update documentation to include overlayColor option

josias-r · Aug 1, 2024 · 2f35468 · 2f35468
1 parent ab2a2f9
commit 2f35468
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/index.html b/index.html
@@ -646,6 +646,7 @@ <h4>Boarding Definition</h4>
   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
   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
@@ -264,6 +264,7 @@ const boarding = new Boarding({
   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
   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