Skip to content

Commit

Permalink
feat(overlay): add description to changelog and readme #7941
Browse files Browse the repository at this point in the history
  • Loading branch information
PlamenaMiteva committed Oct 7, 2020
1 parent 23f3631 commit 2830b9d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,20 @@ All notable changes for each version of this project will be documented in this
- `IgxOverlay`
- The `PositionSettings` `target` property has been deprecated and moved to `OverlaySettings`.
- An optional Point/HTML Element parameter `target` has been added to the `position()` method

- Added `createAbsoluteOverlaySettings` and `createRelativeOverlaySettings` methods which create non-modal `OverlaySettings` based on predefined `PositionSettings`. The methods are exposed off the `IgxOverlayService`.
- `createAbsoluteOverlaySettings` creates non-modal `OverlaySettings` with `GlobalPositionStrategy` or `ContainerPositionStrategy` if an outlet is provided. Accepts `AbsolutePosition` enumeration, which could be Center, Top and Bottom. Default is Center.
```typescript
const globalOverlaySettings = IgxOverlayService.createAbsoluteOverlaySettings(AbsolutePosition.Top);
```
- `createRelativeOverlaySettings` creates `OverlaySettings` with `AutoPositionStrategy`, `ConnectedPositioningStrategy` or `ElasticPositionStrategy`. Accepts target, strategy and position. The `target` is the attaching point or element for the component to show. The position strategy is a `RelativePositionStrategy` enumeration, which defaults to Auto. The position is a `RelativePosition` enumeration. Possible values are Above, Below, Left, Right and Default. The default option is `Default`, which positions the element below the target, left aligned.
```typescript
const targetElement = this.button.nativeElement;
const connectedOverlaySettings = IgxOverlayService.createRelativeOverlaySettings(
targetElement,
RelativePositionStrategy.Connected,
RelativePosition.Above);
```

## 10.1.0

### General
Expand Down
2 changes: 2 additions & 0 deletions projects/igniteui-angular/src/lib/services/overlay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ this.overlay.show(component, overlaySettings);
| Name | Description | Parameters |
|-----------------|---------------------------------------------------------------------------------|------------|
|getPointFromPositionsSettings| Calculates the point from which the overlay should start showing |settings |
|createAbsoluteOverlaySettings| Creates overlay settings with global or container position strategy based on a preset position settings |position?, outlet?|
|createRelativeOverlaySettings| Creates overlay settings with auto, connected or elastic position strategy based on a preset position settings |target, strategy?, position?|


##### Events
Expand Down

0 comments on commit 2830b9d

Please sign in to comment.