Skip to content

Commit

Permalink
docs: adjust wordings for overlay options
Browse files Browse the repository at this point in the history
  • Loading branch information
josias-r committed Sep 16, 2024
1 parent a721c92 commit 461b11d
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -642,11 +642,11 @@ <h4>Boarding Definition</h4>
<pre><code class="javascript">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
Expand Down
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/lib/core/overlay.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 461b11d

Please sign in to comment.