Add missing access specifiers

src/core/element.js

@@ -39,6 +39,7 @@ export default class Element {
   /**
    * Gets the screen co-ordinates (x,y) for the current dom element
    * @returns {{x: number, y: number}}
+   * @private
    */
   getScreenCoordinates() {
     let tempNode = this.node;
@@ -59,6 +60,7 @@ export default class Element {
   /**
    * Checks if the current element is visible in viewport
    * @returns {boolean}
+   * @private
    */
   isInView() {
     let top = this.node.offsetTop;
@@ -84,6 +86,7 @@ export default class Element {
 
   /**
    * Manually scrolls to the position of element if `scrollIntoView` fails
+   * @private
    */
   scrollManually() {
     const elementRect = this.node.getBoundingClientRect();
@@ -95,6 +98,7 @@ export default class Element {
 
   /**
    * Brings the element to middle of the view port if not in view
+   * @private
    */
   bringInView() {
     if (this.isInView()) {
@@ -121,6 +125,7 @@ export default class Element {
   /**
    * Gets the calculated position on screen, around which
    * we need to draw
+   * @public
    */
   getCalculatedPosition() {
     const coordinates = this.getScreenCoordinates();
@@ -146,6 +151,7 @@ export default class Element {
   /**
    * Is called when element is about to be deselected
    * i.e. when moving the focus to next element of closing
+   * @public
    */
   onDeselected(hideStage = false) {
     this.hidePopover();
@@ -168,6 +174,7 @@ export default class Element {
    * Checks if the given element is same as the current element
    * @param {Element} element
    * @returns {boolean}
+   * @public
    */
   isSame(element) {
     if (!element || !element.node) {
@@ -179,6 +186,7 @@ export default class Element {
 
   /**
    * Is called when the element is about to be highlighted
+   * @public
    */
   onHighlightStarted() {
     if (this.options.onHighlightStarted) {
@@ -188,6 +196,7 @@ export default class Element {
 
   /**
    * Is called when the element has been successfully highlighted
+   * @public
    */
   onHighlighted() {
     this.showPopover();
@@ -213,6 +222,7 @@ export default class Element {
 
   /**
    * Shows the stage behind the element
+   * @public
    */
   showStage() {
     this.stage.show(this.getCalculatedPosition());
@@ -221,15 +231,24 @@ export default class Element {
   /**
    * Gets the DOM Element behind this element
    * @returns {Node|HTMLElement|*}
+   * @public
    */
   getNode() {
     return this.node;
   }
 
+  /**
+   * Hides the stage
+   * @public
+   */
   hideStage() {
     this.stage.hide();
   }
 
+  /**
+   * Hides the popover if possible
+   * @public
+   */
   hidePopover() {
     if (!this.popover) {
       return;
@@ -240,6 +259,7 @@ export default class Element {
 
   /**
    * Shows the popover on the current element
+   * @public
    */
   showPopover() {
     if (!this.popover) {
@@ -262,6 +282,7 @@ export default class Element {
 
   /**
    * @returns {{height: number, width: number}}
+   * @public
    */
   getFullPageSize() {
     // eslint-disable-next-line prefer-destructuring
@@ -277,6 +298,7 @@ export default class Element {
   /**
    * Gets the size for popover
    * @returns {{height: number, width: number}}
+   * @public
    */
   getSize() {
     return {

src/core/overlay.js

@@ -26,6 +26,7 @@ export default class Overlay {
 
   /**
    * Prepares the overlay
+   * @private
    */
   makeNode() {
     let pageOverlay = this.document.getElementById(ID_OVERLAY);
@@ -47,6 +48,7 @@ export default class Overlay {
   /**
    * Highlights the dom element on the screen
    * @param {Element} element
+   * @public
    */
   highlight(element) {
     if (!element || !element.node) {
@@ -86,6 +88,10 @@ export default class Overlay {
     this.highlightedElement.onHighlighted();
   }
 
+  /**
+   * Shows the overlay on whole screen
+   * @public
+   */
   show() {
     if (this.node && this.node.parentElement) {
       return;
@@ -106,6 +112,7 @@ export default class Overlay {
   /**
    * Returns the currently selected element
    * @returns {null|*}
+   * @public
    */
   getHighlightedElement() {
     return this.highlightedElement;
@@ -114,6 +121,7 @@ export default class Overlay {
   /**
    * Gets the element that was highlighted before current element
    * @returns {null|*}
+   * @public
    */
   getLastHighlightedElement() {
     return this.lastHighlightedElement;
@@ -121,6 +129,7 @@ export default class Overlay {
 
   /**
    * Removes the overlay and cancel any listeners
+   * @public
    */
   clear(immediate = false) {
     // Deselect the highlighted element if any
@@ -149,6 +158,7 @@ export default class Overlay {
 
   /**
    * Removes the overlay node if it exists
+   * @private
    */
   removeNode() {
     if (this.node && this.node.parentElement) {
@@ -159,6 +169,7 @@ export default class Overlay {
   /**
    * Refreshes the overlay i.e. sets the size according to current window size
    * And moves the highlight around if necessary
+   * @public
    */
   refresh() {
     // If no highlighted element, cancel the refresh

src/core/popover.js

@@ -47,6 +47,7 @@ export default class Popover extends Element {
 
   /**
    * Prepares the dom element for popover
+   * @private
    */
   makeNode() {
     let popover = this.document.getElementById(ID_POPOVER);
@@ -65,10 +66,18 @@ export default class Popover extends Element {
     this.closeBtnNode = popover.querySelector(`.${CLASS_CLOSE_BTN}`);
   }
 
+  /**
+   * Hides the popover
+   * @public
+   */
   hide() {
     this.node.style.display = 'none';
   }
 
+  /**
+   * Sets the default state for the popover
+   * @private
+   */
   setInitialState() {
     this.node.style.display = 'block';
     this.node.style.left = '0';
@@ -85,6 +94,7 @@ export default class Popover extends Element {
   /**
    * Shows the popover at the given position
    * @param {Position} position
+   * @public
    */
   show(position) {
     this.setInitialState();
@@ -119,6 +129,7 @@ export default class Popover extends Element {
   /**
    * Enables, disables buttons, sets the text and
    * decides if to show them or not
+   * @private
    */
   renderButtons() {
     this.nextBtnNode.innerHTML = this.options.nextBtnText;
@@ -149,6 +160,7 @@ export default class Popover extends Element {
   /**
    * Shows the popover on the left of the given position
    * @param {Position} elementPosition
+   * @private
    */
   positionOnLeft(elementPosition) {
     const popoverWidth = this.getSize().width;
@@ -165,6 +177,7 @@ export default class Popover extends Element {
   /**
    * Shows the popover on the right of the given position
    * @param {Position} elementPosition
+   * @private
    */
   positionOnRight(elementPosition) {
     const popoverMargin = this.options.padding + 10;  // adding 10 to give it a little distance from the element
@@ -180,6 +193,7 @@ export default class Popover extends Element {
   /**
    * Shows the popover on the top of the given position
    * @param {Position} elementPosition
+   * @private
    */
   positionOnTop(elementPosition) {
     const popoverHeight = this.getSize().height;
@@ -196,6 +210,7 @@ export default class Popover extends Element {
   /**
    * Shows the popover on the bottom of the given position
    * @param {Position} elementPosition
+   * @private
    */
   positionOnBottom(elementPosition) {
     const popoverMargin = this.options.padding + 10;  // adding 10 to give it a little distance from the element
@@ -213,6 +228,7 @@ export default class Popover extends Element {
    * such that the element and popover remain in view
    * @todo add the left and right positioning decisions
    * @param {Position} elementPosition
+   * @private
    */
   autoPosition(elementPosition) {
     const pageSize = this.getFullPageSize();

src/core/position.js

@@ -24,6 +24,7 @@ export default class Position {
   /**
    * Checks if the position is valid to be highlighted
    * @returns {boolean}
+   * @public
    */
   canHighlight() {
     return this.left < this.right && this.top < this.bottom;
@@ -33,6 +34,7 @@ export default class Position {
    * Checks if the given position is equal to the passed position
    * @param position Position
    * @returns {boolean}
+   * @public
    */
   equals(position) {
     return Math.round(this.left) === Math.round(position.left) &&

src/core/stage.js

@@ -22,6 +22,7 @@ export default class Stage extends Element {
 
   /**
    * Prepares the DOM element if not already there
+   * @private
    */
   makeNode() {
     let stage = this.document.getElementById(ID_STAGE);
@@ -41,6 +42,7 @@ export default class Stage extends Element {
 
   /**
    * Simply hides the stage
+   * @public
    */
   hide() {
     if (!this.node || !this.node.parentElement) {
@@ -52,6 +54,7 @@ export default class Stage extends Element {
 
   /**
    * Makes it visible and sets the default properties
+   * @private
    */
   setInitialStyle() {
     this.node.style.display = 'block';
@@ -64,6 +67,7 @@ export default class Stage extends Element {
   /**
    * Shows the stage at provided position
    * @param {Position} position
+   * @public
    */
   show(position) {
     this.makeNode();