@openfin/fdc3-api 44.100.46 → 44.100.47
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/fdc3-api-alpha.d.ts +60 -2
- package/out/fdc3-api-beta.d.ts +60 -2
- package/out/fdc3-api-public.d.ts +60 -2
- package/out/fdc3-api.d.ts +60 -2
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -10453,6 +10453,7 @@ declare namespace OpenFin {
|
|
|
10453
10453
|
ChannelProviderDisconnectionListener,
|
|
10454
10454
|
RoutingInfo,
|
|
10455
10455
|
DownloadShelfOptions,
|
|
10456
|
+
SnapZoneOptions,
|
|
10456
10457
|
ViewShowAtOptions,
|
|
10457
10458
|
WebNotificationProperties,
|
|
10458
10459
|
WebNotificationInfo,
|
|
@@ -12364,7 +12365,7 @@ declare type PositioningOptions = {
|
|
|
12364
12365
|
/**
|
|
12365
12366
|
* Context menu item with an implementation provided by OpenFin.
|
|
12366
12367
|
*/
|
|
12367
|
-
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print';
|
|
12368
|
+
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print' | 'snapToTop' | 'snapToBottom';
|
|
12368
12369
|
|
|
12369
12370
|
/**
|
|
12370
12371
|
* A script that is run before page load.
|
|
@@ -14483,6 +14484,15 @@ declare type Size = TransitionBase & {
|
|
|
14483
14484
|
height: number;
|
|
14484
14485
|
};
|
|
14485
14486
|
|
|
14487
|
+
/**
|
|
14488
|
+
* Generated when a window is snapped to a screen edge.
|
|
14489
|
+
* @interface
|
|
14490
|
+
*/
|
|
14491
|
+
declare type SnappedEvent = BoundsEvent & {
|
|
14492
|
+
type: 'snapped';
|
|
14493
|
+
snapLocation: 'top' | 'bottom';
|
|
14494
|
+
};
|
|
14495
|
+
|
|
14486
14496
|
/**
|
|
14487
14497
|
* @interface
|
|
14488
14498
|
*/
|
|
@@ -14627,6 +14637,52 @@ declare class SnapshotSourceModule extends Base {
|
|
|
14627
14637
|
wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
|
|
14628
14638
|
}
|
|
14629
14639
|
|
|
14640
|
+
/**
|
|
14641
|
+
* Generated when a window enters or exits a snap zone during drag.
|
|
14642
|
+
* This event fires whenever the snap zone state changes (entry or exit).
|
|
14643
|
+
* @interface
|
|
14644
|
+
*/
|
|
14645
|
+
declare type SnapZoneChangedEvent = BaseEvent_5 & {
|
|
14646
|
+
type: 'snap-zone-changed';
|
|
14647
|
+
/**
|
|
14648
|
+
* Array of locations that the window is currently in snap zones for.
|
|
14649
|
+
* Empty array indicates the window is not in any snap zone.
|
|
14650
|
+
* Can contain multiple locations if the window is in multiple zones simultaneously.
|
|
14651
|
+
*/
|
|
14652
|
+
locations: Array<'top' | 'bottom'>;
|
|
14653
|
+
};
|
|
14654
|
+
|
|
14655
|
+
/**
|
|
14656
|
+
* @interface
|
|
14657
|
+
*
|
|
14658
|
+
* Configures snap zone behavior for a window. When enabled, the window will automatically snap to screen edges
|
|
14659
|
+
* when dragged near them during user drag interactions.
|
|
14660
|
+
*/
|
|
14661
|
+
declare type SnapZoneOptions = {
|
|
14662
|
+
/**
|
|
14663
|
+
* Whether snap zone functionality is enabled for this window.
|
|
14664
|
+
*
|
|
14665
|
+
* @default false
|
|
14666
|
+
*/
|
|
14667
|
+
enabled: boolean;
|
|
14668
|
+
/**
|
|
14669
|
+
* The distance in pixels from the screen edge that triggers the snap zone.
|
|
14670
|
+
* When the window is dragged within this threshold of the top or bottom edge,
|
|
14671
|
+
* it will be considered in a snap zone.
|
|
14672
|
+
*
|
|
14673
|
+
* @default 50
|
|
14674
|
+
*/
|
|
14675
|
+
threshold?: number;
|
|
14676
|
+
/**
|
|
14677
|
+
* Ordered array of edge preferences when the window is in multiple snap zones simultaneously.
|
|
14678
|
+
* The first edge in the array that the window is in will be used for snapping.
|
|
14679
|
+
* If not provided, defaults to ['top', 'bottom'] (preferring top over bottom).
|
|
14680
|
+
*
|
|
14681
|
+
* @default ['top', 'bottom']
|
|
14682
|
+
*/
|
|
14683
|
+
locationPreference?: Array<'top' | 'bottom'>;
|
|
14684
|
+
};
|
|
14685
|
+
|
|
14630
14686
|
/**
|
|
14631
14687
|
* Generated when an application has started.
|
|
14632
14688
|
* @interface
|
|
@@ -19907,6 +19963,8 @@ declare namespace WindowEvents {
|
|
|
19907
19963
|
BoundsChangingEvent,
|
|
19908
19964
|
DisabledMovementBoundsChangedEvent,
|
|
19909
19965
|
DisabledMovementBoundsChangingEvent,
|
|
19966
|
+
SnappedEvent,
|
|
19967
|
+
SnapZoneChangedEvent,
|
|
19910
19968
|
UserBoundsChangeEvent,
|
|
19911
19969
|
BeginUserBoundsChangingEvent,
|
|
19912
19970
|
EndUserBoundsChangingEvent,
|
|
@@ -20149,7 +20207,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
20149
20207
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
20150
20208
|
* from {@link OpenFin.ViewEvents}.
|
|
20151
20209
|
*/
|
|
20152
|
-
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
|
20210
|
+
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent | SnappedEvent | SnapZoneChangedEvent;
|
|
20153
20211
|
|
|
20154
20212
|
/**
|
|
20155
20213
|
* Generated when a child window starts loading.
|
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -10453,6 +10453,7 @@ declare namespace OpenFin {
|
|
|
10453
10453
|
ChannelProviderDisconnectionListener,
|
|
10454
10454
|
RoutingInfo,
|
|
10455
10455
|
DownloadShelfOptions,
|
|
10456
|
+
SnapZoneOptions,
|
|
10456
10457
|
ViewShowAtOptions,
|
|
10457
10458
|
WebNotificationProperties,
|
|
10458
10459
|
WebNotificationInfo,
|
|
@@ -12364,7 +12365,7 @@ declare type PositioningOptions = {
|
|
|
12364
12365
|
/**
|
|
12365
12366
|
* Context menu item with an implementation provided by OpenFin.
|
|
12366
12367
|
*/
|
|
12367
|
-
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print';
|
|
12368
|
+
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print' | 'snapToTop' | 'snapToBottom';
|
|
12368
12369
|
|
|
12369
12370
|
/**
|
|
12370
12371
|
* A script that is run before page load.
|
|
@@ -14483,6 +14484,15 @@ declare type Size = TransitionBase & {
|
|
|
14483
14484
|
height: number;
|
|
14484
14485
|
};
|
|
14485
14486
|
|
|
14487
|
+
/**
|
|
14488
|
+
* Generated when a window is snapped to a screen edge.
|
|
14489
|
+
* @interface
|
|
14490
|
+
*/
|
|
14491
|
+
declare type SnappedEvent = BoundsEvent & {
|
|
14492
|
+
type: 'snapped';
|
|
14493
|
+
snapLocation: 'top' | 'bottom';
|
|
14494
|
+
};
|
|
14495
|
+
|
|
14486
14496
|
/**
|
|
14487
14497
|
* @interface
|
|
14488
14498
|
*/
|
|
@@ -14627,6 +14637,52 @@ declare class SnapshotSourceModule extends Base {
|
|
|
14627
14637
|
wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
|
|
14628
14638
|
}
|
|
14629
14639
|
|
|
14640
|
+
/**
|
|
14641
|
+
* Generated when a window enters or exits a snap zone during drag.
|
|
14642
|
+
* This event fires whenever the snap zone state changes (entry or exit).
|
|
14643
|
+
* @interface
|
|
14644
|
+
*/
|
|
14645
|
+
declare type SnapZoneChangedEvent = BaseEvent_5 & {
|
|
14646
|
+
type: 'snap-zone-changed';
|
|
14647
|
+
/**
|
|
14648
|
+
* Array of locations that the window is currently in snap zones for.
|
|
14649
|
+
* Empty array indicates the window is not in any snap zone.
|
|
14650
|
+
* Can contain multiple locations if the window is in multiple zones simultaneously.
|
|
14651
|
+
*/
|
|
14652
|
+
locations: Array<'top' | 'bottom'>;
|
|
14653
|
+
};
|
|
14654
|
+
|
|
14655
|
+
/**
|
|
14656
|
+
* @interface
|
|
14657
|
+
*
|
|
14658
|
+
* Configures snap zone behavior for a window. When enabled, the window will automatically snap to screen edges
|
|
14659
|
+
* when dragged near them during user drag interactions.
|
|
14660
|
+
*/
|
|
14661
|
+
declare type SnapZoneOptions = {
|
|
14662
|
+
/**
|
|
14663
|
+
* Whether snap zone functionality is enabled for this window.
|
|
14664
|
+
*
|
|
14665
|
+
* @default false
|
|
14666
|
+
*/
|
|
14667
|
+
enabled: boolean;
|
|
14668
|
+
/**
|
|
14669
|
+
* The distance in pixels from the screen edge that triggers the snap zone.
|
|
14670
|
+
* When the window is dragged within this threshold of the top or bottom edge,
|
|
14671
|
+
* it will be considered in a snap zone.
|
|
14672
|
+
*
|
|
14673
|
+
* @default 50
|
|
14674
|
+
*/
|
|
14675
|
+
threshold?: number;
|
|
14676
|
+
/**
|
|
14677
|
+
* Ordered array of edge preferences when the window is in multiple snap zones simultaneously.
|
|
14678
|
+
* The first edge in the array that the window is in will be used for snapping.
|
|
14679
|
+
* If not provided, defaults to ['top', 'bottom'] (preferring top over bottom).
|
|
14680
|
+
*
|
|
14681
|
+
* @default ['top', 'bottom']
|
|
14682
|
+
*/
|
|
14683
|
+
locationPreference?: Array<'top' | 'bottom'>;
|
|
14684
|
+
};
|
|
14685
|
+
|
|
14630
14686
|
/**
|
|
14631
14687
|
* Generated when an application has started.
|
|
14632
14688
|
* @interface
|
|
@@ -19907,6 +19963,8 @@ declare namespace WindowEvents {
|
|
|
19907
19963
|
BoundsChangingEvent,
|
|
19908
19964
|
DisabledMovementBoundsChangedEvent,
|
|
19909
19965
|
DisabledMovementBoundsChangingEvent,
|
|
19966
|
+
SnappedEvent,
|
|
19967
|
+
SnapZoneChangedEvent,
|
|
19910
19968
|
UserBoundsChangeEvent,
|
|
19911
19969
|
BeginUserBoundsChangingEvent,
|
|
19912
19970
|
EndUserBoundsChangingEvent,
|
|
@@ -20149,7 +20207,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
20149
20207
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
20150
20208
|
* from {@link OpenFin.ViewEvents}.
|
|
20151
20209
|
*/
|
|
20152
|
-
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
|
20210
|
+
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent | SnappedEvent | SnapZoneChangedEvent;
|
|
20153
20211
|
|
|
20154
20212
|
/**
|
|
20155
20213
|
* Generated when a child window starts loading.
|
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -10453,6 +10453,7 @@ declare namespace OpenFin {
|
|
|
10453
10453
|
ChannelProviderDisconnectionListener,
|
|
10454
10454
|
RoutingInfo,
|
|
10455
10455
|
DownloadShelfOptions,
|
|
10456
|
+
SnapZoneOptions,
|
|
10456
10457
|
ViewShowAtOptions,
|
|
10457
10458
|
WebNotificationProperties,
|
|
10458
10459
|
WebNotificationInfo,
|
|
@@ -12364,7 +12365,7 @@ declare type PositioningOptions = {
|
|
|
12364
12365
|
/**
|
|
12365
12366
|
* Context menu item with an implementation provided by OpenFin.
|
|
12366
12367
|
*/
|
|
12367
|
-
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print';
|
|
12368
|
+
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print' | 'snapToTop' | 'snapToBottom';
|
|
12368
12369
|
|
|
12369
12370
|
/**
|
|
12370
12371
|
* A script that is run before page load.
|
|
@@ -14483,6 +14484,15 @@ declare type Size = TransitionBase & {
|
|
|
14483
14484
|
height: number;
|
|
14484
14485
|
};
|
|
14485
14486
|
|
|
14487
|
+
/**
|
|
14488
|
+
* Generated when a window is snapped to a screen edge.
|
|
14489
|
+
* @interface
|
|
14490
|
+
*/
|
|
14491
|
+
declare type SnappedEvent = BoundsEvent & {
|
|
14492
|
+
type: 'snapped';
|
|
14493
|
+
snapLocation: 'top' | 'bottom';
|
|
14494
|
+
};
|
|
14495
|
+
|
|
14486
14496
|
/**
|
|
14487
14497
|
* @interface
|
|
14488
14498
|
*/
|
|
@@ -14627,6 +14637,52 @@ declare class SnapshotSourceModule extends Base {
|
|
|
14627
14637
|
wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
|
|
14628
14638
|
}
|
|
14629
14639
|
|
|
14640
|
+
/**
|
|
14641
|
+
* Generated when a window enters or exits a snap zone during drag.
|
|
14642
|
+
* This event fires whenever the snap zone state changes (entry or exit).
|
|
14643
|
+
* @interface
|
|
14644
|
+
*/
|
|
14645
|
+
declare type SnapZoneChangedEvent = BaseEvent_5 & {
|
|
14646
|
+
type: 'snap-zone-changed';
|
|
14647
|
+
/**
|
|
14648
|
+
* Array of locations that the window is currently in snap zones for.
|
|
14649
|
+
* Empty array indicates the window is not in any snap zone.
|
|
14650
|
+
* Can contain multiple locations if the window is in multiple zones simultaneously.
|
|
14651
|
+
*/
|
|
14652
|
+
locations: Array<'top' | 'bottom'>;
|
|
14653
|
+
};
|
|
14654
|
+
|
|
14655
|
+
/**
|
|
14656
|
+
* @interface
|
|
14657
|
+
*
|
|
14658
|
+
* Configures snap zone behavior for a window. When enabled, the window will automatically snap to screen edges
|
|
14659
|
+
* when dragged near them during user drag interactions.
|
|
14660
|
+
*/
|
|
14661
|
+
declare type SnapZoneOptions = {
|
|
14662
|
+
/**
|
|
14663
|
+
* Whether snap zone functionality is enabled for this window.
|
|
14664
|
+
*
|
|
14665
|
+
* @default false
|
|
14666
|
+
*/
|
|
14667
|
+
enabled: boolean;
|
|
14668
|
+
/**
|
|
14669
|
+
* The distance in pixels from the screen edge that triggers the snap zone.
|
|
14670
|
+
* When the window is dragged within this threshold of the top or bottom edge,
|
|
14671
|
+
* it will be considered in a snap zone.
|
|
14672
|
+
*
|
|
14673
|
+
* @default 50
|
|
14674
|
+
*/
|
|
14675
|
+
threshold?: number;
|
|
14676
|
+
/**
|
|
14677
|
+
* Ordered array of edge preferences when the window is in multiple snap zones simultaneously.
|
|
14678
|
+
* The first edge in the array that the window is in will be used for snapping.
|
|
14679
|
+
* If not provided, defaults to ['top', 'bottom'] (preferring top over bottom).
|
|
14680
|
+
*
|
|
14681
|
+
* @default ['top', 'bottom']
|
|
14682
|
+
*/
|
|
14683
|
+
locationPreference?: Array<'top' | 'bottom'>;
|
|
14684
|
+
};
|
|
14685
|
+
|
|
14630
14686
|
/**
|
|
14631
14687
|
* Generated when an application has started.
|
|
14632
14688
|
* @interface
|
|
@@ -19907,6 +19963,8 @@ declare namespace WindowEvents {
|
|
|
19907
19963
|
BoundsChangingEvent,
|
|
19908
19964
|
DisabledMovementBoundsChangedEvent,
|
|
19909
19965
|
DisabledMovementBoundsChangingEvent,
|
|
19966
|
+
SnappedEvent,
|
|
19967
|
+
SnapZoneChangedEvent,
|
|
19910
19968
|
UserBoundsChangeEvent,
|
|
19911
19969
|
BeginUserBoundsChangingEvent,
|
|
19912
19970
|
EndUserBoundsChangingEvent,
|
|
@@ -20149,7 +20207,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
20149
20207
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
20150
20208
|
* from {@link OpenFin.ViewEvents}.
|
|
20151
20209
|
*/
|
|
20152
|
-
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
|
20210
|
+
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent | SnappedEvent | SnapZoneChangedEvent;
|
|
20153
20211
|
|
|
20154
20212
|
/**
|
|
20155
20213
|
* Generated when a child window starts loading.
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -10787,6 +10787,7 @@ declare namespace OpenFin {
|
|
|
10787
10787
|
ChannelProviderDisconnectionListener,
|
|
10788
10788
|
RoutingInfo,
|
|
10789
10789
|
DownloadShelfOptions,
|
|
10790
|
+
SnapZoneOptions,
|
|
10790
10791
|
ViewShowAtOptions,
|
|
10791
10792
|
WebNotificationProperties,
|
|
10792
10793
|
WebNotificationInfo,
|
|
@@ -12781,7 +12782,7 @@ declare type PositioningOptions = {
|
|
|
12781
12782
|
/**
|
|
12782
12783
|
* Context menu item with an implementation provided by OpenFin.
|
|
12783
12784
|
*/
|
|
12784
|
-
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print';
|
|
12785
|
+
declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | 'copy' | 'copyImage' | 'paste' | 'selectAll' | 'spellCheck' | 'inspect' | 'reload' | 'navigateForward' | 'navigateBack' | 'print' | 'snapToTop' | 'snapToBottom';
|
|
12785
12786
|
|
|
12786
12787
|
/**
|
|
12787
12788
|
* A script that is run before page load.
|
|
@@ -14900,6 +14901,15 @@ declare type Size = TransitionBase & {
|
|
|
14900
14901
|
height: number;
|
|
14901
14902
|
};
|
|
14902
14903
|
|
|
14904
|
+
/**
|
|
14905
|
+
* Generated when a window is snapped to a screen edge.
|
|
14906
|
+
* @interface
|
|
14907
|
+
*/
|
|
14908
|
+
declare type SnappedEvent = BoundsEvent & {
|
|
14909
|
+
type: 'snapped';
|
|
14910
|
+
snapLocation: 'top' | 'bottom';
|
|
14911
|
+
};
|
|
14912
|
+
|
|
14903
14913
|
/**
|
|
14904
14914
|
* @interface
|
|
14905
14915
|
*/
|
|
@@ -15047,6 +15057,52 @@ declare class SnapshotSourceModule extends Base {
|
|
|
15047
15057
|
wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
|
|
15048
15058
|
}
|
|
15049
15059
|
|
|
15060
|
+
/**
|
|
15061
|
+
* Generated when a window enters or exits a snap zone during drag.
|
|
15062
|
+
* This event fires whenever the snap zone state changes (entry or exit).
|
|
15063
|
+
* @interface
|
|
15064
|
+
*/
|
|
15065
|
+
declare type SnapZoneChangedEvent = BaseEvent_5 & {
|
|
15066
|
+
type: 'snap-zone-changed';
|
|
15067
|
+
/**
|
|
15068
|
+
* Array of locations that the window is currently in snap zones for.
|
|
15069
|
+
* Empty array indicates the window is not in any snap zone.
|
|
15070
|
+
* Can contain multiple locations if the window is in multiple zones simultaneously.
|
|
15071
|
+
*/
|
|
15072
|
+
locations: Array<'top' | 'bottom'>;
|
|
15073
|
+
};
|
|
15074
|
+
|
|
15075
|
+
/**
|
|
15076
|
+
* @interface
|
|
15077
|
+
*
|
|
15078
|
+
* Configures snap zone behavior for a window. When enabled, the window will automatically snap to screen edges
|
|
15079
|
+
* when dragged near them during user drag interactions.
|
|
15080
|
+
*/
|
|
15081
|
+
declare type SnapZoneOptions = {
|
|
15082
|
+
/**
|
|
15083
|
+
* Whether snap zone functionality is enabled for this window.
|
|
15084
|
+
*
|
|
15085
|
+
* @default false
|
|
15086
|
+
*/
|
|
15087
|
+
enabled: boolean;
|
|
15088
|
+
/**
|
|
15089
|
+
* The distance in pixels from the screen edge that triggers the snap zone.
|
|
15090
|
+
* When the window is dragged within this threshold of the top or bottom edge,
|
|
15091
|
+
* it will be considered in a snap zone.
|
|
15092
|
+
*
|
|
15093
|
+
* @default 50
|
|
15094
|
+
*/
|
|
15095
|
+
threshold?: number;
|
|
15096
|
+
/**
|
|
15097
|
+
* Ordered array of edge preferences when the window is in multiple snap zones simultaneously.
|
|
15098
|
+
* The first edge in the array that the window is in will be used for snapping.
|
|
15099
|
+
* If not provided, defaults to ['top', 'bottom'] (preferring top over bottom).
|
|
15100
|
+
*
|
|
15101
|
+
* @default ['top', 'bottom']
|
|
15102
|
+
*/
|
|
15103
|
+
locationPreference?: Array<'top' | 'bottom'>;
|
|
15104
|
+
};
|
|
15105
|
+
|
|
15050
15106
|
/**
|
|
15051
15107
|
* Generated when an application has started.
|
|
15052
15108
|
* @interface
|
|
@@ -20377,6 +20433,8 @@ declare namespace WindowEvents {
|
|
|
20377
20433
|
BoundsChangingEvent,
|
|
20378
20434
|
DisabledMovementBoundsChangedEvent,
|
|
20379
20435
|
DisabledMovementBoundsChangingEvent,
|
|
20436
|
+
SnappedEvent,
|
|
20437
|
+
SnapZoneChangedEvent,
|
|
20380
20438
|
UserBoundsChangeEvent,
|
|
20381
20439
|
BeginUserBoundsChangingEvent,
|
|
20382
20440
|
EndUserBoundsChangingEvent,
|
|
@@ -20619,7 +20677,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
20619
20677
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
20620
20678
|
* from {@link OpenFin.ViewEvents}.
|
|
20621
20679
|
*/
|
|
20622
|
-
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
|
20680
|
+
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent | SnappedEvent | SnapZoneChangedEvent;
|
|
20623
20681
|
|
|
20624
20682
|
/**
|
|
20625
20683
|
* Generated when a child window starts loading.
|