@openfin/core 43.100.47 → 43.100.50

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.
@@ -139,13 +139,13 @@ declare type ApiSettings = {
139
139
  /**
140
140
  * Inject OpenFin API into cross-origin iframes
141
141
  *
142
- * @defaultValue false
142
+ * @default false
143
143
  */
144
144
  crossOriginInjection?: boolean;
145
145
  /**
146
146
  * Inject OpenFin API into same-origin iframes
147
147
  *
148
- * @defaultValue true
148
+ * @default true
149
149
  */
150
150
  sameOriginInjection?: boolean;
151
151
  /**
@@ -1184,19 +1184,19 @@ declare class ApplicationModule extends Base {
1184
1184
  */
1185
1185
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1186
1186
  /**
1187
- * @defaultValue false
1188
- *
1189
1187
  * Disables IAB secure logging for the app.
1188
+ *
1189
+ * @default false
1190
1190
  */
1191
1191
  disableIabSecureLogging: boolean;
1192
1192
  /**
1193
- * @defaultValue 'There was an error loading the application.'
1194
- *
1195
1193
  * An error message to display when the application (launched via manifest) fails to load.
1196
1194
  * A dialog box will be launched with the error message just before the runtime exits.
1197
1195
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1198
1196
  * will trigger this dialog.
1199
1197
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1198
+ *
1199
+ * @default 'There was an error loading the application.'
1200
1200
  */
1201
1201
  loadErrorMessage: string;
1202
1202
  /**
@@ -1215,28 +1215,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1215
1215
  */
1216
1216
  name: string;
1217
1217
  /**
1218
- * @defaultValue false
1219
- *
1220
1218
  * A flag to configure the application as non-persistent.
1221
1219
  * Runtime exits when there are no persistent apps running.
1220
+ *
1221
+ * @default false
1222
1222
  */
1223
1223
  nonPersistent: boolean;
1224
1224
  /**
1225
- * @defaultValue false
1226
- *
1227
1225
  * Enable Flash at the application level.
1226
+ *
1227
+ * @default false
1228
1228
  */
1229
1229
  plugins: boolean;
1230
1230
  /**
1231
- * @defaultValue false
1232
- *
1233
1231
  * Enable spell check at the application level.
1232
+ *
1233
+ * @default false
1234
1234
  */
1235
1235
  spellCheck: boolean;
1236
1236
  /**
1237
- * @defaultValue 'about:blank'
1238
- *
1239
1237
  * The url to the application (specifically the application's main window).
1238
+ *
1239
+ * @default 'about:blank'
1240
1240
  */
1241
1241
  url: string;
1242
1242
  /**
@@ -1245,9 +1245,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1245
1245
  */
1246
1246
  uuid: string;
1247
1247
  /**
1248
- * @defaultValue true
1249
- *
1250
1248
  * When set to `false` it will disable the same-origin policy for the app.
1249
+ *
1250
+ * @default true
1251
1251
  */
1252
1252
  webSecurity: boolean;
1253
1253
  /**
@@ -1257,10 +1257,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1257
1257
  commands: ShortcutOverride[];
1258
1258
  isPlatformController: boolean;
1259
1259
  /**
1260
- * @defaultValue 1000
1261
- *
1262
1260
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1263
1261
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1262
+ *
1263
+ * @default 1000
1264
1264
  */
1265
1265
  maxViewPoolSize: number;
1266
1266
  /**
@@ -1276,12 +1276,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1276
1276
  */
1277
1277
  snapshot: Snapshot;
1278
1278
  /**
1279
- * @defaultValue false
1280
- *
1281
1279
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1282
1280
  *
1283
1281
  * Note: if the Platform Provider is showing, it won't close automatically.
1284
1282
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1283
+ *
1284
+ * @default false
1285
1285
  */
1286
1286
  preventQuitOnLastWindowClosed: boolean;
1287
1287
  /**
@@ -1289,9 +1289,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1289
1289
  */
1290
1290
  interopBrokerConfiguration: InteropBrokerOptions;
1291
1291
  /**
1292
- * @defaultValue true
1293
- *
1294
1292
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1293
+ *
1294
+ * @default true
1295
1295
  */
1296
1296
  apiDiagnostics: boolean;
1297
1297
  /**
@@ -1307,16 +1307,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1307
1307
  */
1308
1308
  permissions?: Partial<Permissions_2>;
1309
1309
  /**
1310
- * @defaultValue false
1311
- *
1312
1310
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1313
1311
  * Only relevant in Windows.
1312
+ *
1313
+ * @default false
1314
1314
  */
1315
1315
  enableJumpList: boolean;
1316
1316
  /**
1317
- * @defaultValue false
1318
- *
1319
1317
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1318
+ *
1319
+ * @default false
1320
1320
  */
1321
1321
  enableBeforeUnload: boolean;
1322
1322
  /**
@@ -1397,25 +1397,25 @@ declare type ApplicationWindowInfo = {
1397
1397
  */
1398
1398
  declare type ApplySnapshotOptions = {
1399
1399
  /**
1400
- * @defaultValue false
1401
- *
1402
1400
  * When true, applySnapshot will close existing windows,
1403
1401
  * replacing current Platform state with the given snapshot.
1402
+ *
1403
+ * @default false
1404
1404
  */
1405
1405
  closeExistingWindows?: boolean;
1406
1406
  /**
1407
- * @defaultValue false
1408
- *
1409
1407
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1410
1408
  * replacing current Platform state with the given snapshot.
1409
+ *
1410
+ * @default false
1411
1411
  */
1412
1412
  closeSnapshotWindows?: boolean;
1413
1413
  /**
1414
- * @defaultValue false
1415
- *
1416
1414
  * When true, applySnapshot will not check whether any windows in a
1417
1415
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1418
1416
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1417
+ *
1418
+ * @default false
1419
1419
  */
1420
1420
  skipOutOfBoundsCheck?: boolean;
1421
1421
  };
@@ -2072,15 +2072,15 @@ declare type CapturePageOptions = {
2072
2072
  */
2073
2073
  area?: Rectangle;
2074
2074
  /**
2075
- * @defaultValue 'png'
2076
- *
2077
2075
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2076
+ *
2077
+ * @default 'png'
2078
2078
  */
2079
2079
  format?: 'bmp' | 'jpg' | 'png';
2080
2080
  /**
2081
- * @defaultValue 100
2082
- *
2083
2081
  * Quality of JPEG image. Between 0 - 100.
2082
+ *
2083
+ * @default 100
2084
2084
  */
2085
2085
  quality?: number;
2086
2086
  };
@@ -2713,9 +2713,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2713
2713
  */
2714
2714
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2715
2715
  /**
2716
- * @defaultValue true
2717
- *
2718
2716
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2717
+ *
2718
+ * @default true
2719
2719
  */
2720
2720
  wait?: boolean;
2721
2721
  /**
@@ -3374,9 +3374,9 @@ declare interface CloseWindowPayload {
3374
3374
  windowId: Identity_4;
3375
3375
  options: {
3376
3376
  /**
3377
- * @defaultValue false
3378
- *
3379
3377
  * When set to true skips any before handler set on views that are part of the window
3378
+ *
3379
+ * @default false
3380
3380
  */
3381
3381
  skipBeforeUnload?: boolean;
3382
3382
  };
@@ -3481,9 +3481,9 @@ declare type ConstViewOptions = {
3481
3481
  */
3482
3482
  name: string;
3483
3483
  /**
3484
- * @defaultValue "about:blank"
3485
- *
3486
3484
  * The URL of the window
3485
+ *
3486
+ * @default "about:blank"
3487
3487
  */
3488
3488
  url: string;
3489
3489
  /**
@@ -3508,6 +3508,15 @@ declare type ConstViewOptions = {
3508
3508
  * Custom headers for requests sent by the view.
3509
3509
  */
3510
3510
  customRequestHeaders: CustomRequestHeaders[];
3511
+ /**
3512
+ * @experimental
3513
+ *
3514
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
3515
+ * These css properties are used to enable dragging of a frameless window.
3516
+ *
3517
+ * @default false
3518
+ */
3519
+ disableAppRegion: boolean;
3511
3520
  /**
3512
3521
  * Initial bounds given relative to the window.
3513
3522
  */
@@ -3544,9 +3553,9 @@ declare type ConstViewOptions = {
3544
3553
  experimental: any;
3545
3554
  fdc3InteropApi?: string;
3546
3555
  /**
3547
- * @defaultValue false
3548
- *
3549
3556
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3557
+ *
3558
+ * @default false
3550
3559
  */
3551
3560
  enableBeforeUnload: boolean;
3552
3561
  /**
@@ -3627,13 +3636,12 @@ declare type ConstWindowOptions = {
3627
3636
  */
3628
3637
  backgroundColor: string;
3629
3638
  /**
3630
- * @defaultValue false
3631
- *
3632
3639
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3633
3640
  * This also affects the Page Visibility API.
3634
3641
  *
3635
3642
  * When `true`, the page is throttled whether it is hidden or not.
3636
3643
  *
3644
+ * @default false
3637
3645
  */
3638
3646
  backgroundThrottling: boolean;
3639
3647
  /**
@@ -3657,21 +3665,30 @@ declare type ConstWindowOptions = {
3657
3665
  */
3658
3666
  customRequestHeaders: CustomRequestHeaders[];
3659
3667
  /**
3660
- * @defaultValue true
3661
- *
3662
3668
  * Setting this to false would keep the Window alive even if all its Views were closed.
3663
3669
  * This is meant for advanced users and should be used with caution.
3664
3670
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3665
3671
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3666
3672
  * **NOTE:** - This option is ignored in non-Platforms apps.
3673
+ *
3674
+ * @default true
3667
3675
  */
3668
3676
  closeOnLastViewRemoved: boolean;
3669
3677
  /**
3670
- * @defaultValue 'all'
3678
+ * @experimental
3679
+ *
3680
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
3681
+ * These css properties are used to enable dragging of a frameless window.
3671
3682
  *
3683
+ * @default false
3684
+ */
3685
+ disableAppRegion: boolean;
3686
+ /**
3672
3687
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3673
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3688
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3674
3689
  * **NOTE:** - This option is ignored in non-Platforms apps.
3690
+ *
3691
+ * @default 'all'
3675
3692
  */
3676
3693
  viewsPreventingClose: 'all' | 'layout';
3677
3694
  /**
@@ -3682,31 +3699,31 @@ declare type ConstWindowOptions = {
3682
3699
  */
3683
3700
  defaultCentered: boolean;
3684
3701
  /**
3685
- * @defaultValue 500
3686
- *
3687
3702
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3688
3703
  * in favor of the cached value.
3704
+ *
3705
+ * @default 500
3689
3706
  */
3690
3707
  defaultHeight: number;
3691
3708
  /**
3692
- * @defaultValue 100
3693
- *
3694
3709
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3695
3710
  * launches in favor of the cached value.
3711
+ *
3712
+ * @default 100
3696
3713
  */
3697
3714
  defaultLeft: number;
3698
3715
  /**
3699
- * @defaultValue 100
3700
- *
3701
3716
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3702
3717
  * launches in favor of the cached value.
3718
+ *
3719
+ * @default 100
3703
3720
  */
3704
3721
  defaultTop: number;
3705
3722
  /**
3706
- * @defaultValue 800
3707
- *
3708
3723
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3709
3724
  * launches in favor of the cached value.
3725
+ *
3726
+ * @default 800
3710
3727
  */
3711
3728
  defaultWidth: number;
3712
3729
  /**
@@ -3752,19 +3769,19 @@ declare type ConstWindowOptions = {
3752
3769
  */
3753
3770
  processAffinity: string;
3754
3771
  /**
3755
- * @defaultValue false
3756
- *
3757
3772
  * Displays a shadow on frameless windows.
3758
3773
  * `shadow` and `cornerRounding` are mutually exclusive.
3759
3774
  * On Windows 7, Aero theme is required.
3775
+ *
3776
+ * @default false
3760
3777
  */
3761
3778
  shadow: boolean;
3762
3779
  /**
3763
- * @defaultValue true
3764
- *
3765
3780
  * Caches the location of the window.
3766
3781
  *
3767
3782
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3783
+ *
3784
+ * @default true
3768
3785
  */
3769
3786
  saveWindowState: boolean;
3770
3787
  /**
@@ -3773,22 +3790,22 @@ declare type ConstWindowOptions = {
3773
3790
  */
3774
3791
  ignoreSavedWindowState: boolean;
3775
3792
  /**
3776
- * @defaultValue false
3777
- *
3778
3793
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3779
3794
  *
3780
3795
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3781
3796
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3797
+ *
3798
+ * @default false
3782
3799
  */
3783
3800
  smallWindow: boolean;
3784
3801
  /**
3785
- * @defaultValue "normal"
3786
- *
3787
3802
  * The visible state of the window on creation.
3788
3803
  * One of:
3789
3804
  * * `"maximized"`
3790
3805
  * * `"minimized"`
3791
3806
  * * `"normal"`
3807
+ *
3808
+ * @default "normal"
3792
3809
  */
3793
3810
  state: WindowState;
3794
3811
  /**
@@ -3803,26 +3820,26 @@ declare type ConstWindowOptions = {
3803
3820
  */
3804
3821
  taskbarIconGroup: string;
3805
3822
  /**
3806
- * @defaultValue "about:blank"
3807
- *
3808
3823
  * The URL of the window
3824
+ *
3825
+ * @default "about:blank"
3809
3826
  */
3810
3827
  url: string;
3811
3828
  /**
3812
- * @defaultValue <application UUID>
3813
- *
3814
3829
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3815
3830
  * If omitted, defaults to the `uuid` of the application spawning the window.
3816
3831
  * If given, must match the `uuid` of the application spawning the window.
3817
3832
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3818
3833
  * really no need to provide it.
3834
+ *
3835
+ * @default <application UUID>
3819
3836
  */
3820
3837
  uuid: string;
3821
3838
  /**
3822
- * @defaultValue false
3823
- *
3824
3839
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3825
3840
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3841
+ *
3842
+ * @default false
3826
3843
  */
3827
3844
  waitForPageLoad: boolean;
3828
3845
  width: number;
@@ -4104,13 +4121,13 @@ declare type CopyBlockedEventReason = 'disabled';
4104
4121
  */
4105
4122
  declare type CopyPermissions = {
4106
4123
  /**
4107
- * @defaultValue 'allowed'
4108
- *
4109
4124
  * Controls the behavior for copy operations for a matched URL.
4110
4125
  *
4111
4126
  * allow: Enables all copy operations.
4112
4127
  * block: Disables all copy operations.
4113
4128
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4129
+ *
4130
+ * @default 'allowed'
4114
4131
  */
4115
4132
  behavior: 'allow' | 'block' | 'protect';
4116
4133
  /**
@@ -4118,9 +4135,9 @@ declare type CopyPermissions = {
4118
4135
  */
4119
4136
  options?: {
4120
4137
  /**
4121
- * @defaultValue ''
4122
- *
4123
4138
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4139
+ *
4140
+ * @default ''
4124
4141
  */
4125
4142
  replacementText: string;
4126
4143
  };
@@ -4134,15 +4151,15 @@ declare type CopyPermissions = {
4134
4151
  */
4135
4152
  declare type CornerRounding = {
4136
4153
  /**
4137
- * @defaultValue 0
4138
- *
4139
4154
  * The height in pixels.
4155
+ *
4156
+ * @default 0
4140
4157
  */
4141
4158
  height: number;
4142
4159
  /**
4143
- * @defaultValue 0
4144
- *
4145
4160
  * The width in pixels.
4161
+ *
4162
+ * @default 0
4146
4163
  */
4147
4164
  width: number;
4148
4165
  };
@@ -4232,8 +4249,6 @@ declare type CreateLayoutOptions = {
4232
4249
  layoutName: string;
4233
4250
  layout: LayoutOptions;
4234
4251
  /**
4235
- * @defaultValue 'default'
4236
- *
4237
4252
  * Controls the View behavior for the given `layout` property. Note
4238
4253
  * that the selected behavior only applies to unnamed Views or
4239
4254
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4255,6 +4270,8 @@ declare type CreateLayoutOptions = {
4255
4270
  * override. Note that during applyLayoutSnapshot, Views are created and
4256
4271
  * attached to the Provider while the Window is being created, so it's
4257
4272
  * important to not 'duplicate' Views in this workflow.
4273
+ *
4274
+ * @default 'default'
4258
4275
  */
4259
4276
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4260
4277
  };
@@ -4513,7 +4530,7 @@ declare type DomainApiSettings = {
4513
4530
  * * 'none': The `fin` API will be not available.
4514
4531
  * * 'global': The entire `fin` API will be available.
4515
4532
  *
4516
- * @defaultValue 'global'
4533
+ * @default 'global'
4517
4534
  */
4518
4535
  fin?: InjectionType;
4519
4536
  /**
@@ -5098,9 +5115,9 @@ declare type EventType_9 = Event_12['type'];
5098
5115
  */
5099
5116
  declare type ExcludeOptions = {
5100
5117
  /**
5101
- * @defaultValue false
5102
- *
5103
5118
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5119
+ *
5120
+ * @default false
5104
5121
  */
5105
5122
  preloadScripts: boolean;
5106
5123
  };
@@ -5588,34 +5605,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5588
5605
  */
5589
5606
  declare type FindInPageOptions = {
5590
5607
  /**
5591
- * @defaultValue true
5592
- *
5593
5608
  * Searches in the forward direction (backward otherwise)
5609
+ *
5610
+ * @default true
5594
5611
  */
5595
5612
  forward?: boolean;
5596
5613
  /**
5597
- * @defaultValue false
5598
- *
5599
5614
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5615
+ *
5616
+ * @default false
5600
5617
  */
5601
5618
  findNext?: boolean;
5602
5619
  /**
5603
- * @defaultValue false
5604
- *
5605
5620
  * Enables case-sensitive searching.
5621
+ *
5622
+ * @default false
5606
5623
  */
5607
5624
  matchCase?: boolean;
5608
5625
  /**
5609
- * @defaultValue false
5610
- *
5611
5626
  * Only searches from the start of words.
5627
+ *
5628
+ * @default false
5612
5629
  */
5613
5630
  wordStart?: boolean;
5614
5631
  /**
5615
- * @defaultValue false
5616
- *
5617
5632
  * 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>
5618
5633
  * lowercase or non-letter. Accepts several other intra-word matches.
5634
+ *
5635
+ * @default false
5619
5636
  */
5620
5637
  medialCapitalAsWordStart?: boolean;
5621
5638
  };
@@ -6123,9 +6140,9 @@ declare type Hotkey = {
6123
6140
  */
6124
6141
  keys: string;
6125
6142
  /**
6126
- * @defaultValue false
6127
- *
6128
6143
  * Prevent default key handling before emitting the event.
6144
+ *
6145
+ * @default false
6129
6146
  */
6130
6147
  preventDefault?: boolean;
6131
6148
  };
@@ -8482,77 +8499,79 @@ declare type LayoutOptions = {
8482
8499
  */
8483
8500
  newTabButtonUrl?: string;
8484
8501
  /**
8485
- * @defaultValue false
8486
- *
8487
8502
  * When true the splitters will not be draggable and the layout will not resize.
8503
+ *
8504
+ * @default false
8488
8505
  */
8489
8506
  preventSplitterResize?: boolean;
8490
8507
  /**
8491
- * @defaultValue false
8492
- *
8493
8508
  * Whether the popout button will only act on the entire stack,
8494
8509
  * as opposed to only the active tab.
8510
+ *
8511
+ * @default false
8495
8512
  */
8496
8513
  popoutWholeStack?: boolean;
8497
8514
  /**
8498
- * @defaultValue false
8499
- *
8500
8515
  * Limits the area to which tabs can be dragged.
8501
8516
  * If true, the layout container is the only area where tabs can be dropped.
8517
+ *
8518
+ * @default false
8502
8519
  */
8503
8520
  constrainDragToContainer?: boolean;
8504
8521
  /**
8505
- * @defaultValue false
8506
- *
8507
8522
  * Whether to show the popout button on stack header.
8508
8523
  * The button will create a new window with current tab as its content.
8509
8524
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8525
+ *
8526
+ * @default false
8510
8527
  */
8511
8528
  showPopoutIcon?: boolean;
8512
8529
  /**
8513
- * @defaultValue false
8514
- *
8515
8530
  * Whether to show the maximize button on stack header.
8516
8531
  * The button will maximize the current tab to fill the entire window.
8532
+ *
8533
+ * @default false
8517
8534
  */
8518
8535
  showMaximiseIcon?: boolean;
8519
8536
  /**
8520
- * @defaultValue false
8521
- *
8522
8537
  * Whether to show the close button on stack header
8523
8538
  * (not to be confused with close button on every tab).
8539
+ *
8540
+ * @default false
8524
8541
  */
8525
8542
  showCloseIcon?: boolean;
8526
8543
  /**
8527
- * @defaultValue false
8528
- *
8529
8544
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8545
+ *
8546
+ * @default false
8530
8547
  */
8531
8548
  constrainDragToHeaders?: boolean;
8532
8549
  /**
8533
- * @defaultValue true
8534
- *
8535
8550
  * Turns tab headers on or off.
8536
8551
  * If false, the layout will be displayed with splitters only.
8552
+ *
8553
+ * @default true
8537
8554
  */
8538
8555
  hasHeaders?: boolean;
8539
8556
  /**
8540
- * @defaultValue true
8541
- *
8542
8557
  * If true, the user can re-arrange the layout by
8543
8558
  * dragging items by their tabs to the desired location.
8559
+ *
8560
+ * @default true
8544
8561
  */
8545
8562
  reorderEnabled?: boolean;
8546
8563
  /**
8547
- * @defaultValue false
8548
- *
8549
8564
  * If true, tabs can't be dragged out of the window.
8565
+ *
8566
+ * @default false
8550
8567
  */
8551
8568
  preventDragOut?: boolean;
8552
8569
  /**
8553
- * @defaultValue false
8570
+ * @defaultValue=false
8554
8571
  *
8555
8572
  * If true, tabs can't be dragged into the window.
8573
+ *
8574
+ * @default false
8556
8575
  */
8557
8576
  preventDragIn?: boolean;
8558
8577
  /* Excluded from this release type: disableTabOverflowDropdown */
@@ -9060,10 +9079,10 @@ declare type MutableViewOptions = {
9060
9079
  /**
9061
9080
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9062
9081
  *
9063
- * @defaultValue true
9064
- *
9065
9082
  * Show the context menu when right-clicking on the view.
9066
9083
  * Gives access to the devtools for the view.
9084
+ *
9085
+ * @default true
9067
9086
  */
9068
9087
  contextMenu: boolean;
9069
9088
  /**
@@ -9110,24 +9129,25 @@ declare type MutableViewOptions = {
9110
9129
  contentNavigation: ContentNavigation;
9111
9130
  contentRedirect: ContentRedirect;
9112
9131
  /**
9113
- * @defaultValue false
9114
9132
  * @deprecated
9115
9133
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9116
9134
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9135
+ *
9136
+ * @default false
9117
9137
  */
9118
9138
  detachOnClose: boolean;
9119
9139
  /**
9120
- * @defaultValue true
9121
- *
9122
9140
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9123
9141
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9124
9142
  * if the view isn't part of the new layout when running `Layout.replace`.
9143
+ *
9144
+ * @default true
9125
9145
  */
9126
9146
  isClosable: boolean;
9127
9147
  /**
9128
- * @defaultValue false
9129
- *
9130
9148
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9149
+ *
9150
+ * @default false
9131
9151
  */
9132
9152
  preventDragOut: boolean;
9133
9153
  interop?: InteropConfig;
@@ -9135,7 +9155,7 @@ declare type MutableViewOptions = {
9135
9155
  /**
9136
9156
  * {@inheritDoc ViewThrottling}
9137
9157
  *
9138
- * @defaultValue 'enabled'
9158
+ * @default 'enabled'
9139
9159
  */
9140
9160
  throttling: ViewThrottling;
9141
9161
  /**
@@ -9154,7 +9174,7 @@ declare type MutableWindowOptions = {
9154
9174
  * Turns anything of matching RGB value transparent.
9155
9175
  *
9156
9176
  * Caveats:
9157
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9177
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9158
9178
  * * User cannot click-through transparent regions
9159
9179
  * * Not supported on Mac
9160
9180
  * * Windows Aero must be enabled
@@ -9163,25 +9183,25 @@ declare type MutableWindowOptions = {
9163
9183
  */
9164
9184
  alphaMask: RGB;
9165
9185
  /**
9166
- * @defaultValue false
9167
- *
9168
9186
  * Always position the window at the top of the window stack.
9187
+ *
9188
+ * @default false
9169
9189
  */
9170
9190
  alwaysOnTop: boolean;
9171
9191
  /**
9172
- * @defaultValue 0
9173
- *
9174
9192
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9175
9193
  * an aspect ratio will not be enforced.
9194
+ *
9195
+ * @default 0
9176
9196
  */
9177
9197
  aspectRatio: number;
9178
9198
  /**
9179
9199
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9180
9200
  *
9181
- * @defaultValue true
9182
- *
9183
9201
  * Show the context menu when right-clicking on the window.
9184
9202
  * Gives access to the devtools for the window.
9203
+ *
9204
+ * @default true
9185
9205
  */
9186
9206
  contextMenu: boolean;
9187
9207
  /**
@@ -9248,16 +9268,17 @@ declare type MutableWindowOptions = {
9248
9268
  */
9249
9269
  customData: any;
9250
9270
  /**
9251
- * @defaultValue true
9252
9271
  * @deprecated Will be removed in runtime version 45
9253
9272
  *
9254
9273
  * Show the window's frame.
9274
+ *
9275
+ * @default true
9255
9276
  */
9256
9277
  frame: boolean;
9257
9278
  /**
9258
- * @defaultValue false
9259
- *
9260
9279
  * Hides the window instead of closing it when the close button is pressed.
9280
+ *
9281
+ * @default false
9261
9282
  */
9262
9283
  hideOnClose: boolean;
9263
9284
  /**
@@ -9310,60 +9331,61 @@ declare type MutableWindowOptions = {
9310
9331
  */
9311
9332
  icon: string;
9312
9333
  /**
9313
- * @defaultValue true
9314
- *
9315
9334
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9316
9335
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9336
+ *
9337
+ * @default true
9317
9338
  */
9318
9339
  includeInSnapshots: boolean;
9319
9340
  /**
9320
- * @defaultValue -1
9321
- *
9322
9341
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9342
+ *
9343
+ * @default -1
9323
9344
  */
9324
9345
  maxHeight: number;
9325
9346
  /**
9326
- * @defaultValue true
9327
- *
9328
9347
  * Allows the window to be maximized.
9348
+ *
9349
+ * @default true
9329
9350
  */
9330
9351
  maximizable: boolean;
9331
9352
  /**
9332
- * @defaultValue -1
9333
- *
9334
9353
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9354
+ *
9355
+ * @default -1
9335
9356
  */
9336
9357
  maxWidth: number;
9337
9358
  /**
9338
- * @defaultValue 0
9339
- *
9340
9359
  * The minimum height of the window.
9360
+ *
9361
+ * @default 0
9341
9362
  */
9342
9363
  minHeight: number;
9343
9364
  /**
9344
- * @defaultValue true
9345
- *
9346
9365
  * Allows the window to be minimized.
9366
+ *
9367
+ * @default true
9347
9368
  */
9348
9369
  minimizable: boolean;
9349
9370
  /**
9350
- * @defaultValue true
9351
- *
9352
9371
  * The minimum width of the window.
9372
+ *
9373
+ * @default true
9353
9374
  */
9354
9375
  minWidth: number;
9355
9376
  /**
9356
- * @defaultValue 1
9357
- *
9358
9377
  * A flag that specifies how transparent the window will be.
9359
9378
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9360
9379
  * This value is clamped between `0.0` and `1.0`.
9380
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9381
+ *
9382
+ * @default 1
9361
9383
  */
9362
9384
  opacity: number;
9363
9385
  /**
9364
- * @defaultValue true
9365
- *
9366
9386
  * A flag to allow the user to resize the window.
9387
+ *
9388
+ * @default true
9367
9389
  */
9368
9390
  resizable: boolean;
9369
9391
  /**
@@ -9371,16 +9393,16 @@ declare type MutableWindowOptions = {
9371
9393
  */
9372
9394
  resizeRegion: ResizeRegion;
9373
9395
  /**
9374
- * @defaultValue false
9375
- *
9376
9396
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9377
9397
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9398
+ *
9399
+ * @default false
9378
9400
  */
9379
9401
  showBackgroundImages: boolean;
9380
9402
  /**
9381
- * @defaultValue true
9382
- *
9383
9403
  * Shows the window's icon in the taskbar.
9404
+ *
9405
+ * @default true
9384
9406
  */
9385
9407
  showTaskbarIcon: boolean;
9386
9408
  /**
@@ -9399,7 +9421,7 @@ declare type MutableWindowOptions = {
9399
9421
  /**
9400
9422
  * {@inheritDoc WindowThrottling}
9401
9423
  *
9402
- * @defaultValue 'enabled'
9424
+ * @default 'enabled'
9403
9425
  *
9404
9426
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9405
9427
  */
@@ -10045,12 +10067,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10045
10067
  */
10046
10068
  declare type PastePermissions = {
10047
10069
  /**
10048
- * @defaultValue 'non-protected-content'
10049
- *
10050
10070
  * Controls the behavior for paste operations for a matched URL.
10051
10071
  *
10052
10072
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10053
10073
  * 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.
10074
+ *
10075
+ * @default 'non-protected-content'
10054
10076
  */
10055
10077
  behavior: 'non-protected-content' | 'all-content';
10056
10078
  };
@@ -11082,11 +11104,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11082
11104
  */
11083
11105
  providerUrl?: string;
11084
11106
  /**
11085
- * @defaultValue true
11086
- *
11087
11107
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11088
11108
  *
11089
11109
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11110
+ *
11111
+ * @default true
11090
11112
  */
11091
11113
  allowLaunchIntoPlatform?: boolean;
11092
11114
  };
@@ -11734,22 +11756,22 @@ declare type PopupOptions = {
11734
11756
  url?: string;
11735
11757
  /**
11736
11758
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11737
- * @defaultValue 300
11759
+ * @default 300
11738
11760
  */
11739
11761
  height?: number;
11740
11762
  /**
11741
11763
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11742
- * @defaultValue 300
11764
+ * @default 300
11743
11765
  */
11744
11766
  width?: number;
11745
11767
  /**
11746
11768
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11747
- * @defaultValue 0
11769
+ * @default 0
11748
11770
  */
11749
11771
  x?: number;
11750
11772
  /**
11751
11773
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11752
- * @defaultValue 0
11774
+ * @default 0
11753
11775
  */
11754
11776
  y?: number;
11755
11777
  /**
@@ -11757,7 +11779,7 @@ declare type PopupOptions = {
11757
11779
  * * 'modal' restricts resizing and positioning in the caller.
11758
11780
  * * 'hide' hides the popup window on blur.
11759
11781
  * * 'close' closes the popup window on blur.
11760
- * @defaultValue 'close'
11782
+ * @default 'close'
11761
11783
  */
11762
11784
  blurBehavior?: PopupBlurBehavior;
11763
11785
  /**
@@ -11765,19 +11787,19 @@ declare type PopupOptions = {
11765
11787
  * * 'none' will do nothing.
11766
11788
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11767
11789
  * * 'close' closes the popup window on `dispatchPopupResult`.
11768
- * @defaultValue 'close'
11790
+ * @default 'close'
11769
11791
  */
11770
11792
  resultDispatchBehavior?: PopupResultBehavior;
11771
11793
  /**
11772
11794
  * Hide the popup window instead of closing when `close` is called on it.
11773
11795
  *
11774
11796
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11775
- * @defaultValue false
11797
+ * @default false
11776
11798
  */
11777
11799
  hideOnClose?: boolean;
11778
11800
  /**
11779
11801
  * Determines if the popup window should or should not be focused when it is shown.
11780
- * @defaultValue true
11802
+ * @default true
11781
11803
  */
11782
11804
  focus?: boolean;
11783
11805
  /**
@@ -11871,9 +11893,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
11871
11893
  */
11872
11894
  declare type PreloadScript = {
11873
11895
  /**
11874
- * @defaultValue false
11875
- *
11876
11896
  * Fail to load the window if this preload script fails
11897
+ *
11898
+ * @default false
11877
11899
  */
11878
11900
  mandatory?: boolean;
11879
11901
  /**
@@ -11965,15 +11987,15 @@ declare type PrinterInfo = {
11965
11987
  declare type PrintOptions = {
11966
11988
  content?: 'self';
11967
11989
  /**
11968
- * @defaultValue false
11969
- *
11970
11990
  * Disables prompting the user for print settings.
11991
+ *
11992
+ * @default false
11971
11993
  */
11972
11994
  silent?: boolean;
11973
11995
  /**
11974
- * @defaultValue false
11975
- *
11976
11996
  * Includes the webpage background color and image when printing.
11997
+ *
11998
+ * @default false
11977
11999
  */
11978
12000
  printBackground?: boolean;
11979
12001
  /**
@@ -11981,9 +12003,9 @@ declare type PrintOptions = {
11981
12003
  */
11982
12004
  deviceName?: string;
11983
12005
  /**
11984
- * @defaultValue true
11985
- *
11986
12006
  * Prints in full color (greyscale otherwise).
12007
+ *
12008
+ * @default true
11987
12009
  */
11988
12010
  color?: boolean;
11989
12011
  /**
@@ -11991,9 +12013,9 @@ declare type PrintOptions = {
11991
12013
  */
11992
12014
  margins?: Margins;
11993
12015
  /**
11994
- * @defaultValue true
11995
- *
11996
12016
  * Prints in landscape mode (portrait otherwise).
12017
+ *
12018
+ * @default true
11997
12019
  */
11998
12020
  landscape?: boolean;
11999
12021
  /**
@@ -13369,15 +13391,15 @@ declare type ReplaceViewPayload = {
13369
13391
  */
13370
13392
  declare type ResizeRegion = {
13371
13393
  /**
13372
- * @defaultValue 7
13373
- *
13374
13394
  * The size of the resize region in pixels.
13395
+ *
13396
+ * @default 7
13375
13397
  */
13376
13398
  size?: number;
13377
13399
  /**
13378
- * @defaultValue 9
13379
- *
13380
13400
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13401
+ *
13402
+ * @default 9
13381
13403
  */
13382
13404
  bottomRightCorner?: number;
13383
13405
  /**
@@ -13385,27 +13407,27 @@ declare type ResizeRegion = {
13385
13407
  */
13386
13408
  sides?: {
13387
13409
  /**
13388
- * @defaultValue true
13389
- *
13390
13410
  * Enables resizing from the top of the window.
13411
+ *
13412
+ * @default true
13391
13413
  */
13392
13414
  top?: boolean;
13393
13415
  /**
13394
- * @defaultValue true
13395
- *
13396
13416
  * Enables resizing from the bottom of the window.
13417
+ *
13418
+ * @default true
13397
13419
  */
13398
13420
  bottom?: boolean;
13399
13421
  /**
13400
- * @defaultValue true
13401
- *
13402
13422
  * Enables resizing from the left side of the window.
13423
+ *
13424
+ * @default true
13403
13425
  */
13404
13426
  left?: boolean;
13405
13427
  /**
13406
- * @defaultValue true
13407
- *
13408
13428
  * Enables resizing from the right side of the window.
13429
+ *
13430
+ * @default true
13409
13431
  */
13410
13432
  right?: boolean;
13411
13433
  };
@@ -13959,9 +13981,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13959
13981
  */
13960
13982
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13961
13983
  /**
13962
- * @defaultValue 0
13963
- *
13964
13984
  * Number of milliseconds to wait between view repaints.
13985
+ *
13986
+ * @default 0
13965
13987
  */
13966
13988
  paintIntervalMs?: number;
13967
13989
  };
@@ -16013,9 +16035,9 @@ declare type TransitionBase = {
16013
16035
  */
16014
16036
  duration: number;
16015
16037
  /**
16016
- * @defaultValue false
16017
- *
16018
16038
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16039
+ *
16040
+ * @default false
16019
16041
  */
16020
16042
  relative?: boolean;
16021
16043
  };
@@ -16031,9 +16053,9 @@ declare type TransitionOptions = {
16031
16053
  */
16032
16054
  interrupt: boolean;
16033
16055
  /**
16034
- * @defaultValue false
16035
- *
16036
16056
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16057
+ *
16058
+ * @default false
16037
16059
  */
16038
16060
  relative?: boolean;
16039
16061
  tween?: tween;
@@ -16961,9 +16983,9 @@ declare type ViewTitlePriority = 'document' | 'options';
16961
16983
  */
16962
16984
  declare type ViewVisibilityOption = {
16963
16985
  /**
16964
- * @defaultValue false
16965
- *
16966
16986
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
16987
+ *
16988
+ * @default false
16967
16989
  */
16968
16990
  enabled?: boolean;
16969
16991
  };