Skip to content

Commit a15a0f4

Browse files
committed
chore(overlay): address PR comments
1 parent ed1c117 commit a15a0f4

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

  • projects/igniteui-angular/core/src/services/overlay/position

projects/igniteui-angular/core/src/services/overlay/position/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Position strategies
22

33
Position strategies determine where to display the component in the provided IgxOverlayService. There are three position strategies:
4-
1) **Global** - Positions the element based on the directions passed in trough PositionSettings. These are Top/Middle/Bottom for verticalDirection and Left/Center/Right for horizontalDirection. Defaults to:
4+
1) **Global** - Positions the element based on the directions passed in through PositionSettings. These are Top/Middle/Bottom for verticalDirection and Left/Center/Right for horizontalDirection. Defaults to:
55

66
| horizontalDirection | verticalDirection |
77
|:---------------------------|:-------------------------|
88
| HorizontalAlignment.Center | VerticalAlignment.Middle |
99

10-
2) **Container** - Positions the element inside the containing outlet based on the directions passed in trough PositionSettings. These are Top/Middle/Bottom for verticalDirection and Left/Center/Right for horizontalDirection. **Note:** The `outlet` property in `OverlaySettings` is deprecated; use `keepInPlace` to keep overlays in their original DOM position instead. Defaults to:
10+
2) **Container** - Positions the element inside the containing outlet based on the directions passed in through PositionSettings. These are Top/Middle/Bottom for verticalDirection and Left/Center/Right for horizontalDirection. **Note:** The `outlet` property in `OverlaySettings` is deprecated; use `keepInPlace` to keep overlays in their original DOM position instead. Defaults to:
1111

1212
| horizontalDirection | verticalDirection |
1313
|:---------------------------|:-------------------------|
1414
| HorizontalAlignment.Center | VerticalAlignment.Middle |
1515

1616

17-
3) **Connected** - Positions the element based on the directions and start point passed in trough PositionSettings. It is possible to either pass a start point or an HTMLElement as a positioning base. Defaults to:
17+
3) **Connected** - Positions the element based on the directions and start point passed in through PositionSettings. It is possible to either pass a start point or an HTMLElement as a positioning base. Defaults to:
1818

1919
| target | horizontalDirection | verticalDirection | horizontalStartPoint | verticalStartPoint |
2020
|:----------------|:--------------------------|:-------------------------|:-------------------------|:-------------------------|
@@ -64,7 +64,7 @@ import {AutoPositionStrategy, GlobalPositionStrategy, ConnectedPositioningStrate
6464
| Position Strategy | Name | Description |
6565
|:------------------|:-------------------------------------------------------|:----------------------------------------------------------------------------------|
6666
| Global | `position(contentElement)` | Positions the element, based on the horizontal and vertical directions. |
67-
| Container | `position(contentElement)` | Positions the element inside the containing outlet based on the directions passed in trough PositionSettings. |
67+
| Container | `position(contentElement)` | Positions the element inside the containing outlet based on the directions passed in through PositionSettings. |
6868
| Connected | `position(contentElement, size{})` | Positions the element, based on the position strategy used and the size passed in.|
6969
| Auto | `position(contentElement, size{}, document?)` | Positions the element, based on the position strategy used and the size passed in.|
7070
| Elastic | `position(contentElement, size{}, document?, minSize?)`| Positions the element, based on the position strategy used and the size passed in.|

0 commit comments

Comments
 (0)