Skip to content

Commit c0e35b3

Browse files
committed
feat(entry-points): rename Size interface in Overlay to ElementDimensions
1 parent 27581e6 commit c0e35b3

File tree

10 files changed

+21
-22
lines changed

10 files changed

+21
-22
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ this.overlay.show(component, overlaySettings);
8282
|verticalStartPoint | VerticalAlignment | Target's starting point |
8383
|openAnimation | AnimationMetadata | AnimationMetadata[] | Animation applied while overlay opens |
8484
|closeAnimation | AnimationMetadata | AnimationMetadata[] | Animation applied while overlay closes |
85-
|minSize | Size | The size up to which element may shrink when shown in elastic position strategy |
85+
|minSize | ElementDimensions | The size up to which element may shrink when shown in elastic position strategy |
8686

8787
###### OverlayCreateSettings extends OverlaySettings
8888

projects/igniteui-angular/core/src/services/overlay/position/IPositionStrategy.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { PositionSettings, Size, Point } from './../utilities';
1+
import { ElementDimensions, PositionSettings, Point } from './../utilities';
22

33
/**
44
* [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-position)
@@ -23,7 +23,7 @@ export interface IPositionStrategy {
2323
* settings.positionStrategy.position(content, size, document, true);
2424
* ```
2525
*/
26-
position(contentElement: HTMLElement, size?: Size, document?: Document, initialCall?: boolean, target?: Point | HTMLElement): void;
26+
position(contentElement: HTMLElement, size?: ElementDimensions, document?: Document, initialCall?: boolean, target?: Point | HTMLElement): void;
2727

2828
/**
2929
* Clone the strategy instance.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,4 @@ import {AutoPositionStrategy, GlobalPositionStrategy, ConnectedPositioningStrate
7979
|verticalStartPoint | VerticalAlignment | Target's starting point |
8080
|openAnimation | AnimationReferenceMetadata | Animation applied while overlay opens |
8181
|closeAnimation | AnimationReferenceMetadata | Animation applied while overlay closes |
82-
|minSize | Size | The size up to which element could be reduced |
82+
|minSize | ElementDimensions | The size up to which element could be reduced |

projects/igniteui-angular/core/src/services/overlay/position/base-fit-position-strategy.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { ConnectedFit, HorizontalAlignment, Point, PositionSettings, Size, Util, VerticalAlignment } from '../utilities';
1+
import { ConnectedFit, ElementDimensions, HorizontalAlignment, Point, PositionSettings, Util, VerticalAlignment } from '../utilities';
22
import { ConnectedPositioningStrategy } from './connected-positioning-strategy';
33

44
export abstract class BaseFitPositionStrategy extends ConnectedPositioningStrategy {
5-
protected _initialSize: Size;
5+
protected _initialSize: ElementDimensions;
66
protected _initialSettings: PositionSettings;
77

88
/**
@@ -18,7 +18,7 @@ export abstract class BaseFitPositionStrategy extends ConnectedPositioningStrate
1818
* ```
1919
*/
2020
public override position(
21-
contentElement: HTMLElement, size: Size, document?: Document, initialCall?: boolean, target?: Point | HTMLElement): void {
21+
contentElement: HTMLElement, size: ElementDimensions, document?: Document, initialCall?: boolean, target?: Point | HTMLElement): void {
2222
const rects = super.calculateElementRectangles(contentElement, target);
2323
const connectedFit: ConnectedFit = {};
2424
if (initialCall) {

projects/igniteui-angular/core/src/services/overlay/position/connected-positioning-strategy.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import { scaleInVerTop, scaleOutVerTop } from 'igniteui-angular/animations';
22
import { ConnectedFit } from '../utilities';
33
import {
4+
ElementDimensions,
45
HorizontalAlignment,
56
Point,
67
PositionSettings,
7-
Size,
88
Util,
99
VerticalAlignment
1010
} from './../utilities';
@@ -46,7 +46,7 @@ export class ConnectedPositioningStrategy implements IPositionStrategy {
4646
* settings.positionStrategy.position(content, size, document, true);
4747
* ```
4848
*/
49-
public position(contentElement: HTMLElement, size: Size, document?: Document, initialCall?: boolean, target?: Point | HTMLElement): void {
49+
public position(contentElement: HTMLElement, size: ElementDimensions, document?: Document, initialCall?: boolean, target?: Point | HTMLElement): void {
5050
const rects = this.calculateElementRectangles(contentElement, target);
5151
this.setStyle(contentElement, rects.targetRect, rects.elementRect, {});
5252
}

projects/igniteui-angular/core/src/services/overlay/position/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
21
// Export position strategies
32
export * from './IPositionStrategy';
3+
export * from './base-fit-position-strategy';
44
export * from './global-position-strategy';
55
export * from './container-position-strategy';
66
export * from './connected-positioning-strategy';

projects/igniteui-angular/core/src/services/overlay/utilities.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ export interface PositionSettings {
9494
/** Animation applied while overlay closes */
9595
closeAnimation?: AnimationReferenceMetadata;
9696
/** The size up to which element may shrink when shown in elastic position strategy */
97-
minSize?: Size;
97+
minSize?: ElementDimensions;
9898
/** The offset of the element from the target in pixels */
9999
offset?: number;
100100
}
@@ -151,11 +151,11 @@ export interface OverlayAnimationEventArgs extends IBaseEventArgs {
151151
animationType: 'open' | 'close';
152152
}
153153

154-
export interface Size {
155-
/** Gets or sets the horizontal component of Size */
154+
export interface ElementDimensions {
155+
/** Gets or sets the horizontal component of ElementDimensions */
156156
width: number;
157157

158-
/** Gets or sets the vertical component of Size */
158+
/** Gets or sets the vertical component of ElementDimensions */
159159
height: number;
160160
}
161161

@@ -167,7 +167,7 @@ export interface OverlayInfo {
167167
elementRef?: ElementRef;
168168
componentRef?: ComponentRef<any>;
169169
settings?: OverlaySettings;
170-
initialSize?: Size;
170+
initialSize?: ElementDimensions;
171171
hook?: HTMLElement;
172172
openAnimationPlayer?: AnimationPlayer;
173173
// calling animation.destroy in detach fires animation.done. This should not happen

projects/igniteui-angular/core/src/services/public_api.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ export * from './overlay/overlay';
1212
export * from './overlay/position';
1313
export * from './overlay/scroll';
1414
export {
15-
AbsolutePosition, ConnectedFit, HorizontalAlignment, OffsetMode, OverlayAnimationEventArgs, OverlayCancelableEventArgs, OverlayClosingEventArgs,
16-
OverlayCreateSettings, OverlayEventArgs, OverlaySettings, Point, PositionSettings, RelativePosition, RelativePositionStrategy, Size, VerticalAlignment
15+
AbsolutePosition, ConnectedFit, ElementDimensions, HorizontalAlignment, OffsetMode, OverlayAnimationEventArgs, OverlayCancelableEventArgs, OverlayClosingEventArgs,
16+
OverlayCreateSettings, OverlayEventArgs, OverlaySettings, Point, PositionSettings, RelativePosition, RelativePositionStrategy, VerticalAlignment
1717
} from './overlay/utilities';
1818
export * from './transaction/base-transaction';
1919
export * from './transaction/hierarchical-transaction';

projects/igniteui-angular/directives/src/directives/tooltip/tooltip.common.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { first } from 'igniteui-angular/core';
22
import { AutoPositionStrategy } from 'igniteui-angular/core';
3-
import { ConnectedFit, HorizontalAlignment, Point, PositionSettings, Size, VerticalAlignment } from 'igniteui-angular/core';
3+
import { ConnectedFit, ElementDimensions, HorizontalAlignment, Point, PositionSettings, VerticalAlignment } from 'igniteui-angular/core';
44
import { useAnimation } from '@angular/animations';
55
import { fadeOut, scaleInCenter } from 'igniteui-angular/animations';
66

@@ -82,7 +82,7 @@ export class TooltipPositionStrategy extends AutoPositionStrategy {
8282

8383
public override position(
8484
contentElement: HTMLElement,
85-
size: Size,
85+
size: ElementDimensions,
8686
document?: Document,
8787
initialCall?: boolean,
8888
target?: Point | HTMLElement

projects/igniteui-angular/select/src/select/select-positioning-strategy.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
import { VerticalAlignment, HorizontalAlignment, PositionSettings, Size, Util, ConnectedFit, Point } from 'igniteui-angular/core';
1+
import { ElementDimensions, VerticalAlignment, HorizontalAlignment, PositionSettings, Util, ConnectedFit, Point, BaseFitPositionStrategy } from 'igniteui-angular/core';
22
import { IPositionStrategy } from 'igniteui-angular/core';
33

44
import { IgxSelectBase } from './select.common';
5-
import { BaseFitPositionStrategy } from 'igniteui-angular/core';
65
import { PlatformUtil } from 'igniteui-angular/core';
76
import { Optional } from '@angular/core';
87
import { fadeIn, fadeOut } from 'igniteui-angular/animations';
@@ -41,7 +40,7 @@ export class SelectPositioningStrategy extends BaseFitPositionStrategy implement
4140
* ```
4241
*/
4342
public override position(contentElement: HTMLElement,
44-
size: Size,
43+
size: ElementDimensions,
4544
document?: Document,
4645
initialCall?: boolean,
4746
target?: Point | HTMLElement): void {

0 commit comments

Comments
 (0)