@openfin/core 42.100.97 → 42.100.99

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
  /**
@@ -3009,6 +3009,10 @@ declare type ChromiumPolicies = {
3009
3009
  * Disable AutofillAddressEnabled policy for a Window or View.
3010
3010
  */
3011
3011
  AutofillAddressEnabled?: PolicyOptions;
3012
+ /**
3013
+ * Disable AutofillCreditCardEnabled policy for a Window or View.
3014
+ */
3015
+ AutofillCreditCardEnabled?: PolicyOptions;
3012
3016
  };
3013
3017
 
3014
3018
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3374,9 +3378,9 @@ declare interface CloseWindowPayload {
3374
3378
  windowId: Identity_4;
3375
3379
  options: {
3376
3380
  /**
3377
- * @defaultValue false
3378
- *
3379
3381
  * When set to true skips any before handler set on views that are part of the window
3382
+ *
3383
+ * @default false
3380
3384
  */
3381
3385
  skipBeforeUnload?: boolean;
3382
3386
  };
@@ -3481,9 +3485,9 @@ declare type ConstViewOptions = {
3481
3485
  */
3482
3486
  name: string;
3483
3487
  /**
3484
- * @defaultValue "about:blank"
3485
- *
3486
3488
  * The URL of the window
3489
+ *
3490
+ * @default "about:blank"
3487
3491
  */
3488
3492
  url: string;
3489
3493
  /**
@@ -3508,6 +3512,15 @@ declare type ConstViewOptions = {
3508
3512
  * Custom headers for requests sent by the view.
3509
3513
  */
3510
3514
  customRequestHeaders: CustomRequestHeaders[];
3515
+ /**
3516
+ * @experimental
3517
+ *
3518
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
3519
+ * These css properties are used to enable dragging of a frameless window.
3520
+ *
3521
+ * @default false
3522
+ */
3523
+ disableAppRegion: boolean;
3511
3524
  /**
3512
3525
  * Initial bounds given relative to the window.
3513
3526
  */
@@ -3544,9 +3557,9 @@ declare type ConstViewOptions = {
3544
3557
  experimental: any;
3545
3558
  fdc3InteropApi?: string;
3546
3559
  /**
3547
- * @defaultValue false
3548
- *
3549
3560
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3561
+ *
3562
+ * @default false
3550
3563
  */
3551
3564
  enableBeforeUnload: boolean;
3552
3565
  /**
@@ -3627,13 +3640,12 @@ declare type ConstWindowOptions = {
3627
3640
  */
3628
3641
  backgroundColor: string;
3629
3642
  /**
3630
- * @defaultValue false
3631
- *
3632
3643
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3633
3644
  * This also affects the Page Visibility API.
3634
3645
  *
3635
3646
  * When `true`, the page is throttled whether it is hidden or not.
3636
3647
  *
3648
+ * @default false
3637
3649
  */
3638
3650
  backgroundThrottling: boolean;
3639
3651
  /**
@@ -3657,21 +3669,30 @@ declare type ConstWindowOptions = {
3657
3669
  */
3658
3670
  customRequestHeaders: CustomRequestHeaders[];
3659
3671
  /**
3660
- * @defaultValue true
3661
- *
3662
3672
  * Setting this to false would keep the Window alive even if all its Views were closed.
3663
3673
  * This is meant for advanced users and should be used with caution.
3664
3674
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3665
3675
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3666
3676
  * **NOTE:** - This option is ignored in non-Platforms apps.
3677
+ *
3678
+ * @default true
3667
3679
  */
3668
3680
  closeOnLastViewRemoved: boolean;
3669
3681
  /**
3670
- * @defaultValue 'all'
3682
+ * @experimental
3671
3683
  *
3684
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
3685
+ * These css properties are used to enable dragging of a frameless window.
3686
+ *
3687
+ * @default false
3688
+ */
3689
+ disableAppRegion: boolean;
3690
+ /**
3672
3691
  * 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'.
3692
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3674
3693
  * **NOTE:** - This option is ignored in non-Platforms apps.
3694
+ *
3695
+ * @default 'all'
3675
3696
  */
3676
3697
  viewsPreventingClose: 'all' | 'layout';
3677
3698
  /**
@@ -3682,31 +3703,31 @@ declare type ConstWindowOptions = {
3682
3703
  */
3683
3704
  defaultCentered: boolean;
3684
3705
  /**
3685
- * @defaultValue 500
3686
- *
3687
3706
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3688
3707
  * in favor of the cached value.
3708
+ *
3709
+ * @default 500
3689
3710
  */
3690
3711
  defaultHeight: number;
3691
3712
  /**
3692
- * @defaultValue 100
3693
- *
3694
3713
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3695
3714
  * launches in favor of the cached value.
3715
+ *
3716
+ * @default 100
3696
3717
  */
3697
3718
  defaultLeft: number;
3698
3719
  /**
3699
- * @defaultValue 100
3700
- *
3701
3720
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3702
3721
  * launches in favor of the cached value.
3722
+ *
3723
+ * @default 100
3703
3724
  */
3704
3725
  defaultTop: number;
3705
3726
  /**
3706
- * @defaultValue 800
3707
- *
3708
3727
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3709
3728
  * launches in favor of the cached value.
3729
+ *
3730
+ * @default 800
3710
3731
  */
3711
3732
  defaultWidth: number;
3712
3733
  /**
@@ -3752,19 +3773,19 @@ declare type ConstWindowOptions = {
3752
3773
  */
3753
3774
  processAffinity: string;
3754
3775
  /**
3755
- * @defaultValue false
3756
- *
3757
3776
  * Displays a shadow on frameless windows.
3758
3777
  * `shadow` and `cornerRounding` are mutually exclusive.
3759
3778
  * On Windows 7, Aero theme is required.
3779
+ *
3780
+ * @default false
3760
3781
  */
3761
3782
  shadow: boolean;
3762
3783
  /**
3763
- * @defaultValue true
3764
- *
3765
3784
  * Caches the location of the window.
3766
3785
  *
3767
3786
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3787
+ *
3788
+ * @default true
3768
3789
  */
3769
3790
  saveWindowState: boolean;
3770
3791
  /**
@@ -3773,22 +3794,22 @@ declare type ConstWindowOptions = {
3773
3794
  */
3774
3795
  ignoreSavedWindowState: boolean;
3775
3796
  /**
3776
- * @defaultValue false
3777
- *
3778
3797
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3779
3798
  *
3780
3799
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3781
3800
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3801
+ *
3802
+ * @default false
3782
3803
  */
3783
3804
  smallWindow: boolean;
3784
3805
  /**
3785
- * @defaultValue "normal"
3786
- *
3787
3806
  * The visible state of the window on creation.
3788
3807
  * One of:
3789
3808
  * * `"maximized"`
3790
3809
  * * `"minimized"`
3791
3810
  * * `"normal"`
3811
+ *
3812
+ * @default "normal"
3792
3813
  */
3793
3814
  state: WindowState;
3794
3815
  /**
@@ -3803,26 +3824,26 @@ declare type ConstWindowOptions = {
3803
3824
  */
3804
3825
  taskbarIconGroup: string;
3805
3826
  /**
3806
- * @defaultValue "about:blank"
3807
- *
3808
3827
  * The URL of the window
3828
+ *
3829
+ * @default "about:blank"
3809
3830
  */
3810
3831
  url: string;
3811
3832
  /**
3812
- * @defaultValue <application UUID>
3813
- *
3814
3833
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3815
3834
  * If omitted, defaults to the `uuid` of the application spawning the window.
3816
3835
  * If given, must match the `uuid` of the application spawning the window.
3817
3836
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3818
3837
  * really no need to provide it.
3838
+ *
3839
+ * @default <application UUID>
3819
3840
  */
3820
3841
  uuid: string;
3821
3842
  /**
3822
- * @defaultValue false
3823
- *
3824
3843
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3825
3844
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3845
+ *
3846
+ * @default false
3826
3847
  */
3827
3848
  waitForPageLoad: boolean;
3828
3849
  width: number;
@@ -3842,6 +3863,10 @@ declare type ConstWindowOptions = {
3842
3863
  * Control which options to ignore when creating a Platform Window.
3843
3864
  */
3844
3865
  excludeOptions: ExcludeOptions;
3866
+ /**
3867
+ * 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.
3868
+ */
3869
+ roundedCorners: boolean;
3845
3870
  };
3846
3871
 
3847
3872
  /**
@@ -4104,13 +4129,13 @@ declare type CopyBlockedEventReason = 'disabled';
4104
4129
  */
4105
4130
  declare type CopyPermissions = {
4106
4131
  /**
4107
- * @defaultValue 'allowed'
4108
- *
4109
4132
  * Controls the behavior for copy operations for a matched URL.
4110
4133
  *
4111
4134
  * allow: Enables all copy operations.
4112
4135
  * block: Disables all copy operations.
4113
4136
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4137
+ *
4138
+ * @default 'allowed'
4114
4139
  */
4115
4140
  behavior: 'allow' | 'block' | 'protect';
4116
4141
  /**
@@ -4118,9 +4143,9 @@ declare type CopyPermissions = {
4118
4143
  */
4119
4144
  options?: {
4120
4145
  /**
4121
- * @defaultValue ''
4122
- *
4123
4146
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4147
+ *
4148
+ * @default ''
4124
4149
  */
4125
4150
  replacementText: string;
4126
4151
  };
@@ -4134,15 +4159,15 @@ declare type CopyPermissions = {
4134
4159
  */
4135
4160
  declare type CornerRounding = {
4136
4161
  /**
4137
- * @defaultValue 0
4138
- *
4139
4162
  * The height in pixels.
4163
+ *
4164
+ * @default 0
4140
4165
  */
4141
4166
  height: number;
4142
4167
  /**
4143
- * @defaultValue 0
4144
- *
4145
4168
  * The width in pixels.
4169
+ *
4170
+ * @default 0
4146
4171
  */
4147
4172
  width: number;
4148
4173
  };
@@ -4232,8 +4257,6 @@ declare type CreateLayoutOptions = {
4232
4257
  layoutName: string;
4233
4258
  layout: LayoutOptions;
4234
4259
  /**
4235
- * @defaultValue 'default'
4236
- *
4237
4260
  * Controls the View behavior for the given `layout` property. Note
4238
4261
  * that the selected behavior only applies to unnamed Views or
4239
4262
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4255,6 +4278,8 @@ declare type CreateLayoutOptions = {
4255
4278
  * override. Note that during applyLayoutSnapshot, Views are created and
4256
4279
  * attached to the Provider while the Window is being created, so it's
4257
4280
  * important to not 'duplicate' Views in this workflow.
4281
+ *
4282
+ * @default 'default'
4258
4283
  */
4259
4284
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4260
4285
  };
@@ -4513,7 +4538,7 @@ declare type DomainApiSettings = {
4513
4538
  * * 'none': The `fin` API will be not available.
4514
4539
  * * 'global': The entire `fin` API will be available.
4515
4540
  *
4516
- * @defaultValue 'global'
4541
+ * @default 'global'
4517
4542
  */
4518
4543
  fin?: InjectionType;
4519
4544
  /**
@@ -5098,9 +5123,9 @@ declare type EventType_9 = Event_12['type'];
5098
5123
  */
5099
5124
  declare type ExcludeOptions = {
5100
5125
  /**
5101
- * @defaultValue false
5102
- *
5103
5126
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5127
+ *
5128
+ * @default false
5104
5129
  */
5105
5130
  preloadScripts: boolean;
5106
5131
  };
@@ -5588,34 +5613,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5588
5613
  */
5589
5614
  declare type FindInPageOptions = {
5590
5615
  /**
5591
- * @defaultValue true
5592
- *
5593
5616
  * Searches in the forward direction (backward otherwise)
5617
+ *
5618
+ * @default true
5594
5619
  */
5595
5620
  forward?: boolean;
5596
5621
  /**
5597
- * @defaultValue false
5598
- *
5599
5622
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5623
+ *
5624
+ * @default false
5600
5625
  */
5601
5626
  findNext?: boolean;
5602
5627
  /**
5603
- * @defaultValue false
5604
- *
5605
5628
  * Enables case-sensitive searching.
5629
+ *
5630
+ * @default false
5606
5631
  */
5607
5632
  matchCase?: boolean;
5608
5633
  /**
5609
- * @defaultValue false
5610
- *
5611
5634
  * Only searches from the start of words.
5635
+ *
5636
+ * @default false
5612
5637
  */
5613
5638
  wordStart?: boolean;
5614
5639
  /**
5615
- * @defaultValue false
5616
- *
5617
5640
  * 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
5641
  * lowercase or non-letter. Accepts several other intra-word matches.
5642
+ *
5643
+ * @default false
5619
5644
  */
5620
5645
  medialCapitalAsWordStart?: boolean;
5621
5646
  };
@@ -6123,9 +6148,9 @@ declare type Hotkey = {
6123
6148
  */
6124
6149
  keys: string;
6125
6150
  /**
6126
- * @defaultValue false
6127
- *
6128
6151
  * Prevent default key handling before emitting the event.
6152
+ *
6153
+ * @default false
6129
6154
  */
6130
6155
  preventDefault?: boolean;
6131
6156
  };
@@ -8482,77 +8507,79 @@ declare type LayoutOptions = {
8482
8507
  */
8483
8508
  newTabButtonUrl?: string;
8484
8509
  /**
8485
- * @defaultValue false
8486
- *
8487
8510
  * When true the splitters will not be draggable and the layout will not resize.
8511
+ *
8512
+ * @default false
8488
8513
  */
8489
8514
  preventSplitterResize?: boolean;
8490
8515
  /**
8491
- * @defaultValue false
8492
- *
8493
8516
  * Whether the popout button will only act on the entire stack,
8494
8517
  * as opposed to only the active tab.
8518
+ *
8519
+ * @default false
8495
8520
  */
8496
8521
  popoutWholeStack?: boolean;
8497
8522
  /**
8498
- * @defaultValue false
8499
- *
8500
8523
  * Limits the area to which tabs can be dragged.
8501
8524
  * If true, the layout container is the only area where tabs can be dropped.
8525
+ *
8526
+ * @default false
8502
8527
  */
8503
8528
  constrainDragToContainer?: boolean;
8504
8529
  /**
8505
- * @defaultValue false
8506
- *
8507
8530
  * Whether to show the popout button on stack header.
8508
8531
  * The button will create a new window with current tab as its content.
8509
8532
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8533
+ *
8534
+ * @default false
8510
8535
  */
8511
8536
  showPopoutIcon?: boolean;
8512
8537
  /**
8513
- * @defaultValue false
8514
- *
8515
8538
  * Whether to show the maximize button on stack header.
8516
8539
  * The button will maximize the current tab to fill the entire window.
8540
+ *
8541
+ * @default false
8517
8542
  */
8518
8543
  showMaximiseIcon?: boolean;
8519
8544
  /**
8520
- * @defaultValue false
8521
- *
8522
8545
  * Whether to show the close button on stack header
8523
8546
  * (not to be confused with close button on every tab).
8547
+ *
8548
+ * @default false
8524
8549
  */
8525
8550
  showCloseIcon?: boolean;
8526
8551
  /**
8527
- * @defaultValue false
8528
- *
8529
8552
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8553
+ *
8554
+ * @default false
8530
8555
  */
8531
8556
  constrainDragToHeaders?: boolean;
8532
8557
  /**
8533
- * @defaultValue true
8534
- *
8535
8558
  * Turns tab headers on or off.
8536
8559
  * If false, the layout will be displayed with splitters only.
8560
+ *
8561
+ * @default true
8537
8562
  */
8538
8563
  hasHeaders?: boolean;
8539
8564
  /**
8540
- * @defaultValue true
8541
- *
8542
8565
  * If true, the user can re-arrange the layout by
8543
8566
  * dragging items by their tabs to the desired location.
8567
+ *
8568
+ * @default true
8544
8569
  */
8545
8570
  reorderEnabled?: boolean;
8546
8571
  /**
8547
- * @defaultValue false
8548
- *
8549
8572
  * If true, tabs can't be dragged out of the window.
8573
+ *
8574
+ * @default false
8550
8575
  */
8551
8576
  preventDragOut?: boolean;
8552
8577
  /**
8553
- * @defaultValue false
8578
+ * @defaultValue=false
8554
8579
  *
8555
8580
  * If true, tabs can't be dragged into the window.
8581
+ *
8582
+ * @default false
8556
8583
  */
8557
8584
  preventDragIn?: boolean;
8558
8585
  /* Excluded from this release type: disableTabOverflowDropdown */
@@ -9060,10 +9087,10 @@ declare type MutableViewOptions = {
9060
9087
  /**
9061
9088
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9062
9089
  *
9063
- * @defaultValue true
9064
- *
9065
9090
  * Show the context menu when right-clicking on the view.
9066
9091
  * Gives access to the devtools for the view.
9092
+ *
9093
+ * @default true
9067
9094
  */
9068
9095
  contextMenu: boolean;
9069
9096
  /**
@@ -9110,24 +9137,25 @@ declare type MutableViewOptions = {
9110
9137
  contentNavigation: ContentNavigation;
9111
9138
  contentRedirect: ContentRedirect;
9112
9139
  /**
9113
- * @defaultValue false
9114
9140
  * @deprecated
9115
9141
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9116
9142
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9143
+ *
9144
+ * @default false
9117
9145
  */
9118
9146
  detachOnClose: boolean;
9119
9147
  /**
9120
- * @defaultValue true
9121
- *
9122
9148
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9123
9149
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9124
9150
  * if the view isn't part of the new layout when running `Layout.replace`.
9151
+ *
9152
+ * @default true
9125
9153
  */
9126
9154
  isClosable: boolean;
9127
9155
  /**
9128
- * @defaultValue false
9129
- *
9130
9156
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9157
+ *
9158
+ * @default false
9131
9159
  */
9132
9160
  preventDragOut: boolean;
9133
9161
  interop?: InteropConfig;
@@ -9135,7 +9163,7 @@ declare type MutableViewOptions = {
9135
9163
  /**
9136
9164
  * {@inheritDoc ViewThrottling}
9137
9165
  *
9138
- * @defaultValue 'enabled'
9166
+ * @default 'enabled'
9139
9167
  */
9140
9168
  throttling: ViewThrottling;
9141
9169
  /**
@@ -9154,7 +9182,7 @@ declare type MutableWindowOptions = {
9154
9182
  * Turns anything of matching RGB value transparent.
9155
9183
  *
9156
9184
  * Caveats:
9157
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9185
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9158
9186
  * * User cannot click-through transparent regions
9159
9187
  * * Not supported on Mac
9160
9188
  * * Windows Aero must be enabled
@@ -9163,25 +9191,25 @@ declare type MutableWindowOptions = {
9163
9191
  */
9164
9192
  alphaMask: RGB;
9165
9193
  /**
9166
- * @defaultValue false
9167
- *
9168
9194
  * Always position the window at the top of the window stack.
9195
+ *
9196
+ * @default false
9169
9197
  */
9170
9198
  alwaysOnTop: boolean;
9171
9199
  /**
9172
- * @defaultValue 0
9173
- *
9174
9200
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9175
9201
  * an aspect ratio will not be enforced.
9202
+ *
9203
+ * @default 0
9176
9204
  */
9177
9205
  aspectRatio: number;
9178
9206
  /**
9179
9207
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9180
9208
  *
9181
- * @defaultValue true
9182
- *
9183
9209
  * Show the context menu when right-clicking on the window.
9184
9210
  * Gives access to the devtools for the window.
9211
+ *
9212
+ * @default true
9185
9213
  */
9186
9214
  contextMenu: boolean;
9187
9215
  /**
@@ -9248,16 +9276,17 @@ declare type MutableWindowOptions = {
9248
9276
  */
9249
9277
  customData: any;
9250
9278
  /**
9251
- * @defaultValue true
9252
9279
  * @deprecated Will be removed in runtime version 45
9253
9280
  *
9254
9281
  * Show the window's frame.
9282
+ *
9283
+ * @default true
9255
9284
  */
9256
9285
  frame: boolean;
9257
9286
  /**
9258
- * @defaultValue false
9259
- *
9260
9287
  * Hides the window instead of closing it when the close button is pressed.
9288
+ *
9289
+ * @default false
9261
9290
  */
9262
9291
  hideOnClose: boolean;
9263
9292
  /**
@@ -9310,60 +9339,61 @@ declare type MutableWindowOptions = {
9310
9339
  */
9311
9340
  icon: string;
9312
9341
  /**
9313
- * @defaultValue true
9314
- *
9315
9342
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9316
9343
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9344
+ *
9345
+ * @default true
9317
9346
  */
9318
9347
  includeInSnapshots: boolean;
9319
9348
  /**
9320
- * @defaultValue -1
9321
- *
9322
9349
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9350
+ *
9351
+ * @default -1
9323
9352
  */
9324
9353
  maxHeight: number;
9325
9354
  /**
9326
- * @defaultValue true
9327
- *
9328
9355
  * Allows the window to be maximized.
9356
+ *
9357
+ * @default true
9329
9358
  */
9330
9359
  maximizable: boolean;
9331
9360
  /**
9332
- * @defaultValue -1
9333
- *
9334
9361
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9362
+ *
9363
+ * @default -1
9335
9364
  */
9336
9365
  maxWidth: number;
9337
9366
  /**
9338
- * @defaultValue 0
9339
- *
9340
9367
  * The minimum height of the window.
9368
+ *
9369
+ * @default 0
9341
9370
  */
9342
9371
  minHeight: number;
9343
9372
  /**
9344
- * @defaultValue true
9345
- *
9346
9373
  * Allows the window to be minimized.
9374
+ *
9375
+ * @default true
9347
9376
  */
9348
9377
  minimizable: boolean;
9349
9378
  /**
9350
- * @defaultValue true
9351
- *
9352
9379
  * The minimum width of the window.
9380
+ *
9381
+ * @default true
9353
9382
  */
9354
9383
  minWidth: number;
9355
9384
  /**
9356
- * @defaultValue 1
9357
- *
9358
9385
  * A flag that specifies how transparent the window will be.
9359
9386
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9360
9387
  * This value is clamped between `0.0` and `1.0`.
9388
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9389
+ *
9390
+ * @default 1
9361
9391
  */
9362
9392
  opacity: number;
9363
9393
  /**
9364
- * @defaultValue true
9365
- *
9366
9394
  * A flag to allow the user to resize the window.
9395
+ *
9396
+ * @default true
9367
9397
  */
9368
9398
  resizable: boolean;
9369
9399
  /**
@@ -9371,16 +9401,16 @@ declare type MutableWindowOptions = {
9371
9401
  */
9372
9402
  resizeRegion: ResizeRegion;
9373
9403
  /**
9374
- * @defaultValue false
9375
- *
9376
9404
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9377
9405
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9406
+ *
9407
+ * @default false
9378
9408
  */
9379
9409
  showBackgroundImages: boolean;
9380
9410
  /**
9381
- * @defaultValue true
9382
- *
9383
9411
  * Shows the window's icon in the taskbar.
9412
+ *
9413
+ * @default true
9384
9414
  */
9385
9415
  showTaskbarIcon: boolean;
9386
9416
  /**
@@ -9399,7 +9429,7 @@ declare type MutableWindowOptions = {
9399
9429
  /**
9400
9430
  * {@inheritDoc WindowThrottling}
9401
9431
  *
9402
- * @defaultValue 'enabled'
9432
+ * @default 'enabled'
9403
9433
  *
9404
9434
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9405
9435
  */
@@ -10045,12 +10075,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10045
10075
  */
10046
10076
  declare type PastePermissions = {
10047
10077
  /**
10048
- * @defaultValue 'non-protected-content'
10049
- *
10050
10078
  * Controls the behavior for paste operations for a matched URL.
10051
10079
  *
10052
10080
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10053
10081
  * 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.
10082
+ *
10083
+ * @default 'non-protected-content'
10054
10084
  */
10055
10085
  behavior: 'non-protected-content' | 'all-content';
10056
10086
  };
@@ -11082,11 +11112,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11082
11112
  */
11083
11113
  providerUrl?: string;
11084
11114
  /**
11085
- * @defaultValue true
11086
- *
11087
11115
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11088
11116
  *
11089
11117
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11118
+ *
11119
+ * @default true
11090
11120
  */
11091
11121
  allowLaunchIntoPlatform?: boolean;
11092
11122
  };
@@ -11734,22 +11764,22 @@ declare type PopupOptions = {
11734
11764
  url?: string;
11735
11765
  /**
11736
11766
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11737
- * @defaultValue 300
11767
+ * @default 300
11738
11768
  */
11739
11769
  height?: number;
11740
11770
  /**
11741
11771
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11742
- * @defaultValue 300
11772
+ * @default 300
11743
11773
  */
11744
11774
  width?: number;
11745
11775
  /**
11746
11776
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11747
- * @defaultValue 0
11777
+ * @default 0
11748
11778
  */
11749
11779
  x?: number;
11750
11780
  /**
11751
11781
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11752
- * @defaultValue 0
11782
+ * @default 0
11753
11783
  */
11754
11784
  y?: number;
11755
11785
  /**
@@ -11757,7 +11787,7 @@ declare type PopupOptions = {
11757
11787
  * * 'modal' restricts resizing and positioning in the caller.
11758
11788
  * * 'hide' hides the popup window on blur.
11759
11789
  * * 'close' closes the popup window on blur.
11760
- * @defaultValue 'close'
11790
+ * @default 'close'
11761
11791
  */
11762
11792
  blurBehavior?: PopupBlurBehavior;
11763
11793
  /**
@@ -11765,19 +11795,19 @@ declare type PopupOptions = {
11765
11795
  * * 'none' will do nothing.
11766
11796
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11767
11797
  * * 'close' closes the popup window on `dispatchPopupResult`.
11768
- * @defaultValue 'close'
11798
+ * @default 'close'
11769
11799
  */
11770
11800
  resultDispatchBehavior?: PopupResultBehavior;
11771
11801
  /**
11772
11802
  * Hide the popup window instead of closing when `close` is called on it.
11773
11803
  *
11774
11804
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11775
- * @defaultValue false
11805
+ * @default false
11776
11806
  */
11777
11807
  hideOnClose?: boolean;
11778
11808
  /**
11779
11809
  * Determines if the popup window should or should not be focused when it is shown.
11780
- * @defaultValue true
11810
+ * @default true
11781
11811
  */
11782
11812
  focus?: boolean;
11783
11813
  /**
@@ -11871,9 +11901,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
11871
11901
  */
11872
11902
  declare type PreloadScript = {
11873
11903
  /**
11874
- * @defaultValue false
11875
- *
11876
11904
  * Fail to load the window if this preload script fails
11905
+ *
11906
+ * @default false
11877
11907
  */
11878
11908
  mandatory?: boolean;
11879
11909
  /**
@@ -11965,15 +11995,15 @@ declare type PrinterInfo = {
11965
11995
  declare type PrintOptions = {
11966
11996
  content?: 'self';
11967
11997
  /**
11968
- * @defaultValue false
11969
- *
11970
11998
  * Disables prompting the user for print settings.
11999
+ *
12000
+ * @default false
11971
12001
  */
11972
12002
  silent?: boolean;
11973
12003
  /**
11974
- * @defaultValue false
11975
- *
11976
12004
  * Includes the webpage background color and image when printing.
12005
+ *
12006
+ * @default false
11977
12007
  */
11978
12008
  printBackground?: boolean;
11979
12009
  /**
@@ -11981,9 +12011,9 @@ declare type PrintOptions = {
11981
12011
  */
11982
12012
  deviceName?: string;
11983
12013
  /**
11984
- * @defaultValue true
11985
- *
11986
12014
  * Prints in full color (greyscale otherwise).
12015
+ *
12016
+ * @default true
11987
12017
  */
11988
12018
  color?: boolean;
11989
12019
  /**
@@ -11991,9 +12021,9 @@ declare type PrintOptions = {
11991
12021
  */
11992
12022
  margins?: Margins;
11993
12023
  /**
11994
- * @defaultValue true
11995
- *
11996
12024
  * Prints in landscape mode (portrait otherwise).
12025
+ *
12026
+ * @default true
11997
12027
  */
11998
12028
  landscape?: boolean;
11999
12029
  /**
@@ -13369,15 +13399,15 @@ declare type ReplaceViewPayload = {
13369
13399
  */
13370
13400
  declare type ResizeRegion = {
13371
13401
  /**
13372
- * @defaultValue 7
13373
- *
13374
13402
  * The size of the resize region in pixels.
13403
+ *
13404
+ * @default 7
13375
13405
  */
13376
13406
  size?: number;
13377
13407
  /**
13378
- * @defaultValue 9
13379
- *
13380
13408
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13409
+ *
13410
+ * @default 9
13381
13411
  */
13382
13412
  bottomRightCorner?: number;
13383
13413
  /**
@@ -13385,27 +13415,27 @@ declare type ResizeRegion = {
13385
13415
  */
13386
13416
  sides?: {
13387
13417
  /**
13388
- * @defaultValue true
13389
- *
13390
13418
  * Enables resizing from the top of the window.
13419
+ *
13420
+ * @default true
13391
13421
  */
13392
13422
  top?: boolean;
13393
13423
  /**
13394
- * @defaultValue true
13395
- *
13396
13424
  * Enables resizing from the bottom of the window.
13425
+ *
13426
+ * @default true
13397
13427
  */
13398
13428
  bottom?: boolean;
13399
13429
  /**
13400
- * @defaultValue true
13401
- *
13402
13430
  * Enables resizing from the left side of the window.
13431
+ *
13432
+ * @default true
13403
13433
  */
13404
13434
  left?: boolean;
13405
13435
  /**
13406
- * @defaultValue true
13407
- *
13408
13436
  * Enables resizing from the right side of the window.
13437
+ *
13438
+ * @default true
13409
13439
  */
13410
13440
  right?: boolean;
13411
13441
  };
@@ -13959,9 +13989,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13959
13989
  */
13960
13990
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13961
13991
  /**
13962
- * @defaultValue 0
13963
- *
13964
13992
  * Number of milliseconds to wait between view repaints.
13993
+ *
13994
+ * @default 0
13965
13995
  */
13966
13996
  paintIntervalMs?: number;
13967
13997
  };
@@ -16013,9 +16043,9 @@ declare type TransitionBase = {
16013
16043
  */
16014
16044
  duration: number;
16015
16045
  /**
16016
- * @defaultValue false
16017
- *
16018
16046
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16047
+ *
16048
+ * @default false
16019
16049
  */
16020
16050
  relative?: boolean;
16021
16051
  };
@@ -16031,9 +16061,9 @@ declare type TransitionOptions = {
16031
16061
  */
16032
16062
  interrupt: boolean;
16033
16063
  /**
16034
- * @defaultValue false
16035
- *
16036
16064
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16065
+ *
16066
+ * @default false
16037
16067
  */
16038
16068
  relative?: boolean;
16039
16069
  tween?: tween;
@@ -16961,9 +16991,9 @@ declare type ViewTitlePriority = 'document' | 'options';
16961
16991
  */
16962
16992
  declare type ViewVisibilityOption = {
16963
16993
  /**
16964
- * @defaultValue false
16965
- *
16966
16994
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
16995
+ *
16996
+ * @default false
16967
16997
  */
16968
16998
  enabled?: boolean;
16969
16999
  };