@openfin/core 34.78.22 → 34.78.23

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.
@@ -3311,6 +3311,15 @@ declare type ConstViewOptions = {
3311
3311
  * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
3312
3312
  */
3313
3313
  autoplayPolicy: AutoplayPolicyOptions;
3314
+ /**
3315
+ * **Platforms Only.**
3316
+ * Determines what happens when a view is closed in a platform window.
3317
+ * Supersedes `detachOnClose`, but has no default value.
3318
+ * 'hide' hides the view on the platform window that closed it.
3319
+ * 'detach' behaves like 'detachOnClose': true.
3320
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3321
+ */
3322
+ closeBehavior?: 'hide' | 'detach' | 'destroy';
3314
3323
  };
3315
3324
 
3316
3325
  /**
@@ -3377,9 +3386,16 @@ declare type ConstWindowOptions = {
3377
3386
  * This is meant for advanced users and should be used with caution.
3378
3387
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3379
3388
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3380
- * ** note ** - This option is ignored in non-Platforms apps.
3389
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3381
3390
  */
3382
3391
  closeOnLastViewRemoved: boolean;
3392
+ /**
3393
+ * @defaultValue 'all'
3394
+ *
3395
+ * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3396
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3397
+ */
3398
+ viewsPreventingClose: 'all' | 'layout';
3383
3399
  /**
3384
3400
  * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
3385
3401
  * this value will be ignored for subsequent launches in favor of the cached value.
@@ -3311,6 +3311,15 @@ declare type ConstViewOptions = {
3311
3311
  * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
3312
3312
  */
3313
3313
  autoplayPolicy: AutoplayPolicyOptions;
3314
+ /**
3315
+ * **Platforms Only.**
3316
+ * Determines what happens when a view is closed in a platform window.
3317
+ * Supersedes `detachOnClose`, but has no default value.
3318
+ * 'hide' hides the view on the platform window that closed it.
3319
+ * 'detach' behaves like 'detachOnClose': true.
3320
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3321
+ */
3322
+ closeBehavior?: 'hide' | 'detach' | 'destroy';
3314
3323
  };
3315
3324
 
3316
3325
  /**
@@ -3377,9 +3386,16 @@ declare type ConstWindowOptions = {
3377
3386
  * This is meant for advanced users and should be used with caution.
3378
3387
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3379
3388
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3380
- * ** note ** - This option is ignored in non-Platforms apps.
3389
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3381
3390
  */
3382
3391
  closeOnLastViewRemoved: boolean;
3392
+ /**
3393
+ * @defaultValue 'all'
3394
+ *
3395
+ * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3396
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3397
+ */
3398
+ viewsPreventingClose: 'all' | 'layout';
3383
3399
  /**
3384
3400
  * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
3385
3401
  * this value will be ignored for subsequent launches in favor of the cached value.
@@ -3311,6 +3311,15 @@ declare type ConstViewOptions = {
3311
3311
  * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
3312
3312
  */
3313
3313
  autoplayPolicy: AutoplayPolicyOptions;
3314
+ /**
3315
+ * **Platforms Only.**
3316
+ * Determines what happens when a view is closed in a platform window.
3317
+ * Supersedes `detachOnClose`, but has no default value.
3318
+ * 'hide' hides the view on the platform window that closed it.
3319
+ * 'detach' behaves like 'detachOnClose': true.
3320
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3321
+ */
3322
+ closeBehavior?: 'hide' | 'detach' | 'destroy';
3314
3323
  };
3315
3324
 
3316
3325
  /**
@@ -3377,9 +3386,16 @@ declare type ConstWindowOptions = {
3377
3386
  * This is meant for advanced users and should be used with caution.
3378
3387
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3379
3388
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3380
- * ** note ** - This option is ignored in non-Platforms apps.
3389
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3381
3390
  */
3382
3391
  closeOnLastViewRemoved: boolean;
3392
+ /**
3393
+ * @defaultValue 'all'
3394
+ *
3395
+ * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3396
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3397
+ */
3398
+ viewsPreventingClose: 'all' | 'layout';
3383
3399
  /**
3384
3400
  * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
3385
3401
  * this value will be ignored for subsequent launches in favor of the cached value.
package/out/mock.d.ts CHANGED
@@ -3405,6 +3405,15 @@ declare type ConstViewOptions = {
3405
3405
  * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
3406
3406
  */
3407
3407
  autoplayPolicy: AutoplayPolicyOptions;
3408
+ /**
3409
+ * **Platforms Only.**
3410
+ * Determines what happens when a view is closed in a platform window.
3411
+ * Supersedes `detachOnClose`, but has no default value.
3412
+ * 'hide' hides the view on the platform window that closed it.
3413
+ * 'detach' behaves like 'detachOnClose': true.
3414
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3415
+ */
3416
+ closeBehavior?: 'hide' | 'detach' | 'destroy';
3408
3417
  };
3409
3418
 
3410
3419
  /**
@@ -3471,9 +3480,16 @@ declare type ConstWindowOptions = {
3471
3480
  * This is meant for advanced users and should be used with caution.
3472
3481
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3473
3482
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3474
- * ** note ** - This option is ignored in non-Platforms apps.
3483
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3475
3484
  */
3476
3485
  closeOnLastViewRemoved: boolean;
3486
+ /**
3487
+ * @defaultValue 'all'
3488
+ *
3489
+ * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3490
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3491
+ */
3492
+ viewsPreventingClose: 'all' | 'layout';
3477
3493
  /**
3478
3494
  * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
3479
3495
  * this value will be ignored for subsequent launches in favor of the cached value.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "34.78.22",
3
+ "version": "34.78.23",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "main": "out/mock.js",