@openfin/core 36.79.13 → 36.79.15

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.
@@ -4466,6 +4466,32 @@ declare type CreateLayoutOptions = {
4466
4466
  container: HTMLElement;
4467
4467
  layoutName: string;
4468
4468
  layout: LayoutOptions;
4469
+ /**
4470
+ * @defaultValue 'default'
4471
+ *
4472
+ * Controls the View behavior for the given `layout` property. Note
4473
+ * that the selected behavior only applies to unnamed Views or
4474
+ * Views with the prefix `internal-generated-`. In all cases, if any
4475
+ * View in the `layout` does not already exist, it will be created
4476
+ * with a name that starts with `internal-generated-`.
4477
+ *
4478
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4479
+ * be reparented to the current Window and added to this new Layout.
4480
+ * Use this option when you need to transfer an existing Layout between Windows.
4481
+ *
4482
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4483
+ * be duplicated with new generated names. Use this option when you need
4484
+ * to clone a Layout to any Window.
4485
+ *
4486
+ * When set to `default` or omitted, the Layout will attempt to re-use
4487
+ * existing Views only if they are attached to the current Window or
4488
+ * the Provider Window. Set to `default` or omit this option when creating
4489
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4490
+ * override. Note that during applyLayoutSnapshot, Views are created and
4491
+ * attached to the Provider while the Window is being created, so it's
4492
+ * important to not 'duplicate' Views in this workflow.
4493
+ */
4494
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4469
4495
  };
4470
4496
 
4471
4497
  /**
@@ -9403,6 +9429,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
9403
9429
  type: 'monitor-info-changed';
9404
9430
  };
9405
9431
 
9432
+ /**
9433
+ * @experimental
9434
+ *
9435
+ * Used to control view behavior for Layout.create API
9436
+ */
9437
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9438
+
9406
9439
  /**
9407
9440
  * @interface
9408
9441
  */
@@ -10123,6 +10156,7 @@ declare namespace OpenFin_2 {
10123
10156
  LayoutManagerOverride,
10124
10157
  LayoutManager,
10125
10158
  CreateLayoutOptions,
10159
+ MultiInstanceViewBehavior,
10126
10160
  PresetLayoutOptions_2 as PresetLayoutOptions,
10127
10161
  ResultBehavior,
10128
10162
  PopupBaseBehavior,
@@ -4466,6 +4466,32 @@ declare type CreateLayoutOptions = {
4466
4466
  container: HTMLElement;
4467
4467
  layoutName: string;
4468
4468
  layout: LayoutOptions;
4469
+ /**
4470
+ * @defaultValue 'default'
4471
+ *
4472
+ * Controls the View behavior for the given `layout` property. Note
4473
+ * that the selected behavior only applies to unnamed Views or
4474
+ * Views with the prefix `internal-generated-`. In all cases, if any
4475
+ * View in the `layout` does not already exist, it will be created
4476
+ * with a name that starts with `internal-generated-`.
4477
+ *
4478
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4479
+ * be reparented to the current Window and added to this new Layout.
4480
+ * Use this option when you need to transfer an existing Layout between Windows.
4481
+ *
4482
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4483
+ * be duplicated with new generated names. Use this option when you need
4484
+ * to clone a Layout to any Window.
4485
+ *
4486
+ * When set to `default` or omitted, the Layout will attempt to re-use
4487
+ * existing Views only if they are attached to the current Window or
4488
+ * the Provider Window. Set to `default` or omit this option when creating
4489
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4490
+ * override. Note that during applyLayoutSnapshot, Views are created and
4491
+ * attached to the Provider while the Window is being created, so it's
4492
+ * important to not 'duplicate' Views in this workflow.
4493
+ */
4494
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4469
4495
  };
4470
4496
 
4471
4497
  /**
@@ -9403,6 +9429,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
9403
9429
  type: 'monitor-info-changed';
9404
9430
  };
9405
9431
 
9432
+ /**
9433
+ * @experimental
9434
+ *
9435
+ * Used to control view behavior for Layout.create API
9436
+ */
9437
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9438
+
9406
9439
  /**
9407
9440
  * @interface
9408
9441
  */
@@ -10123,6 +10156,7 @@ declare namespace OpenFin_2 {
10123
10156
  LayoutManagerOverride,
10124
10157
  LayoutManager,
10125
10158
  CreateLayoutOptions,
10159
+ MultiInstanceViewBehavior,
10126
10160
  PresetLayoutOptions_2 as PresetLayoutOptions,
10127
10161
  ResultBehavior,
10128
10162
  PopupBaseBehavior,
@@ -4466,6 +4466,32 @@ declare type CreateLayoutOptions = {
4466
4466
  container: HTMLElement;
4467
4467
  layoutName: string;
4468
4468
  layout: LayoutOptions;
4469
+ /**
4470
+ * @defaultValue 'default'
4471
+ *
4472
+ * Controls the View behavior for the given `layout` property. Note
4473
+ * that the selected behavior only applies to unnamed Views or
4474
+ * Views with the prefix `internal-generated-`. In all cases, if any
4475
+ * View in the `layout` does not already exist, it will be created
4476
+ * with a name that starts with `internal-generated-`.
4477
+ *
4478
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4479
+ * be reparented to the current Window and added to this new Layout.
4480
+ * Use this option when you need to transfer an existing Layout between Windows.
4481
+ *
4482
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4483
+ * be duplicated with new generated names. Use this option when you need
4484
+ * to clone a Layout to any Window.
4485
+ *
4486
+ * When set to `default` or omitted, the Layout will attempt to re-use
4487
+ * existing Views only if they are attached to the current Window or
4488
+ * the Provider Window. Set to `default` or omit this option when creating
4489
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4490
+ * override. Note that during applyLayoutSnapshot, Views are created and
4491
+ * attached to the Provider while the Window is being created, so it's
4492
+ * important to not 'duplicate' Views in this workflow.
4493
+ */
4494
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4469
4495
  };
4470
4496
 
4471
4497
  /**
@@ -9403,6 +9429,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
9403
9429
  type: 'monitor-info-changed';
9404
9430
  };
9405
9431
 
9432
+ /**
9433
+ * @experimental
9434
+ *
9435
+ * Used to control view behavior for Layout.create API
9436
+ */
9437
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9438
+
9406
9439
  /**
9407
9440
  * @interface
9408
9441
  */
@@ -10123,6 +10156,7 @@ declare namespace OpenFin_2 {
10123
10156
  LayoutManagerOverride,
10124
10157
  LayoutManager,
10125
10158
  CreateLayoutOptions,
10159
+ MultiInstanceViewBehavior,
10126
10160
  PresetLayoutOptions_2 as PresetLayoutOptions,
10127
10161
  ResultBehavior,
10128
10162
  PopupBaseBehavior,
package/out/mock.d.ts CHANGED
@@ -4509,6 +4509,32 @@ declare type CreateLayoutOptions = {
4509
4509
  container: HTMLElement;
4510
4510
  layoutName: string;
4511
4511
  layout: LayoutOptions;
4512
+ /**
4513
+ * @defaultValue 'default'
4514
+ *
4515
+ * Controls the View behavior for the given `layout` property. Note
4516
+ * that the selected behavior only applies to unnamed Views or
4517
+ * Views with the prefix `internal-generated-`. In all cases, if any
4518
+ * View in the `layout` does not already exist, it will be created
4519
+ * with a name that starts with `internal-generated-`.
4520
+ *
4521
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4522
+ * be reparented to the current Window and added to this new Layout.
4523
+ * Use this option when you need to transfer an existing Layout between Windows.
4524
+ *
4525
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4526
+ * be duplicated with new generated names. Use this option when you need
4527
+ * to clone a Layout to any Window.
4528
+ *
4529
+ * When set to `default` or omitted, the Layout will attempt to re-use
4530
+ * existing Views only if they are attached to the current Window or
4531
+ * the Provider Window. Set to `default` or omit this option when creating
4532
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4533
+ * override. Note that during applyLayoutSnapshot, Views are created and
4534
+ * attached to the Provider while the Window is being created, so it's
4535
+ * important to not 'duplicate' Views in this workflow.
4536
+ */
4537
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4512
4538
  };
4513
4539
 
4514
4540
  /**
@@ -9680,6 +9706,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin_2.MonitorInfo & {
9680
9706
  type: 'monitor-info-changed';
9681
9707
  };
9682
9708
 
9709
+ /**
9710
+ * @experimental
9711
+ *
9712
+ * Used to control view behavior for Layout.create API
9713
+ */
9714
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9715
+
9683
9716
  /**
9684
9717
  * @interface
9685
9718
  */
@@ -10422,6 +10455,7 @@ declare namespace OpenFin_2 {
10422
10455
  LayoutManagerOverride,
10423
10456
  LayoutManager,
10424
10457
  CreateLayoutOptions,
10458
+ MultiInstanceViewBehavior,
10425
10459
  PresetLayoutOptions_2 as PresetLayoutOptions,
10426
10460
  ResultBehavior,
10427
10461
  PopupBaseBehavior,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "36.79.13",
3
+ "version": "36.79.15",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",