@openfin/core 41.102.5 → 41.102.7

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.
@@ -133,13 +133,13 @@ declare type ApiSettings = {
133
133
  /**
134
134
  * Inject OpenFin API into cross-origin iframes
135
135
  *
136
- * @defaultValue false
136
+ * @default false
137
137
  */
138
138
  crossOriginInjection?: boolean;
139
139
  /**
140
140
  * Inject OpenFin API into same-origin iframes
141
141
  *
142
- * @defaultValue true
142
+ * @default true
143
143
  */
144
144
  sameOriginInjection?: boolean;
145
145
  /**
@@ -1178,19 +1178,19 @@ declare class ApplicationModule extends Base {
1178
1178
  */
1179
1179
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1180
1180
  /**
1181
- * @defaultValue false
1182
- *
1183
1181
  * Disables IAB secure logging for the app.
1182
+ *
1183
+ * @default false
1184
1184
  */
1185
1185
  disableIabSecureLogging: boolean;
1186
1186
  /**
1187
- * @defaultValue 'There was an error loading the application.'
1188
- *
1189
1187
  * An error message to display when the application (launched via manifest) fails to load.
1190
1188
  * A dialog box will be launched with the error message just before the runtime exits.
1191
1189
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1192
1190
  * will trigger this dialog.
1193
1191
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1192
+ *
1193
+ * @default 'There was an error loading the application.'
1194
1194
  */
1195
1195
  loadErrorMessage: string;
1196
1196
  /**
@@ -1209,28 +1209,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1209
1209
  */
1210
1210
  name: string;
1211
1211
  /**
1212
- * @defaultValue false
1213
- *
1214
1212
  * A flag to configure the application as non-persistent.
1215
1213
  * Runtime exits when there are no persistent apps running.
1214
+ *
1215
+ * @default false
1216
1216
  */
1217
1217
  nonPersistent: boolean;
1218
1218
  /**
1219
- * @defaultValue false
1220
- *
1221
1219
  * Enable Flash at the application level.
1220
+ *
1221
+ * @default false
1222
1222
  */
1223
1223
  plugins: boolean;
1224
1224
  /**
1225
- * @defaultValue false
1226
- *
1227
1225
  * Enable spell check at the application level.
1226
+ *
1227
+ * @default false
1228
1228
  */
1229
1229
  spellCheck: boolean;
1230
1230
  /**
1231
- * @defaultValue 'about:blank'
1232
- *
1233
1231
  * The url to the application (specifically the application's main window).
1232
+ *
1233
+ * @default 'about:blank'
1234
1234
  */
1235
1235
  url: string;
1236
1236
  /**
@@ -1239,9 +1239,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1239
1239
  */
1240
1240
  uuid: string;
1241
1241
  /**
1242
- * @defaultValue true
1243
- *
1244
1242
  * When set to `false` it will disable the same-origin policy for the app.
1243
+ *
1244
+ * @default true
1245
1245
  */
1246
1246
  webSecurity: boolean;
1247
1247
  /**
@@ -1251,10 +1251,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1251
1251
  commands: ShortcutOverride[];
1252
1252
  isPlatformController: boolean;
1253
1253
  /**
1254
- * @defaultValue 1000
1255
- *
1256
1254
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1257
1255
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1256
+ *
1257
+ * @default 1000
1258
1258
  */
1259
1259
  maxViewPoolSize: number;
1260
1260
  /**
@@ -1270,12 +1270,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1270
1270
  */
1271
1271
  snapshot: Snapshot;
1272
1272
  /**
1273
- * @defaultValue false
1274
- *
1275
1273
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1276
1274
  *
1277
1275
  * Note: if the Platform Provider is showing, it won't close automatically.
1278
1276
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1277
+ *
1278
+ * @default false
1279
1279
  */
1280
1280
  preventQuitOnLastWindowClosed: boolean;
1281
1281
  /**
@@ -1283,9 +1283,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1283
1283
  */
1284
1284
  interopBrokerConfiguration: InteropBrokerOptions;
1285
1285
  /**
1286
- * @defaultValue true
1287
- *
1288
1286
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1287
+ *
1288
+ * @default true
1289
1289
  */
1290
1290
  apiDiagnostics: boolean;
1291
1291
  /**
@@ -1301,16 +1301,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1301
1301
  */
1302
1302
  permissions?: Partial<Permissions_2>;
1303
1303
  /**
1304
- * @defaultValue false
1305
- *
1306
1304
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1307
1305
  * Only relevant in Windows.
1306
+ *
1307
+ * @default false
1308
1308
  */
1309
1309
  enableJumpList: boolean;
1310
1310
  /**
1311
- * @defaultValue false
1312
- *
1313
1311
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1312
+ *
1313
+ * @default false
1314
1314
  */
1315
1315
  enableBeforeUnload: boolean;
1316
1316
  /**
@@ -1391,25 +1391,25 @@ declare type ApplicationWindowInfo = {
1391
1391
  */
1392
1392
  declare type ApplySnapshotOptions = {
1393
1393
  /**
1394
- * @defaultValue false
1395
- *
1396
1394
  * When true, applySnapshot will close existing windows,
1397
1395
  * replacing current Platform state with the given snapshot.
1396
+ *
1397
+ * @default false
1398
1398
  */
1399
1399
  closeExistingWindows?: boolean;
1400
1400
  /**
1401
- * @defaultValue false
1402
- *
1403
1401
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1404
1402
  * replacing current Platform state with the given snapshot.
1403
+ *
1404
+ * @default false
1405
1405
  */
1406
1406
  closeSnapshotWindows?: boolean;
1407
1407
  /**
1408
- * @defaultValue false
1409
- *
1410
1408
  * When true, applySnapshot will not check whether any windows in a
1411
1409
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1412
1410
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1411
+ *
1412
+ * @default false
1413
1413
  */
1414
1414
  skipOutOfBoundsCheck?: boolean;
1415
1415
  };
@@ -2066,15 +2066,15 @@ declare type CapturePageOptions = {
2066
2066
  */
2067
2067
  area?: Rectangle;
2068
2068
  /**
2069
- * @defaultValue 'png'
2070
- *
2071
2069
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2070
+ *
2071
+ * @default 'png'
2072
2072
  */
2073
2073
  format?: 'bmp' | 'jpg' | 'png';
2074
2074
  /**
2075
- * @defaultValue 100
2076
- *
2077
2075
  * Quality of JPEG image. Between 0 - 100.
2076
+ *
2077
+ * @default 100
2078
2078
  */
2079
2079
  quality?: number;
2080
2080
  };
@@ -2707,9 +2707,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2707
2707
  */
2708
2708
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2709
2709
  /**
2710
- * @defaultValue true
2711
- *
2712
2710
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2711
+ *
2712
+ * @default true
2713
2713
  */
2714
2714
  wait?: boolean;
2715
2715
  /**
@@ -3003,6 +3003,10 @@ declare type ChromiumPolicies = {
3003
3003
  * Disable AutofillAddressEnabled policy for a Window or View.
3004
3004
  */
3005
3005
  AutofillAddressEnabled?: PolicyOptions;
3006
+ /**
3007
+ * Disable AutofillCreditCardEnabled policy for a Window or View.
3008
+ */
3009
+ AutofillCreditCardEnabled?: PolicyOptions;
3006
3010
  };
3007
3011
 
3008
3012
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3368,9 +3372,9 @@ declare interface CloseWindowPayload {
3368
3372
  windowId: Identity_4;
3369
3373
  options: {
3370
3374
  /**
3371
- * @defaultValue false
3372
- *
3373
3375
  * When set to true skips any before handler set on views that are part of the window
3376
+ *
3377
+ * @default false
3374
3378
  */
3375
3379
  skipBeforeUnload?: boolean;
3376
3380
  };
@@ -3475,9 +3479,9 @@ declare type ConstViewOptions = {
3475
3479
  */
3476
3480
  name: string;
3477
3481
  /**
3478
- * @defaultValue "about:blank"
3479
- *
3480
3482
  * The URL of the window
3483
+ *
3484
+ * @default "about:blank"
3481
3485
  */
3482
3486
  url: string;
3483
3487
  /**
@@ -3502,6 +3506,15 @@ declare type ConstViewOptions = {
3502
3506
  * Custom headers for requests sent by the view.
3503
3507
  */
3504
3508
  customRequestHeaders: CustomRequestHeaders[];
3509
+ /**
3510
+ * @experimental
3511
+ *
3512
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
3513
+ * These css properties are used to enable dragging of a frameless window.
3514
+ *
3515
+ * @default false
3516
+ */
3517
+ disableAppRegion: boolean;
3505
3518
  /**
3506
3519
  * Initial bounds given relative to the window.
3507
3520
  */
@@ -3538,9 +3551,9 @@ declare type ConstViewOptions = {
3538
3551
  experimental: any;
3539
3552
  fdc3InteropApi?: string;
3540
3553
  /**
3541
- * @defaultValue false
3542
- *
3543
3554
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3555
+ *
3556
+ * @default false
3544
3557
  */
3545
3558
  enableBeforeUnload: boolean;
3546
3559
  /**
@@ -3621,13 +3634,12 @@ declare type ConstWindowOptions = {
3621
3634
  */
3622
3635
  backgroundColor: string;
3623
3636
  /**
3624
- * @defaultValue false
3625
- *
3626
3637
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3627
3638
  * This also affects the Page Visibility API.
3628
3639
  *
3629
3640
  * When `true`, the page is throttled whether it is hidden or not.
3630
3641
  *
3642
+ * @default false
3631
3643
  */
3632
3644
  backgroundThrottling: boolean;
3633
3645
  /**
@@ -3651,21 +3663,30 @@ declare type ConstWindowOptions = {
3651
3663
  */
3652
3664
  customRequestHeaders: CustomRequestHeaders[];
3653
3665
  /**
3654
- * @defaultValue true
3655
- *
3656
3666
  * Setting this to false would keep the Window alive even if all its Views were closed.
3657
3667
  * This is meant for advanced users and should be used with caution.
3658
3668
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3659
3669
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3660
3670
  * **NOTE:** - This option is ignored in non-Platforms apps.
3671
+ *
3672
+ * @default true
3661
3673
  */
3662
3674
  closeOnLastViewRemoved: boolean;
3663
3675
  /**
3664
- * @defaultValue 'all'
3676
+ * @experimental
3665
3677
  *
3678
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
3679
+ * These css properties are used to enable dragging of a frameless window.
3680
+ *
3681
+ * @default false
3682
+ */
3683
+ disableAppRegion: boolean;
3684
+ /**
3666
3685
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3667
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3686
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3668
3687
  * **NOTE:** - This option is ignored in non-Platforms apps.
3688
+ *
3689
+ * @default 'all'
3669
3690
  */
3670
3691
  viewsPreventingClose: 'all' | 'layout';
3671
3692
  /**
@@ -3676,31 +3697,31 @@ declare type ConstWindowOptions = {
3676
3697
  */
3677
3698
  defaultCentered: boolean;
3678
3699
  /**
3679
- * @defaultValue 500
3680
- *
3681
3700
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3682
3701
  * in favor of the cached value.
3702
+ *
3703
+ * @default 500
3683
3704
  */
3684
3705
  defaultHeight: number;
3685
3706
  /**
3686
- * @defaultValue 100
3687
- *
3688
3707
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3689
3708
  * launches in favor of the cached value.
3709
+ *
3710
+ * @default 100
3690
3711
  */
3691
3712
  defaultLeft: number;
3692
3713
  /**
3693
- * @defaultValue 100
3694
- *
3695
3714
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3696
3715
  * launches in favor of the cached value.
3716
+ *
3717
+ * @default 100
3697
3718
  */
3698
3719
  defaultTop: number;
3699
3720
  /**
3700
- * @defaultValue 800
3701
- *
3702
3721
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3703
3722
  * launches in favor of the cached value.
3723
+ *
3724
+ * @default 800
3704
3725
  */
3705
3726
  defaultWidth: number;
3706
3727
  /**
@@ -3746,19 +3767,19 @@ declare type ConstWindowOptions = {
3746
3767
  */
3747
3768
  processAffinity: string;
3748
3769
  /**
3749
- * @defaultValue false
3750
- *
3751
3770
  * Displays a shadow on frameless windows.
3752
3771
  * `shadow` and `cornerRounding` are mutually exclusive.
3753
3772
  * On Windows 7, Aero theme is required.
3773
+ *
3774
+ * @default false
3754
3775
  */
3755
3776
  shadow: boolean;
3756
3777
  /**
3757
- * @defaultValue true
3758
- *
3759
3778
  * Caches the location of the window.
3760
3779
  *
3761
3780
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3781
+ *
3782
+ * @default true
3762
3783
  */
3763
3784
  saveWindowState: boolean;
3764
3785
  /**
@@ -3767,22 +3788,22 @@ declare type ConstWindowOptions = {
3767
3788
  */
3768
3789
  ignoreSavedWindowState: boolean;
3769
3790
  /**
3770
- * @defaultValue false
3771
- *
3772
3791
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3773
3792
  *
3774
3793
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3775
3794
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3795
+ *
3796
+ * @default false
3776
3797
  */
3777
3798
  smallWindow: boolean;
3778
3799
  /**
3779
- * @defaultValue "normal"
3780
- *
3781
3800
  * The visible state of the window on creation.
3782
3801
  * One of:
3783
3802
  * * `"maximized"`
3784
3803
  * * `"minimized"`
3785
3804
  * * `"normal"`
3805
+ *
3806
+ * @default "normal"
3786
3807
  */
3787
3808
  state: WindowState;
3788
3809
  /**
@@ -3797,26 +3818,26 @@ declare type ConstWindowOptions = {
3797
3818
  */
3798
3819
  taskbarIconGroup: string;
3799
3820
  /**
3800
- * @defaultValue "about:blank"
3801
- *
3802
3821
  * The URL of the window
3822
+ *
3823
+ * @default "about:blank"
3803
3824
  */
3804
3825
  url: string;
3805
3826
  /**
3806
- * @defaultValue <application UUID>
3807
- *
3808
3827
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3809
3828
  * If omitted, defaults to the `uuid` of the application spawning the window.
3810
3829
  * If given, must match the `uuid` of the application spawning the window.
3811
3830
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3812
3831
  * really no need to provide it.
3832
+ *
3833
+ * @default <application UUID>
3813
3834
  */
3814
3835
  uuid: string;
3815
3836
  /**
3816
- * @defaultValue false
3817
- *
3818
3837
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3819
3838
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3839
+ *
3840
+ * @default false
3820
3841
  */
3821
3842
  waitForPageLoad: boolean;
3822
3843
  width: number;
@@ -3836,6 +3857,10 @@ declare type ConstWindowOptions = {
3836
3857
  * Control which options to ignore when creating a Platform Window.
3837
3858
  */
3838
3859
  excludeOptions: ExcludeOptions;
3860
+ /**
3861
+ * Controls whether frameless window should have rounded corners. Default is false for Windows and true for MacOS. Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.
3862
+ */
3863
+ roundedCorners: boolean;
3839
3864
  };
3840
3865
 
3841
3866
  /**
@@ -4098,13 +4123,13 @@ declare type CopyBlockedEventReason = 'disabled';
4098
4123
  */
4099
4124
  declare type CopyPermissions = {
4100
4125
  /**
4101
- * @defaultValue 'allowed'
4102
- *
4103
4126
  * Controls the behavior for copy operations for a matched URL.
4104
4127
  *
4105
4128
  * allow: Enables all copy operations.
4106
4129
  * block: Disables all copy operations.
4107
4130
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4131
+ *
4132
+ * @default 'allowed'
4108
4133
  */
4109
4134
  behavior: 'allow' | 'block' | 'protect';
4110
4135
  /**
@@ -4112,9 +4137,9 @@ declare type CopyPermissions = {
4112
4137
  */
4113
4138
  options?: {
4114
4139
  /**
4115
- * @defaultValue ''
4116
- *
4117
4140
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4141
+ *
4142
+ * @default ''
4118
4143
  */
4119
4144
  replacementText: string;
4120
4145
  };
@@ -4128,15 +4153,15 @@ declare type CopyPermissions = {
4128
4153
  */
4129
4154
  declare type CornerRounding = {
4130
4155
  /**
4131
- * @defaultValue 0
4132
- *
4133
4156
  * The height in pixels.
4157
+ *
4158
+ * @default 0
4134
4159
  */
4135
4160
  height: number;
4136
4161
  /**
4137
- * @defaultValue 0
4138
- *
4139
4162
  * The width in pixels.
4163
+ *
4164
+ * @default 0
4140
4165
  */
4141
4166
  width: number;
4142
4167
  };
@@ -4226,8 +4251,6 @@ declare type CreateLayoutOptions = {
4226
4251
  layoutName: string;
4227
4252
  layout: LayoutOptions;
4228
4253
  /**
4229
- * @defaultValue 'default'
4230
- *
4231
4254
  * Controls the View behavior for the given `layout` property. Note
4232
4255
  * that the selected behavior only applies to unnamed Views or
4233
4256
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4249,6 +4272,8 @@ declare type CreateLayoutOptions = {
4249
4272
  * override. Note that during applyLayoutSnapshot, Views are created and
4250
4273
  * attached to the Provider while the Window is being created, so it's
4251
4274
  * important to not 'duplicate' Views in this workflow.
4275
+ *
4276
+ * @default 'default'
4252
4277
  */
4253
4278
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4254
4279
  };
@@ -4507,7 +4532,7 @@ declare type DomainApiSettings = {
4507
4532
  * * 'none': The `fin` API will be not available.
4508
4533
  * * 'global': The entire `fin` API will be available.
4509
4534
  *
4510
- * @defaultValue 'global'
4535
+ * @default 'global'
4511
4536
  */
4512
4537
  fin?: InjectionType;
4513
4538
  /**
@@ -5092,9 +5117,9 @@ declare type EventType_9 = Event_12['type'];
5092
5117
  */
5093
5118
  declare type ExcludeOptions = {
5094
5119
  /**
5095
- * @defaultValue false
5096
- *
5097
5120
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5121
+ *
5122
+ * @default false
5098
5123
  */
5099
5124
  preloadScripts: boolean;
5100
5125
  };
@@ -5568,34 +5593,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5568
5593
  */
5569
5594
  declare type FindInPageOptions = {
5570
5595
  /**
5571
- * @defaultValue true
5572
- *
5573
5596
  * Searches in the forward direction (backward otherwise)
5597
+ *
5598
+ * @default true
5574
5599
  */
5575
5600
  forward?: boolean;
5576
5601
  /**
5577
- * @defaultValue false
5578
- *
5579
5602
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5603
+ *
5604
+ * @default false
5580
5605
  */
5581
5606
  findNext?: boolean;
5582
5607
  /**
5583
- * @defaultValue false
5584
- *
5585
5608
  * Enables case-sensitive searching.
5609
+ *
5610
+ * @default false
5586
5611
  */
5587
5612
  matchCase?: boolean;
5588
5613
  /**
5589
- * @defaultValue false
5590
- *
5591
5614
  * Only searches from the start of words.
5615
+ *
5616
+ * @default false
5592
5617
  */
5593
5618
  wordStart?: boolean;
5594
5619
  /**
5595
- * @defaultValue false
5596
- *
5597
5620
  * 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>
5598
5621
  * lowercase or non-letter. Accepts several other intra-word matches.
5622
+ *
5623
+ * @default false
5599
5624
  */
5600
5625
  medialCapitalAsWordStart?: boolean;
5601
5626
  };
@@ -6103,9 +6128,9 @@ declare type Hotkey = {
6103
6128
  */
6104
6129
  keys: string;
6105
6130
  /**
6106
- * @defaultValue false
6107
- *
6108
6131
  * Prevent default key handling before emitting the event.
6132
+ *
6133
+ * @default false
6109
6134
  */
6110
6135
  preventDefault?: boolean;
6111
6136
  };
@@ -8462,77 +8487,79 @@ declare type LayoutOptions = {
8462
8487
  */
8463
8488
  newTabButtonUrl?: string;
8464
8489
  /**
8465
- * @defaultValue false
8466
- *
8467
8490
  * When true the splitters will not be draggable and the layout will not resize.
8491
+ *
8492
+ * @default false
8468
8493
  */
8469
8494
  preventSplitterResize?: boolean;
8470
8495
  /**
8471
- * @defaultValue false
8472
- *
8473
8496
  * Whether the popout button will only act on the entire stack,
8474
8497
  * as opposed to only the active tab.
8498
+ *
8499
+ * @default false
8475
8500
  */
8476
8501
  popoutWholeStack?: boolean;
8477
8502
  /**
8478
- * @defaultValue false
8479
- *
8480
8503
  * Limits the area to which tabs can be dragged.
8481
8504
  * If true, the layout container is the only area where tabs can be dropped.
8505
+ *
8506
+ * @default false
8482
8507
  */
8483
8508
  constrainDragToContainer?: boolean;
8484
8509
  /**
8485
- * @defaultValue false
8486
- *
8487
8510
  * Whether to show the popout button on stack header.
8488
8511
  * The button will create a new window with current tab as its content.
8489
8512
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8513
+ *
8514
+ * @default false
8490
8515
  */
8491
8516
  showPopoutIcon?: boolean;
8492
8517
  /**
8493
- * @defaultValue false
8494
- *
8495
8518
  * Whether to show the maximize button on stack header.
8496
8519
  * The button will maximize the current tab to fill the entire window.
8520
+ *
8521
+ * @default false
8497
8522
  */
8498
8523
  showMaximiseIcon?: boolean;
8499
8524
  /**
8500
- * @defaultValue false
8501
- *
8502
8525
  * Whether to show the close button on stack header
8503
8526
  * (not to be confused with close button on every tab).
8527
+ *
8528
+ * @default false
8504
8529
  */
8505
8530
  showCloseIcon?: boolean;
8506
8531
  /**
8507
- * @defaultValue false
8508
- *
8509
8532
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8533
+ *
8534
+ * @default false
8510
8535
  */
8511
8536
  constrainDragToHeaders?: boolean;
8512
8537
  /**
8513
- * @defaultValue true
8514
- *
8515
8538
  * Turns tab headers on or off.
8516
8539
  * If false, the layout will be displayed with splitters only.
8540
+ *
8541
+ * @default true
8517
8542
  */
8518
8543
  hasHeaders?: boolean;
8519
8544
  /**
8520
- * @defaultValue true
8521
- *
8522
8545
  * If true, the user can re-arrange the layout by
8523
8546
  * dragging items by their tabs to the desired location.
8547
+ *
8548
+ * @default true
8524
8549
  */
8525
8550
  reorderEnabled?: boolean;
8526
8551
  /**
8527
- * @defaultValue false
8528
- *
8529
8552
  * If true, tabs can't be dragged out of the window.
8553
+ *
8554
+ * @default false
8530
8555
  */
8531
8556
  preventDragOut?: boolean;
8532
8557
  /**
8533
8558
  * @defaultValue=false
8534
8559
  *
8535
8560
  * If true, tabs can't be dragged into the window.
8561
+ *
8562
+ * @default false
8536
8563
  */
8537
8564
  preventDragIn?: boolean;
8538
8565
  };
@@ -8984,10 +9011,10 @@ declare type MutableViewOptions = {
8984
9011
  /**
8985
9012
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
8986
9013
  *
8987
- * @defaultValue true
8988
- *
8989
9014
  * Show the context menu when right-clicking on the view.
8990
9015
  * Gives access to the devtools for the view.
9016
+ *
9017
+ * @default true
8991
9018
  */
8992
9019
  contextMenu: boolean;
8993
9020
  /**
@@ -9034,24 +9061,25 @@ declare type MutableViewOptions = {
9034
9061
  contentNavigation: ContentNavigation;
9035
9062
  contentRedirect: ContentRedirect;
9036
9063
  /**
9037
- * @defaultValue false
9038
9064
  * @deprecated
9039
9065
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9040
9066
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9067
+ *
9068
+ * @default false
9041
9069
  */
9042
9070
  detachOnClose: boolean;
9043
9071
  /**
9044
- * @defaultValue true
9045
- *
9046
9072
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9047
9073
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9048
9074
  * if the view isn't part of the new layout when running `Layout.replace`.
9075
+ *
9076
+ * @default true
9049
9077
  */
9050
9078
  isClosable: boolean;
9051
9079
  /**
9052
- * @defaultValue false
9053
- *
9054
9080
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9081
+ *
9082
+ * @default false
9055
9083
  */
9056
9084
  preventDragOut: boolean;
9057
9085
  interop?: InteropConfig;
@@ -9059,7 +9087,7 @@ declare type MutableViewOptions = {
9059
9087
  /**
9060
9088
  * {@inheritDoc ViewThrottling}
9061
9089
  *
9062
- * @defaultValue 'enabled'
9090
+ * @default 'enabled'
9063
9091
  */
9064
9092
  throttling: ViewThrottling;
9065
9093
  /**
@@ -9078,7 +9106,7 @@ declare type MutableWindowOptions = {
9078
9106
  * Turns anything of matching RGB value transparent.
9079
9107
  *
9080
9108
  * Caveats:
9081
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9109
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9082
9110
  * * User cannot click-through transparent regions
9083
9111
  * * Not supported on Mac
9084
9112
  * * Windows Aero must be enabled
@@ -9087,25 +9115,25 @@ declare type MutableWindowOptions = {
9087
9115
  */
9088
9116
  alphaMask: RGB;
9089
9117
  /**
9090
- * @defaultValue false
9091
- *
9092
9118
  * Always position the window at the top of the window stack.
9119
+ *
9120
+ * @default false
9093
9121
  */
9094
9122
  alwaysOnTop: boolean;
9095
9123
  /**
9096
- * @defaultValue 0
9097
- *
9098
9124
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9099
9125
  * an aspect ratio will not be enforced.
9126
+ *
9127
+ * @default 0
9100
9128
  */
9101
9129
  aspectRatio: number;
9102
9130
  /**
9103
9131
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9104
9132
  *
9105
- * @defaultValue true
9106
- *
9107
9133
  * Show the context menu when right-clicking on the window.
9108
9134
  * Gives access to the devtools for the window.
9135
+ *
9136
+ * @default true
9109
9137
  */
9110
9138
  contextMenu: boolean;
9111
9139
  /**
@@ -9172,15 +9200,18 @@ declare type MutableWindowOptions = {
9172
9200
  */
9173
9201
  customData: any;
9174
9202
  /**
9203
+ * @deprecated Will be removed in runtime version 45
9175
9204
  * @defaultValue true
9176
9205
  *
9177
9206
  * Show the window's frame.
9207
+ *
9208
+ * @default true
9178
9209
  */
9179
9210
  frame: boolean;
9180
9211
  /**
9181
- * @defaultValue false
9182
- *
9183
9212
  * Hides the window instead of closing it when the close button is pressed.
9213
+ *
9214
+ * @default false
9184
9215
  */
9185
9216
  hideOnClose: boolean;
9186
9217
  /**
@@ -9233,60 +9264,61 @@ declare type MutableWindowOptions = {
9233
9264
  */
9234
9265
  icon: string;
9235
9266
  /**
9236
- * @defaultValue true
9237
- *
9238
9267
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9239
9268
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9269
+ *
9270
+ * @default true
9240
9271
  */
9241
9272
  includeInSnapshots: boolean;
9242
9273
  /**
9243
- * @defaultValue -1
9244
- *
9245
9274
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9275
+ *
9276
+ * @default -1
9246
9277
  */
9247
9278
  maxHeight: number;
9248
9279
  /**
9249
- * @defaultValue true
9250
- *
9251
9280
  * Allows the window to be maximized.
9281
+ *
9282
+ * @default true
9252
9283
  */
9253
9284
  maximizable: boolean;
9254
9285
  /**
9255
- * @defaultValue -1
9256
- *
9257
9286
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9287
+ *
9288
+ * @default -1
9258
9289
  */
9259
9290
  maxWidth: number;
9260
9291
  /**
9261
- * @defaultValue 0
9262
- *
9263
9292
  * The minimum height of the window.
9293
+ *
9294
+ * @default 0
9264
9295
  */
9265
9296
  minHeight: number;
9266
9297
  /**
9267
- * @defaultValue true
9268
- *
9269
9298
  * Allows the window to be minimized.
9299
+ *
9300
+ * @default true
9270
9301
  */
9271
9302
  minimizable: boolean;
9272
9303
  /**
9273
- * @defaultValue true
9274
- *
9275
9304
  * The minimum width of the window.
9305
+ *
9306
+ * @default true
9276
9307
  */
9277
9308
  minWidth: number;
9278
9309
  /**
9279
- * @defaultValue 1
9280
- *
9281
9310
  * A flag that specifies how transparent the window will be.
9282
9311
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9283
9312
  * This value is clamped between `0.0` and `1.0`.
9313
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9314
+ *
9315
+ * @default 1
9284
9316
  */
9285
9317
  opacity: number;
9286
9318
  /**
9287
- * @defaultValue true
9288
- *
9289
9319
  * A flag to allow the user to resize the window.
9320
+ *
9321
+ * @default true
9290
9322
  */
9291
9323
  resizable: boolean;
9292
9324
  /**
@@ -9294,16 +9326,22 @@ declare type MutableWindowOptions = {
9294
9326
  */
9295
9327
  resizeRegion: ResizeRegion;
9296
9328
  /**
9297
- * @defaultValue false
9298
- *
9299
9329
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9300
9330
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9331
+ *
9332
+ * @default false
9301
9333
  */
9302
9334
  showBackgroundImages: boolean;
9303
9335
  /**
9304
- * @defaultValue true
9305
- *
9306
9336
  * Shows the window's icon in the taskbar.
9337
+ *
9338
+ * @remarks
9339
+ * In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
9340
+ * In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
9341
+ * `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
9342
+ * {@link Window._Window.showPopupWindow}.
9343
+ *
9344
+ * @default true
9307
9345
  */
9308
9346
  showTaskbarIcon: boolean;
9309
9347
  /**
@@ -9322,7 +9360,7 @@ declare type MutableWindowOptions = {
9322
9360
  /**
9323
9361
  * {@inheritDoc WindowThrottling}
9324
9362
  *
9325
- * @defaultValue 'enabled'
9363
+ * @default 'enabled'
9326
9364
  *
9327
9365
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9328
9366
  */
@@ -9934,12 +9972,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
9934
9972
  */
9935
9973
  declare type PastePermissions = {
9936
9974
  /**
9937
- * @defaultValue 'non-protected-content'
9938
- *
9939
9975
  * Controls the behavior for paste operations for a matched URL.
9940
9976
  *
9941
9977
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
9942
9978
  * 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.
9979
+ *
9980
+ * @default 'non-protected-content'
9943
9981
  */
9944
9982
  behavior: 'non-protected-content' | 'all-content';
9945
9983
  };
@@ -10970,11 +11008,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
10970
11008
  */
10971
11009
  providerUrl?: string;
10972
11010
  /**
10973
- * @defaultValue true
10974
- *
10975
11011
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
10976
11012
  *
10977
11013
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11014
+ *
11015
+ * @default true
10978
11016
  */
10979
11017
  allowLaunchIntoPlatform?: boolean;
10980
11018
  };
@@ -11618,22 +11656,22 @@ declare type PopupOptions = {
11618
11656
  url?: string;
11619
11657
  /**
11620
11658
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11621
- * @defaultValue 300
11659
+ * @default 300
11622
11660
  */
11623
11661
  height?: number;
11624
11662
  /**
11625
11663
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11626
- * @defaultValue 300
11664
+ * @default 300
11627
11665
  */
11628
11666
  width?: number;
11629
11667
  /**
11630
11668
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11631
- * @defaultValue 0
11669
+ * @default 0
11632
11670
  */
11633
11671
  x?: number;
11634
11672
  /**
11635
11673
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11636
- * @defaultValue 0
11674
+ * @default 0
11637
11675
  */
11638
11676
  y?: number;
11639
11677
  /**
@@ -11641,7 +11679,7 @@ declare type PopupOptions = {
11641
11679
  * * 'modal' restricts resizing and positioning in the caller.
11642
11680
  * * 'hide' hides the popup window on blur.
11643
11681
  * * 'close' closes the popup window on blur.
11644
- * @defaultValue 'close'
11682
+ * @default 'close'
11645
11683
  */
11646
11684
  blurBehavior?: PopupBlurBehavior;
11647
11685
  /**
@@ -11649,19 +11687,19 @@ declare type PopupOptions = {
11649
11687
  * * 'none' will do nothing.
11650
11688
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11651
11689
  * * 'close' closes the popup window on `dispatchPopupResult`.
11652
- * @defaultValue 'close'
11690
+ * @default 'close'
11653
11691
  */
11654
11692
  resultDispatchBehavior?: PopupResultBehavior;
11655
11693
  /**
11656
11694
  * Hide the popup window instead of closing when `close` is called on it.
11657
11695
  *
11658
11696
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11659
- * @defaultValue false
11697
+ * @default false
11660
11698
  */
11661
11699
  hideOnClose?: boolean;
11662
11700
  /**
11663
11701
  * Determines if the popup window should or should not be focused when it is shown.
11664
- * @defaultValue true
11702
+ * @default true
11665
11703
  */
11666
11704
  focus?: boolean;
11667
11705
  /**
@@ -11755,9 +11793,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
11755
11793
  */
11756
11794
  declare type PreloadScript = {
11757
11795
  /**
11758
- * @defaultValue false
11759
- *
11760
11796
  * Fail to load the window if this preload script fails
11797
+ *
11798
+ * @default false
11761
11799
  */
11762
11800
  mandatory?: boolean;
11763
11801
  /**
@@ -11853,15 +11891,15 @@ declare type PrinterInfo = {
11853
11891
  declare type PrintOptions = {
11854
11892
  content?: 'self';
11855
11893
  /**
11856
- * @defaultValue false
11857
- *
11858
11894
  * Disables prompting the user for print settings.
11895
+ *
11896
+ * @default false
11859
11897
  */
11860
11898
  silent?: boolean;
11861
11899
  /**
11862
- * @defaultValue false
11863
- *
11864
11900
  * Includes the webpage background color and image when printing.
11901
+ *
11902
+ * @default false
11865
11903
  */
11866
11904
  printBackground?: boolean;
11867
11905
  /**
@@ -11869,9 +11907,9 @@ declare type PrintOptions = {
11869
11907
  */
11870
11908
  deviceName?: string;
11871
11909
  /**
11872
- * @defaultValue true
11873
- *
11874
11910
  * Prints in full color (greyscale otherwise).
11911
+ *
11912
+ * @default true
11875
11913
  */
11876
11914
  color?: boolean;
11877
11915
  /**
@@ -11879,9 +11917,9 @@ declare type PrintOptions = {
11879
11917
  */
11880
11918
  margins?: Margins;
11881
11919
  /**
11882
- * @defaultValue true
11883
- *
11884
11920
  * Prints in landscape mode (portrait otherwise).
11921
+ *
11922
+ * @default true
11885
11923
  */
11886
11924
  landscape?: boolean;
11887
11925
  /**
@@ -13062,15 +13100,15 @@ declare type ReplaceViewPayload = {
13062
13100
  */
13063
13101
  declare type ResizeRegion = {
13064
13102
  /**
13065
- * @defaultValue 7
13066
- *
13067
13103
  * The size of the resize region in pixels.
13104
+ *
13105
+ * @default 7
13068
13106
  */
13069
13107
  size?: number;
13070
13108
  /**
13071
- * @defaultValue 9
13072
- *
13073
13109
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13110
+ *
13111
+ * @default 9
13074
13112
  */
13075
13113
  bottomRightCorner?: number;
13076
13114
  /**
@@ -13078,27 +13116,27 @@ declare type ResizeRegion = {
13078
13116
  */
13079
13117
  sides?: {
13080
13118
  /**
13081
- * @defaultValue true
13082
- *
13083
13119
  * Enables resizing from the top of the window.
13120
+ *
13121
+ * @default true
13084
13122
  */
13085
13123
  top?: boolean;
13086
13124
  /**
13087
- * @defaultValue true
13088
- *
13089
13125
  * Enables resizing from the bottom of the window.
13126
+ *
13127
+ * @default true
13090
13128
  */
13091
13129
  bottom?: boolean;
13092
13130
  /**
13093
- * @defaultValue true
13094
- *
13095
13131
  * Enables resizing from the left side of the window.
13132
+ *
13133
+ * @default true
13096
13134
  */
13097
13135
  left?: boolean;
13098
13136
  /**
13099
- * @defaultValue true
13100
- *
13101
13137
  * Enables resizing from the right side of the window.
13138
+ *
13139
+ * @default true
13102
13140
  */
13103
13141
  right?: boolean;
13104
13142
  };
@@ -13650,9 +13688,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13650
13688
  */
13651
13689
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13652
13690
  /**
13653
- * @defaultValue 0
13654
- *
13655
13691
  * Number of milliseconds to wait between view repaints.
13692
+ *
13693
+ * @default 0
13656
13694
  */
13657
13695
  paintIntervalMs?: number;
13658
13696
  };
@@ -15696,9 +15734,9 @@ declare type TransitionBase = {
15696
15734
  */
15697
15735
  duration: number;
15698
15736
  /**
15699
- * @defaultValue false
15700
- *
15701
15737
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
15738
+ *
15739
+ * @default false
15702
15740
  */
15703
15741
  relative?: boolean;
15704
15742
  };
@@ -15714,9 +15752,9 @@ declare type TransitionOptions = {
15714
15752
  */
15715
15753
  interrupt: boolean;
15716
15754
  /**
15717
- * @defaultValue false
15718
- *
15719
15755
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
15756
+ *
15757
+ * @default false
15720
15758
  */
15721
15759
  relative?: boolean;
15722
15760
  tween?: tween;
@@ -16644,9 +16682,9 @@ declare type ViewTitlePriority = 'document' | 'options';
16644
16682
  */
16645
16683
  declare type ViewVisibilityOption = {
16646
16684
  /**
16647
- * @defaultValue false
16648
- *
16649
16685
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
16686
+ *
16687
+ * @default false
16650
16688
  */
16651
16689
  enabled?: boolean;
16652
16690
  };