chore(overlay): Updating the description of setOffset method #5833

Author: dafo

CHANGELOG.md

@@ -18,9 +18,9 @@ All notable changes for each version of this project will be documented in this
 
 ### New Features
 - `IgxOverlayService`:
-    - `setOffset` method added. It repositions the content in the horizontal and vertical directions.
+    - `setOffset` method added. It offsets the content along the corresponding axis by the provided amount.
 - `IgxToggleDirective`:
-    - `setOffset` method added. It repositions the content in the horizontal and vertical directions.
+    - `setOffset` method added. It offsets the content along the corresponding axis by the provided amount.
 
 ## 8.2.6
 

projects/igniteui-angular/src/lib/directives/toggle/README.md

@@ -49,7 +49,7 @@ handlers when the toggle is opened and respectively closed.
 | `close` | --- | `void` | Closes the toggle. |
 | `toggle` | overlaySettings?: `OverlaySettings` | `void` | Closes the toggle. |
 | `reposition` | --- | `void` | Repositions the toggle. |
-| `setOffset`  | Repositions the content in the horizontal and/or vertical directions. |deltaX, deltaY |
+| `setOffset`  | Offsets the content along the corresponding axis by the provided amount. |deltaX, deltaY |
 
 
 

projects/igniteui-angular/src/lib/directives/toggle/toggle.directive.ts

@@ -277,7 +277,7 @@ export class IgxToggleDirective implements IToggleView, OnInit, OnDestroy {
     }
 
     /**
-     * Repositions the content in the horizontal and/or vertical directions.
+     * Offsets the content along the corresponding axis by the provided amount
      */
     setOffset(deltaX: number, deltaY: number) {
         this.overlayService.setOffset(this._overlayId, deltaX, deltaY);

projects/igniteui-angular/src/lib/services/overlay/README.md

@@ -96,7 +96,7 @@ this.overlay.show(component, overlaySettings);
 |hide             | Remove the provided native element of for the component with provided id        |id               |
 |hideAll          | Remove the all native elements and hides the overlay                            |-                |
 |reposition       | Repositions the native element of the component with provided id                |id               |
-|setOffset        | Repositions the content in the horizontal and/or vertical directions.          |id, deltaX, deltaY |
+|setOffset        | Offsets the content along the corresponding axis by the provided amount       |id, deltaX, deltaY |
 
 ###### IPositionStrategy
 

projects/igniteui-angular/src/lib/services/overlay/overlay.ts

@@ -246,9 +246,9 @@ export class IgxOverlayService implements OnDestroy {
     }
 
     /**
-     * Repositions the content in the horizontal and/or vertical directions.
+     * Offsets the content along the corresponding axis by the provided amount
      * ```typescript
-     * this.overlay.setOffset(id, x, y);
+     * this.overlay.setOffset(id, deltaX, deltaY);
      * ```
      */
     setOffset(id: string, deltaX: number, deltaY: number) {