@openfin/core 40.105.3 → 40.105.6

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/stub.d.ts CHANGED
@@ -129,13 +129,13 @@ declare type ApiSettings = {
129
129
  /**
130
130
  * Inject OpenFin API into cross-origin iframes
131
131
  *
132
- * @defaultValue false
132
+ * @default false
133
133
  */
134
134
  crossOriginInjection?: boolean;
135
135
  /**
136
136
  * Inject OpenFin API into same-origin iframes
137
137
  *
138
- * @defaultValue true
138
+ * @default true
139
139
  */
140
140
  sameOriginInjection?: boolean;
141
141
  /**
@@ -1180,19 +1180,19 @@ declare class ApplicationModule extends Base {
1180
1180
  */
1181
1181
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1182
1182
  /**
1183
- * @defaultValue false
1184
- *
1185
1183
  * Disables IAB secure logging for the app.
1184
+ *
1185
+ * @default false
1186
1186
  */
1187
1187
  disableIabSecureLogging: boolean;
1188
1188
  /**
1189
- * @defaultValue 'There was an error loading the application.'
1190
- *
1191
1189
  * An error message to display when the application (launched via manifest) fails to load.
1192
1190
  * A dialog box will be launched with the error message just before the runtime exits.
1193
1191
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1194
1192
  * will trigger this dialog.
1195
1193
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1194
+ *
1195
+ * @default 'There was an error loading the application.'
1196
1196
  */
1197
1197
  loadErrorMessage: string;
1198
1198
  /**
@@ -1211,28 +1211,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1211
1211
  */
1212
1212
  name: string;
1213
1213
  /**
1214
- * @defaultValue false
1215
- *
1216
1214
  * A flag to configure the application as non-persistent.
1217
1215
  * Runtime exits when there are no persistent apps running.
1216
+ *
1217
+ * @default false
1218
1218
  */
1219
1219
  nonPersistent: boolean;
1220
1220
  /**
1221
- * @defaultValue false
1222
- *
1223
1221
  * Enable Flash at the application level.
1222
+ *
1223
+ * @default false
1224
1224
  */
1225
1225
  plugins: boolean;
1226
1226
  /**
1227
- * @defaultValue false
1228
- *
1229
1227
  * Enable spell check at the application level.
1228
+ *
1229
+ * @default false
1230
1230
  */
1231
1231
  spellCheck: boolean;
1232
1232
  /**
1233
- * @defaultValue 'about:blank'
1234
- *
1235
1233
  * The url to the application (specifically the application's main window).
1234
+ *
1235
+ * @default 'about:blank'
1236
1236
  */
1237
1237
  url: string;
1238
1238
  /**
@@ -1241,9 +1241,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1241
1241
  */
1242
1242
  uuid: string;
1243
1243
  /**
1244
- * @defaultValue true
1245
- *
1246
1244
  * When set to `false` it will disable the same-origin policy for the app.
1245
+ *
1246
+ * @default true
1247
1247
  */
1248
1248
  webSecurity: boolean;
1249
1249
  /**
@@ -1253,10 +1253,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1253
1253
  commands: ShortcutOverride[];
1254
1254
  isPlatformController: boolean;
1255
1255
  /**
1256
- * @defaultValue 1000
1257
- *
1258
1256
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1259
1257
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1258
+ *
1259
+ * @default 1000
1260
1260
  */
1261
1261
  maxViewPoolSize: number;
1262
1262
  /**
@@ -1272,12 +1272,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1272
1272
  */
1273
1273
  snapshot: Snapshot;
1274
1274
  /**
1275
- * @defaultValue false
1276
- *
1277
1275
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1278
1276
  *
1279
1277
  * Note: if the Platform Provider is showing, it won't close automatically.
1280
1278
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1279
+ *
1280
+ * @default false
1281
1281
  */
1282
1282
  preventQuitOnLastWindowClosed: boolean;
1283
1283
  /**
@@ -1285,9 +1285,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1285
1285
  */
1286
1286
  interopBrokerConfiguration: InteropBrokerOptions;
1287
1287
  /**
1288
- * @defaultValue true
1289
- *
1290
1288
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1289
+ *
1290
+ * @default true
1291
1291
  */
1292
1292
  apiDiagnostics: boolean;
1293
1293
  /**
@@ -1303,16 +1303,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1303
1303
  */
1304
1304
  permissions?: Partial<Permissions_2>;
1305
1305
  /**
1306
- * @defaultValue false
1307
- *
1308
1306
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1309
1307
  * Only relevant in Windows.
1308
+ *
1309
+ * @default false
1310
1310
  */
1311
1311
  enableJumpList: boolean;
1312
1312
  /**
1313
- * @defaultValue false
1314
- *
1315
1313
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1314
+ *
1315
+ * @default false
1316
1316
  */
1317
1317
  enableBeforeUnload: boolean;
1318
1318
  /**
@@ -1393,25 +1393,25 @@ declare type ApplicationWindowInfo = {
1393
1393
  */
1394
1394
  declare type ApplySnapshotOptions = {
1395
1395
  /**
1396
- * @defaultValue false
1397
- *
1398
1396
  * When true, applySnapshot will close existing windows,
1399
1397
  * replacing current Platform state with the given snapshot.
1398
+ *
1399
+ * @default false
1400
1400
  */
1401
1401
  closeExistingWindows?: boolean;
1402
1402
  /**
1403
- * @defaultValue false
1404
- *
1405
1403
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1406
1404
  * replacing current Platform state with the given snapshot.
1405
+ *
1406
+ * @default false
1407
1407
  */
1408
1408
  closeSnapshotWindows?: boolean;
1409
1409
  /**
1410
- * @defaultValue false
1411
- *
1412
1410
  * When true, applySnapshot will not check whether any windows in a
1413
1411
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1414
1412
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1413
+ *
1414
+ * @default false
1415
1415
  */
1416
1416
  skipOutOfBoundsCheck?: boolean;
1417
1417
  };
@@ -2094,15 +2094,15 @@ declare type CapturePageOptions = {
2094
2094
  */
2095
2095
  area?: Rectangle;
2096
2096
  /**
2097
- * @defaultValue 'png'
2098
- *
2099
2097
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2098
+ *
2099
+ * @default 'png'
2100
2100
  */
2101
2101
  format?: 'bmp' | 'jpg' | 'png';
2102
2102
  /**
2103
- * @defaultValue 100
2104
- *
2105
2103
  * Quality of JPEG image. Between 0 - 100.
2104
+ *
2105
+ * @default 100
2106
2106
  */
2107
2107
  quality?: number;
2108
2108
  };
@@ -2756,9 +2756,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2756
2756
  */
2757
2757
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2758
2758
  /**
2759
- * @defaultValue true
2760
- *
2761
2759
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2760
+ *
2761
+ * @default true
2762
2762
  */
2763
2763
  wait?: boolean;
2764
2764
  /**
@@ -3420,9 +3420,9 @@ declare interface CloseWindowPayload {
3420
3420
  windowId: Identity_4;
3421
3421
  options: {
3422
3422
  /**
3423
- * @defaultValue false
3424
- *
3425
3423
  * When set to true skips any before handler set on views that are part of the window
3424
+ *
3425
+ * @default false
3426
3426
  */
3427
3427
  skipBeforeUnload?: boolean;
3428
3428
  };
@@ -3530,9 +3530,9 @@ declare type ConstViewOptions = {
3530
3530
  */
3531
3531
  name: string;
3532
3532
  /**
3533
- * @defaultValue "about:blank"
3534
- *
3535
3533
  * The URL of the window
3534
+ *
3535
+ * @default "about:blank"
3536
3536
  */
3537
3537
  url: string;
3538
3538
  /**
@@ -3590,9 +3590,9 @@ declare type ConstViewOptions = {
3590
3590
  experimental: any;
3591
3591
  fdc3InteropApi?: string;
3592
3592
  /**
3593
- * @defaultValue false
3594
- *
3595
3593
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3594
+ *
3595
+ * @default false
3596
3596
  */
3597
3597
  enableBeforeUnload: boolean;
3598
3598
  /**
@@ -3673,13 +3673,12 @@ declare type ConstWindowOptions = {
3673
3673
  */
3674
3674
  backgroundColor: string;
3675
3675
  /**
3676
- * @defaultValue false
3677
- *
3678
3676
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3679
3677
  * This also affects the Page Visibility API.
3680
3678
  *
3681
3679
  * When `true`, the page is throttled whether it is hidden or not.
3682
3680
  *
3681
+ * @default false
3683
3682
  */
3684
3683
  backgroundThrottling: boolean;
3685
3684
  /**
@@ -3703,21 +3702,21 @@ declare type ConstWindowOptions = {
3703
3702
  */
3704
3703
  customRequestHeaders: CustomRequestHeaders[];
3705
3704
  /**
3706
- * @defaultValue true
3707
- *
3708
3705
  * Setting this to false would keep the Window alive even if all its Views were closed.
3709
3706
  * This is meant for advanced users and should be used with caution.
3710
3707
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3711
3708
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3712
3709
  * **NOTE:** - This option is ignored in non-Platforms apps.
3710
+ *
3711
+ * @default true
3713
3712
  */
3714
3713
  closeOnLastViewRemoved: boolean;
3715
3714
  /**
3716
- * @defaultValue 'all'
3717
- *
3718
3715
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3719
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3716
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3720
3717
  * **NOTE:** - This option is ignored in non-Platforms apps.
3718
+ *
3719
+ * @default 'all'
3721
3720
  */
3722
3721
  viewsPreventingClose: 'all' | 'layout';
3723
3722
  /**
@@ -3728,31 +3727,31 @@ declare type ConstWindowOptions = {
3728
3727
  */
3729
3728
  defaultCentered: boolean;
3730
3729
  /**
3731
- * @defaultValue 500
3732
- *
3733
3730
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3734
3731
  * in favor of the cached value.
3732
+ *
3733
+ * @default 500
3735
3734
  */
3736
3735
  defaultHeight: number;
3737
3736
  /**
3738
- * @defaultValue 100
3739
- *
3740
3737
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3741
3738
  * launches in favor of the cached value.
3739
+ *
3740
+ * @default 100
3742
3741
  */
3743
3742
  defaultLeft: number;
3744
3743
  /**
3745
- * @defaultValue 100
3746
- *
3747
3744
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3748
3745
  * launches in favor of the cached value.
3746
+ *
3747
+ * @default 100
3749
3748
  */
3750
3749
  defaultTop: number;
3751
3750
  /**
3752
- * @defaultValue 800
3753
- *
3754
3751
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3755
3752
  * launches in favor of the cached value.
3753
+ *
3754
+ * @default 800
3756
3755
  */
3757
3756
  defaultWidth: number;
3758
3757
  /**
@@ -3798,19 +3797,19 @@ declare type ConstWindowOptions = {
3798
3797
  */
3799
3798
  processAffinity: string;
3800
3799
  /**
3801
- * @defaultValue false
3802
- *
3803
3800
  * Displays a shadow on frameless windows.
3804
3801
  * `shadow` and `cornerRounding` are mutually exclusive.
3805
3802
  * On Windows 7, Aero theme is required.
3803
+ *
3804
+ * @default false
3806
3805
  */
3807
3806
  shadow: boolean;
3808
3807
  /**
3809
- * @defaultValue true
3810
- *
3811
3808
  * Caches the location of the window.
3812
3809
  *
3813
3810
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3811
+ *
3812
+ * @default true
3814
3813
  */
3815
3814
  saveWindowState: boolean;
3816
3815
  /**
@@ -3819,22 +3818,22 @@ declare type ConstWindowOptions = {
3819
3818
  */
3820
3819
  ignoreSavedWindowState: boolean;
3821
3820
  /**
3822
- * @defaultValue false
3823
- *
3824
3821
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3825
3822
  *
3826
3823
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3827
3824
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3825
+ *
3826
+ * @default false
3828
3827
  */
3829
3828
  smallWindow: boolean;
3830
3829
  /**
3831
- * @defaultValue "normal"
3832
- *
3833
3830
  * The visible state of the window on creation.
3834
3831
  * One of:
3835
3832
  * * `"maximized"`
3836
3833
  * * `"minimized"`
3837
3834
  * * `"normal"`
3835
+ *
3836
+ * @default "normal"
3838
3837
  */
3839
3838
  state: WindowState;
3840
3839
  /**
@@ -3848,20 +3847,20 @@ declare type ConstWindowOptions = {
3848
3847
  */
3849
3848
  url: string;
3850
3849
  /**
3851
- * @defaultValue <application UUID>
3852
- *
3853
3850
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3854
3851
  * If omitted, defaults to the `uuid` of the application spawning the window.
3855
3852
  * If given, must match the `uuid` of the application spawning the window.
3856
3853
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3857
3854
  * really no need to provide it.
3855
+ *
3856
+ * @default <application UUID>
3858
3857
  */
3859
3858
  uuid: string;
3860
3859
  /**
3861
- * @defaultValue false
3862
- *
3863
3860
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3864
3861
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3862
+ *
3863
+ * @default false
3865
3864
  */
3866
3865
  waitForPageLoad: boolean;
3867
3866
  width: number;
@@ -4133,13 +4132,13 @@ declare type CopyBlockedEventReason = 'disabled';
4133
4132
  */
4134
4133
  declare type CopyPermissions = {
4135
4134
  /**
4136
- * @defaultValue 'allowed'
4137
- *
4138
4135
  * Controls the behavior for copy operations for a matched URL.
4139
4136
  *
4140
4137
  * allow: Enables all copy operations.
4141
4138
  * block: Disables all copy operations.
4142
4139
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4140
+ *
4141
+ * @default 'allowed'
4143
4142
  */
4144
4143
  behavior: 'allow' | 'block' | 'protect';
4145
4144
  /**
@@ -4147,9 +4146,9 @@ declare type CopyPermissions = {
4147
4146
  */
4148
4147
  options?: {
4149
4148
  /**
4150
- * @defaultValue ''
4151
- *
4152
4149
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4150
+ *
4151
+ * @default ''
4153
4152
  */
4154
4153
  replacementText: string;
4155
4154
  };
@@ -4163,15 +4162,15 @@ declare type CopyPermissions = {
4163
4162
  */
4164
4163
  declare type CornerRounding = {
4165
4164
  /**
4166
- * @defaultValue 0
4167
- *
4168
4165
  * The height in pixels.
4166
+ *
4167
+ * @default 0
4169
4168
  */
4170
4169
  height: number;
4171
4170
  /**
4172
- * @defaultValue 0
4173
- *
4174
4171
  * The width in pixels.
4172
+ *
4173
+ * @default 0
4175
4174
  */
4176
4175
  width: number;
4177
4176
  };
@@ -4261,8 +4260,6 @@ declare type CreateLayoutOptions = {
4261
4260
  layoutName: string;
4262
4261
  layout: LayoutOptions;
4263
4262
  /**
4264
- * @defaultValue 'default'
4265
- *
4266
4263
  * Controls the View behavior for the given `layout` property. Note
4267
4264
  * that the selected behavior only applies to unnamed Views or
4268
4265
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4284,6 +4281,8 @@ declare type CreateLayoutOptions = {
4284
4281
  * override. Note that during applyLayoutSnapshot, Views are created and
4285
4282
  * attached to the Provider while the Window is being created, so it's
4286
4283
  * important to not 'duplicate' Views in this workflow.
4284
+ *
4285
+ * @default 'default'
4287
4286
  */
4288
4287
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4289
4288
  };
@@ -4543,7 +4542,7 @@ declare type DomainApiSettings = {
4543
4542
  * * 'none': The `fin` API will be not available.
4544
4543
  * * 'global': The entire `fin` API will be available.
4545
4544
  *
4546
- * @defaultValue 'global'
4545
+ * @default 'global'
4547
4546
  */
4548
4547
  fin?: InjectionType;
4549
4548
  /**
@@ -5135,9 +5134,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5135
5134
  */
5136
5135
  declare type ExcludeOptions = {
5137
5136
  /**
5138
- * @defaultValue false
5139
- *
5140
5137
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5138
+ *
5139
+ * @default false
5141
5140
  */
5142
5141
  preloadScripts: boolean;
5143
5142
  };
@@ -5457,6 +5456,10 @@ declare namespace FDC3 {
5457
5456
  }
5458
5457
  }
5459
5458
 
5459
+ declare type FDC3Factory = typeof fdc3Factory;
5460
+
5461
+ declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin_2.InteropClient, wire: Transport<'unknown'>) => OpenFin_2.FDC3.v2_0.DesktopAgent | OpenFin_2.FDC3.v1_2.DesktopAgent;
5462
+
5460
5463
  /**
5461
5464
  * @interface
5462
5465
  */
@@ -5619,34 +5622,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5619
5622
  */
5620
5623
  declare type FindInPageOptions = {
5621
5624
  /**
5622
- * @defaultValue true
5623
- *
5624
5625
  * Searches in the forward direction (backward otherwise)
5626
+ *
5627
+ * @default true
5625
5628
  */
5626
5629
  forward?: boolean;
5627
5630
  /**
5628
- * @defaultValue false
5629
- *
5630
5631
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5632
+ *
5633
+ * @default false
5631
5634
  */
5632
5635
  findNext?: boolean;
5633
5636
  /**
5634
- * @defaultValue false
5635
- *
5636
5637
  * Enables case-sensitive searching.
5638
+ *
5639
+ * @default false
5637
5640
  */
5638
5641
  matchCase?: boolean;
5639
5642
  /**
5640
- * @defaultValue false
5641
- *
5642
5643
  * Only searches from the start of words.
5644
+ *
5645
+ * @default false
5643
5646
  */
5644
5647
  wordStart?: boolean;
5645
5648
  /**
5646
- * @defaultValue false
5647
- *
5648
5649
  * When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
5649
5650
  * lowercase or non-letter. Accepts several other intra-word matches.
5651
+ *
5652
+ * @default false
5650
5653
  */
5651
5654
  medialCapitalAsWordStart?: boolean;
5652
5655
  };
@@ -6160,9 +6163,9 @@ declare type Hotkey = {
6160
6163
  */
6161
6164
  keys: string;
6162
6165
  /**
6163
- * @defaultValue false
6164
- *
6165
6166
  * Prevent default key handling before emitting the event.
6167
+ *
6168
+ * @default false
6166
6169
  */
6167
6170
  preventDefault?: boolean;
6168
6171
  };
@@ -7133,7 +7136,7 @@ declare class InteropBroker extends Base {
7133
7136
  };
7134
7137
  private getClientState;
7135
7138
  private static toObject;
7136
- static checkContextIntegrity(context: OpenFin_2.Context): {
7139
+ static checkContextIntegrity: (context: OpenFin_2.Context) => {
7137
7140
  isValid: true;
7138
7141
  } | {
7139
7142
  isValid: false;
@@ -7232,7 +7235,7 @@ declare class InteropClient extends Base {
7232
7235
  /**
7233
7236
  * @internal
7234
7237
  */
7235
- constructor(wire: Transport, clientPromise: Promise<OpenFin_2.ChannelClient>);
7238
+ constructor(wire: Transport, clientPromise: Promise<OpenFin_2.ChannelClient>, fdc3Factory: FDC3Factory);
7236
7239
  /**
7237
7240
  * Sets a context for the context group of the current entity.
7238
7241
  *
@@ -8703,77 +8706,79 @@ declare type LayoutOptions = {
8703
8706
  */
8704
8707
  settings?: {
8705
8708
  /**
8706
- * @defaultValue false
8707
- *
8708
8709
  * When true the splitters will not be draggable and the layout will not resize.
8710
+ *
8711
+ * @default false
8709
8712
  */
8710
8713
  preventSplitterResize?: boolean;
8711
8714
  /**
8712
- * @defaultValue false
8713
- *
8714
8715
  * Whether the popout button will only act on the entire stack,
8715
8716
  * as opposed to only the active tab.
8717
+ *
8718
+ * @default false
8716
8719
  */
8717
8720
  popoutWholeStack?: boolean;
8718
8721
  /**
8719
- * @defaultValue false
8720
- *
8721
8722
  * Limits the area to which tabs can be dragged.
8722
8723
  * If true, the layout container is the only area where tabs can be dropped.
8724
+ *
8725
+ * @default false
8723
8726
  */
8724
8727
  constrainDragToContainer?: boolean;
8725
8728
  /**
8726
- * @defaultValue false
8727
- *
8728
8729
  * Whether to show the popout button on stack header.
8729
8730
  * The button will create a new window with current tab as its content.
8730
8731
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8732
+ *
8733
+ * @default false
8731
8734
  */
8732
8735
  showPopoutIcon?: boolean;
8733
8736
  /**
8734
- * @defaultValue false
8735
- *
8736
8737
  * Whether to show the maximize button on stack header.
8737
8738
  * The button will maximize the current tab to fill the entire window.
8739
+ *
8740
+ * @default false
8738
8741
  */
8739
8742
  showMaximiseIcon?: boolean;
8740
8743
  /**
8741
- * @defaultValue false
8742
- *
8743
8744
  * Whether to show the close button on stack header
8744
8745
  * (not to be confused with close button on every tab).
8746
+ *
8747
+ * @default false
8745
8748
  */
8746
8749
  showCloseIcon?: boolean;
8747
8750
  /**
8748
- * @defaultValue false
8749
- *
8750
8751
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8752
+ *
8753
+ * @default false
8751
8754
  */
8752
8755
  constrainDragToHeaders?: boolean;
8753
8756
  /**
8754
- * @defaultValue true
8755
- *
8756
8757
  * Turns tab headers on or off.
8757
8758
  * If false, the layout will be displayed with splitters only.
8759
+ *
8760
+ * @default true
8758
8761
  */
8759
8762
  hasHeaders?: boolean;
8760
8763
  /**
8761
- * @defaultValue true
8762
- *
8763
8764
  * If true, the user can re-arrange the layout by
8764
8765
  * dragging items by their tabs to the desired location.
8766
+ *
8767
+ * @default true
8765
8768
  */
8766
8769
  reorderEnabled?: boolean;
8767
8770
  /**
8768
- * @defaultValue false
8769
- *
8770
8771
  * If true, tabs can't be dragged out of the window.
8772
+ *
8773
+ * @default false
8771
8774
  */
8772
8775
  preventDragOut?: boolean;
8773
8776
  /**
8774
8777
  * @defaultValue=false
8775
8778
  *
8776
8779
  * If true, tabs can't be dragged into the window.
8780
+ *
8781
+ * @default false
8777
8782
  */
8778
8783
  preventDragIn?: boolean;
8779
8784
  };
@@ -9216,10 +9221,10 @@ declare type MutableViewOptions = {
9216
9221
  /**
9217
9222
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9218
9223
  *
9219
- * @defaultValue true
9220
- *
9221
9224
  * Show the context menu when right-clicking on the view.
9222
9225
  * Gives access to the devtools for the view.
9226
+ *
9227
+ * @default true
9223
9228
  */
9224
9229
  contextMenu: boolean;
9225
9230
  /**
@@ -9266,24 +9271,25 @@ declare type MutableViewOptions = {
9266
9271
  contentNavigation: ContentNavigation;
9267
9272
  contentRedirect: ContentRedirect;
9268
9273
  /**
9269
- * @defaultValue false
9270
9274
  * @deprecated
9271
9275
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9272
9276
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9277
+ *
9278
+ * @default false
9273
9279
  */
9274
9280
  detachOnClose: boolean;
9275
9281
  /**
9276
- * @defaultValue true
9277
- *
9278
9282
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9279
9283
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9280
9284
  * if the view isn't part of the new layout when running `Layout.replace`.
9285
+ *
9286
+ * @default true
9281
9287
  */
9282
9288
  isClosable: boolean;
9283
9289
  /**
9284
- * @defaultValue false
9285
- *
9286
9290
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9291
+ *
9292
+ * @default false
9287
9293
  */
9288
9294
  preventDragOut: boolean;
9289
9295
  interop?: InteropConfig;
@@ -9295,7 +9301,7 @@ declare type MutableViewOptions = {
9295
9301
  /**
9296
9302
  * {@inheritDoc ViewThrottling}
9297
9303
  *
9298
- * @defaultValue 'enabled'
9304
+ * @default 'enabled'
9299
9305
  */
9300
9306
  throttling: ViewThrottling;
9301
9307
  /**
@@ -9314,7 +9320,7 @@ declare type MutableWindowOptions = {
9314
9320
  * Turns anything of matching RGB value transparent.
9315
9321
  *
9316
9322
  * Caveats:
9317
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9323
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9318
9324
  * * User cannot click-through transparent regions
9319
9325
  * * Not supported on Mac
9320
9326
  * * Windows Aero must be enabled
@@ -9323,25 +9329,25 @@ declare type MutableWindowOptions = {
9323
9329
  */
9324
9330
  alphaMask: RGB;
9325
9331
  /**
9326
- * @defaultValue false
9327
- *
9328
9332
  * Always position the window at the top of the window stack.
9333
+ *
9334
+ * @default false
9329
9335
  */
9330
9336
  alwaysOnTop: boolean;
9331
9337
  /**
9332
- * @defaultValue 0
9333
- *
9334
9338
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9335
9339
  * an aspect ratio will not be enforced.
9340
+ *
9341
+ * @default 0
9336
9342
  */
9337
9343
  aspectRatio: number;
9338
9344
  /**
9339
9345
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9340
9346
  *
9341
- * @defaultValue true
9342
- *
9343
9347
  * Show the context menu when right-clicking on the window.
9344
9348
  * Gives access to the devtools for the window.
9349
+ *
9350
+ * @default true
9345
9351
  */
9346
9352
  contextMenu: boolean;
9347
9353
  /**
@@ -9411,12 +9417,14 @@ declare type MutableWindowOptions = {
9411
9417
  * @defaultValue true
9412
9418
  *
9413
9419
  * Show the window's frame.
9420
+ *
9421
+ * @default true
9414
9422
  */
9415
9423
  frame: boolean;
9416
9424
  /**
9417
- * @defaultValue false
9418
- *
9419
9425
  * Hides the window instead of closing it when the close button is pressed.
9426
+ *
9427
+ * @default false
9420
9428
  */
9421
9429
  hideOnClose: boolean;
9422
9430
  /**
@@ -9469,60 +9477,61 @@ declare type MutableWindowOptions = {
9469
9477
  */
9470
9478
  icon: string;
9471
9479
  /**
9472
- * @defaultValue true
9473
- *
9474
9480
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9475
9481
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9482
+ *
9483
+ * @default true
9476
9484
  */
9477
9485
  includeInSnapshots: boolean;
9478
9486
  /**
9479
- * @defaultValue -1
9480
- *
9481
9487
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9488
+ *
9489
+ * @default -1
9482
9490
  */
9483
9491
  maxHeight: number;
9484
9492
  /**
9485
- * @defaultValue true
9486
- *
9487
9493
  * Allows the window to be maximized.
9494
+ *
9495
+ * @default true
9488
9496
  */
9489
9497
  maximizable: boolean;
9490
9498
  /**
9491
- * @defaultValue -1
9492
- *
9493
9499
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9500
+ *
9501
+ * @default -1
9494
9502
  */
9495
9503
  maxWidth: number;
9496
9504
  /**
9497
- * @defaultValue 0
9498
- *
9499
9505
  * The minimum height of the window.
9506
+ *
9507
+ * @default 0
9500
9508
  */
9501
9509
  minHeight: number;
9502
9510
  /**
9503
- * @defaultValue true
9504
- *
9505
9511
  * Allows the window to be minimized.
9512
+ *
9513
+ * @default true
9506
9514
  */
9507
9515
  minimizable: boolean;
9508
9516
  /**
9509
- * @defaultValue true
9510
- *
9511
9517
  * The minimum width of the window.
9518
+ *
9519
+ * @default true
9512
9520
  */
9513
9521
  minWidth: number;
9514
9522
  /**
9515
- * @defaultValue 1
9516
- *
9517
9523
  * A flag that specifies how transparent the window will be.
9518
9524
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9519
9525
  * This value is clamped between `0.0` and `1.0`.
9526
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9527
+ *
9528
+ * @default 1
9520
9529
  */
9521
9530
  opacity: number;
9522
9531
  /**
9523
- * @defaultValue true
9524
- *
9525
9532
  * A flag to allow the user to resize the window.
9533
+ *
9534
+ * @default true
9526
9535
  */
9527
9536
  resizable: boolean;
9528
9537
  /**
@@ -9530,16 +9539,16 @@ declare type MutableWindowOptions = {
9530
9539
  */
9531
9540
  resizeRegion: ResizeRegion;
9532
9541
  /**
9533
- * @defaultValue false
9534
- *
9535
9542
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9536
9543
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9544
+ *
9545
+ * @default false
9537
9546
  */
9538
9547
  showBackgroundImages: boolean;
9539
9548
  /**
9540
- * @defaultValue true
9541
- *
9542
9549
  * Shows the window's icon in the taskbar.
9550
+ *
9551
+ * @default true
9543
9552
  */
9544
9553
  showTaskbarIcon: boolean;
9545
9554
  /**
@@ -9562,7 +9571,7 @@ declare type MutableWindowOptions = {
9562
9571
  /**
9563
9572
  * {@inheritDoc WindowThrottling}
9564
9573
  *
9565
- * @defaultValue 'enabled'
9574
+ * @default 'enabled'
9566
9575
  *
9567
9576
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9568
9577
  */
@@ -10181,12 +10190,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10181
10190
  */
10182
10191
  declare type PastePermissions = {
10183
10192
  /**
10184
- * @defaultValue 'non-protected-content'
10185
- *
10186
10193
  * Controls the behavior for paste operations for a matched URL.
10187
10194
  *
10188
10195
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10189
10196
  * all-content: All matching URLs will be able to paste content copied from both protected (copy.behavior = 'protect') and on-protected (copy.behavior = 'allow') URLs.
10197
+ *
10198
+ * @default 'non-protected-content'
10190
10199
  */
10191
10200
  behavior: 'non-protected-content' | 'all-content';
10192
10201
  };
@@ -11251,11 +11260,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11251
11260
  */
11252
11261
  providerUrl?: string;
11253
11262
  /**
11254
- * @defaultValue true
11255
- *
11256
11263
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11257
11264
  *
11258
11265
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11266
+ *
11267
+ * @default true
11259
11268
  */
11260
11269
  allowLaunchIntoPlatform?: boolean;
11261
11270
  };
@@ -11944,22 +11953,22 @@ declare type PopupOptions = {
11944
11953
  url?: string;
11945
11954
  /**
11946
11955
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11947
- * @defaultValue 300
11956
+ * @default 300
11948
11957
  */
11949
11958
  height?: number;
11950
11959
  /**
11951
11960
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11952
- * @defaultValue 300
11961
+ * @default 300
11953
11962
  */
11954
11963
  width?: number;
11955
11964
  /**
11956
11965
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11957
- * @defaultValue 0
11966
+ * @default 0
11958
11967
  */
11959
11968
  x?: number;
11960
11969
  /**
11961
11970
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11962
- * @defaultValue 0
11971
+ * @default 0
11963
11972
  */
11964
11973
  y?: number;
11965
11974
  /**
@@ -11967,7 +11976,7 @@ declare type PopupOptions = {
11967
11976
  * * 'modal' restricts resizing and positioning in the caller.
11968
11977
  * * 'hide' hides the popup window on blur.
11969
11978
  * * 'close' closes the popup window on blur.
11970
- * @defaultValue 'close'
11979
+ * @default 'close'
11971
11980
  */
11972
11981
  blurBehavior?: PopupBlurBehavior;
11973
11982
  /**
@@ -11975,19 +11984,19 @@ declare type PopupOptions = {
11975
11984
  * * 'none' will do nothing.
11976
11985
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11977
11986
  * * 'close' closes the popup window on `dispatchPopupResult`.
11978
- * @defaultValue 'close'
11987
+ * @default 'close'
11979
11988
  */
11980
11989
  resultDispatchBehavior?: PopupResultBehavior;
11981
11990
  /**
11982
11991
  * Hide the popup window instead of closing when `close` is called on it.
11983
11992
  *
11984
11993
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11985
- * @defaultValue false
11994
+ * @default false
11986
11995
  */
11987
11996
  hideOnClose?: boolean;
11988
11997
  /**
11989
11998
  * Determines if the popup window should or should not be focused when it is shown.
11990
- * @defaultValue true
11999
+ * @default true
11991
12000
  */
11992
12001
  focus?: boolean;
11993
12002
  /**
@@ -12081,9 +12090,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12081
12090
  */
12082
12091
  declare type PreloadScript = {
12083
12092
  /**
12084
- * @defaultValue false
12085
- *
12086
12093
  * Fail to load the window if this preload script fails
12094
+ *
12095
+ * @default false
12087
12096
  */
12088
12097
  mandatory?: boolean;
12089
12098
  /**
@@ -12179,15 +12188,15 @@ declare type PrinterInfo = {
12179
12188
  declare type PrintOptions = {
12180
12189
  content?: 'self';
12181
12190
  /**
12182
- * @defaultValue false
12183
- *
12184
12191
  * Disables prompting the user for print settings.
12192
+ *
12193
+ * @default false
12185
12194
  */
12186
12195
  silent?: boolean;
12187
12196
  /**
12188
- * @defaultValue false
12189
- *
12190
12197
  * Includes the webpage background color and image when printing.
12198
+ *
12199
+ * @default false
12191
12200
  */
12192
12201
  printBackground?: boolean;
12193
12202
  /**
@@ -12195,9 +12204,9 @@ declare type PrintOptions = {
12195
12204
  */
12196
12205
  deviceName?: string;
12197
12206
  /**
12198
- * @defaultValue true
12199
- *
12200
12207
  * Prints in full color (greyscale otherwise).
12208
+ *
12209
+ * @default true
12201
12210
  */
12202
12211
  color?: boolean;
12203
12212
  /**
@@ -12205,9 +12214,9 @@ declare type PrintOptions = {
12205
12214
  */
12206
12215
  margins?: Margins;
12207
12216
  /**
12208
- * @defaultValue true
12209
- *
12210
12217
  * Prints in landscape mode (portrait otherwise).
12218
+ *
12219
+ * @default true
12211
12220
  */
12212
12221
  landscape?: boolean;
12213
12222
  /**
@@ -13378,15 +13387,15 @@ declare type ReplaceViewPayload = {
13378
13387
  */
13379
13388
  declare type ResizeRegion = {
13380
13389
  /**
13381
- * @defaultValue 7
13382
- *
13383
13390
  * The size of the resize region in pixels.
13391
+ *
13392
+ * @default 7
13384
13393
  */
13385
13394
  size?: number;
13386
13395
  /**
13387
- * @defaultValue 9
13388
- *
13389
13396
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13397
+ *
13398
+ * @default 9
13390
13399
  */
13391
13400
  bottomRightCorner?: number;
13392
13401
  /**
@@ -13394,27 +13403,27 @@ declare type ResizeRegion = {
13394
13403
  */
13395
13404
  sides?: {
13396
13405
  /**
13397
- * @defaultValue true
13398
- *
13399
13406
  * Enables resizing from the top of the window.
13407
+ *
13408
+ * @default true
13400
13409
  */
13401
13410
  top?: boolean;
13402
13411
  /**
13403
- * @defaultValue true
13404
- *
13405
13412
  * Enables resizing from the bottom of the window.
13413
+ *
13414
+ * @default true
13406
13415
  */
13407
13416
  bottom?: boolean;
13408
13417
  /**
13409
- * @defaultValue true
13410
- *
13411
13418
  * Enables resizing from the left side of the window.
13419
+ *
13420
+ * @default true
13412
13421
  */
13413
13422
  left?: boolean;
13414
13423
  /**
13415
- * @defaultValue true
13416
- *
13417
13424
  * Enables resizing from the right side of the window.
13425
+ *
13426
+ * @default true
13418
13427
  */
13419
13428
  right?: boolean;
13420
13429
  };
@@ -13958,9 +13967,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13958
13967
  */
13959
13968
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13960
13969
  /**
13961
- * @defaultValue 0
13962
- *
13963
13970
  * Number of milliseconds to wait between view repaints.
13971
+ *
13972
+ * @default 0
13964
13973
  */
13965
13974
  paintIntervalMs?: number;
13966
13975
  };
@@ -16011,9 +16020,9 @@ declare type TransitionBase = {
16011
16020
  */
16012
16021
  duration: number;
16013
16022
  /**
16014
- * @defaultValue false
16015
- *
16016
16023
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16024
+ *
16025
+ * @default false
16017
16026
  */
16018
16027
  relative?: boolean;
16019
16028
  };
@@ -16029,9 +16038,9 @@ declare type TransitionOptions = {
16029
16038
  */
16030
16039
  interrupt: boolean;
16031
16040
  /**
16032
- * @defaultValue false
16033
- *
16034
16041
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16042
+ *
16043
+ * @default false
16035
16044
  */
16036
16045
  relative?: boolean;
16037
16046
  tween?: tween;
@@ -16990,9 +16999,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
16990
16999
  */
16991
17000
  declare type ViewVisibilityOption = {
16992
17001
  /**
16993
- * @defaultValue false
16994
- *
16995
17002
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17003
+ *
17004
+ * @default false
16996
17005
  */
16997
17006
  enabled?: boolean;
16998
17007
  };