@openfin/node-adapter 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.
@@ -3315,6 +3315,15 @@ declare type ConstViewOptions = {
3315
3315
  * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
3316
3316
  */
3317
3317
  autoplayPolicy: AutoplayPolicyOptions;
3318
+ /**
3319
+ * **Platforms Only.**
3320
+ * Determines what happens when a view is closed in a platform window.
3321
+ * Supersedes `detachOnClose`, but has no default value.
3322
+ * 'hide' hides the view on the platform window that closed it.
3323
+ * 'detach' behaves like 'detachOnClose': true.
3324
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3325
+ */
3326
+ closeBehavior?: 'hide' | 'detach' | 'destroy';
3318
3327
  };
3319
3328
 
3320
3329
  /**
@@ -3381,9 +3390,16 @@ declare type ConstWindowOptions = {
3381
3390
  * This is meant for advanced users and should be used with caution.
3382
3391
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3383
3392
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3384
- * ** note ** - This option is ignored in non-Platforms apps.
3393
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3385
3394
  */
3386
3395
  closeOnLastViewRemoved: boolean;
3396
+ /**
3397
+ * @defaultValue 'all'
3398
+ *
3399
+ * 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'.
3400
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3401
+ */
3402
+ viewsPreventingClose: 'all' | 'layout';
3387
3403
  /**
3388
3404
  * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
3389
3405
  * this value will be ignored for subsequent launches in favor of the cached value.
@@ -3315,6 +3315,15 @@ declare type ConstViewOptions = {
3315
3315
  * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
3316
3316
  */
3317
3317
  autoplayPolicy: AutoplayPolicyOptions;
3318
+ /**
3319
+ * **Platforms Only.**
3320
+ * Determines what happens when a view is closed in a platform window.
3321
+ * Supersedes `detachOnClose`, but has no default value.
3322
+ * 'hide' hides the view on the platform window that closed it.
3323
+ * 'detach' behaves like 'detachOnClose': true.
3324
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3325
+ */
3326
+ closeBehavior?: 'hide' | 'detach' | 'destroy';
3318
3327
  };
3319
3328
 
3320
3329
  /**
@@ -3381,9 +3390,16 @@ declare type ConstWindowOptions = {
3381
3390
  * This is meant for advanced users and should be used with caution.
3382
3391
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3383
3392
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3384
- * ** note ** - This option is ignored in non-Platforms apps.
3393
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3385
3394
  */
3386
3395
  closeOnLastViewRemoved: boolean;
3396
+ /**
3397
+ * @defaultValue 'all'
3398
+ *
3399
+ * 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'.
3400
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3401
+ */
3402
+ viewsPreventingClose: 'all' | 'layout';
3387
3403
  /**
3388
3404
  * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
3389
3405
  * this value will be ignored for subsequent launches in favor of the cached value.
@@ -3315,6 +3315,15 @@ declare type ConstViewOptions = {
3315
3315
  * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
3316
3316
  */
3317
3317
  autoplayPolicy: AutoplayPolicyOptions;
3318
+ /**
3319
+ * **Platforms Only.**
3320
+ * Determines what happens when a view is closed in a platform window.
3321
+ * Supersedes `detachOnClose`, but has no default value.
3322
+ * 'hide' hides the view on the platform window that closed it.
3323
+ * 'detach' behaves like 'detachOnClose': true.
3324
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3325
+ */
3326
+ closeBehavior?: 'hide' | 'detach' | 'destroy';
3318
3327
  };
3319
3328
 
3320
3329
  /**
@@ -3381,9 +3390,16 @@ declare type ConstWindowOptions = {
3381
3390
  * This is meant for advanced users and should be used with caution.
3382
3391
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3383
3392
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3384
- * ** note ** - This option is ignored in non-Platforms apps.
3393
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3385
3394
  */
3386
3395
  closeOnLastViewRemoved: boolean;
3396
+ /**
3397
+ * @defaultValue 'all'
3398
+ *
3399
+ * 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'.
3400
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3401
+ */
3402
+ viewsPreventingClose: 'all' | 'layout';
3387
3403
  /**
3388
3404
  * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
3389
3405
  * this value will be ignored for subsequent launches in favor of the cached value.
@@ -3409,6 +3409,15 @@ declare type ConstViewOptions = {
3409
3409
  * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
3410
3410
  */
3411
3411
  autoplayPolicy: AutoplayPolicyOptions;
3412
+ /**
3413
+ * **Platforms Only.**
3414
+ * Determines what happens when a view is closed in a platform window.
3415
+ * Supersedes `detachOnClose`, but has no default value.
3416
+ * 'hide' hides the view on the platform window that closed it.
3417
+ * 'detach' behaves like 'detachOnClose': true.
3418
+ * 'destroy' is the default behavior as long as 'detachOnClose' is not set.
3419
+ */
3420
+ closeBehavior?: 'hide' | 'detach' | 'destroy';
3412
3421
  };
3413
3422
 
3414
3423
  /**
@@ -3475,9 +3484,16 @@ declare type ConstWindowOptions = {
3475
3484
  * This is meant for advanced users and should be used with caution.
3476
3485
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3477
3486
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3478
- * ** note ** - This option is ignored in non-Platforms apps.
3487
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3479
3488
  */
3480
3489
  closeOnLastViewRemoved: boolean;
3490
+ /**
3491
+ * @defaultValue 'all'
3492
+ *
3493
+ * 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'.
3494
+ * **NOTE:** - This option is ignored in non-Platforms apps.
3495
+ */
3496
+ viewsPreventingClose: 'all' | 'layout';
3481
3497
  /**
3482
3498
  * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
3483
3499
  * 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/node-adapter",
3
- "version": "34.78.22",
3
+ "version": "34.78.23",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",