@openfin/fdc3-api 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.
@@ -130,13 +130,13 @@ declare type ApiSettings = {
130
130
  /**
131
131
  * Inject OpenFin API into cross-origin iframes
132
132
  *
133
- * @defaultValue false
133
+ * @default false
134
134
  */
135
135
  crossOriginInjection?: boolean;
136
136
  /**
137
137
  * Inject OpenFin API into same-origin iframes
138
138
  *
139
- * @defaultValue true
139
+ * @default true
140
140
  */
141
141
  sameOriginInjection?: boolean;
142
142
  /**
@@ -1175,19 +1175,19 @@ declare class ApplicationModule extends Base {
1175
1175
  */
1176
1176
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1177
1177
  /**
1178
- * @defaultValue false
1179
- *
1180
1178
  * Disables IAB secure logging for the app.
1179
+ *
1180
+ * @default false
1181
1181
  */
1182
1182
  disableIabSecureLogging: boolean;
1183
1183
  /**
1184
- * @defaultValue 'There was an error loading the application.'
1185
- *
1186
1184
  * An error message to display when the application (launched via manifest) fails to load.
1187
1185
  * A dialog box will be launched with the error message just before the runtime exits.
1188
1186
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1189
1187
  * will trigger this dialog.
1190
1188
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1189
+ *
1190
+ * @default 'There was an error loading the application.'
1191
1191
  */
1192
1192
  loadErrorMessage: string;
1193
1193
  /**
@@ -1206,28 +1206,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1206
1206
  */
1207
1207
  name: string;
1208
1208
  /**
1209
- * @defaultValue false
1210
- *
1211
1209
  * A flag to configure the application as non-persistent.
1212
1210
  * Runtime exits when there are no persistent apps running.
1211
+ *
1212
+ * @default false
1213
1213
  */
1214
1214
  nonPersistent: boolean;
1215
1215
  /**
1216
- * @defaultValue false
1217
- *
1218
1216
  * Enable Flash at the application level.
1217
+ *
1218
+ * @default false
1219
1219
  */
1220
1220
  plugins: boolean;
1221
1221
  /**
1222
- * @defaultValue false
1223
- *
1224
1222
  * Enable spell check at the application level.
1223
+ *
1224
+ * @default false
1225
1225
  */
1226
1226
  spellCheck: boolean;
1227
1227
  /**
1228
- * @defaultValue 'about:blank'
1229
- *
1230
1228
  * The url to the application (specifically the application's main window).
1229
+ *
1230
+ * @default 'about:blank'
1231
1231
  */
1232
1232
  url: string;
1233
1233
  /**
@@ -1236,9 +1236,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1236
1236
  */
1237
1237
  uuid: string;
1238
1238
  /**
1239
- * @defaultValue true
1240
- *
1241
1239
  * When set to `false` it will disable the same-origin policy for the app.
1240
+ *
1241
+ * @default true
1242
1242
  */
1243
1243
  webSecurity: boolean;
1244
1244
  /**
@@ -1248,10 +1248,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1248
1248
  commands: ShortcutOverride[];
1249
1249
  isPlatformController: boolean;
1250
1250
  /**
1251
- * @defaultValue 1000
1252
- *
1253
1251
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1254
1252
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1253
+ *
1254
+ * @default 1000
1255
1255
  */
1256
1256
  maxViewPoolSize: number;
1257
1257
  /**
@@ -1267,12 +1267,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1267
1267
  */
1268
1268
  snapshot: Snapshot;
1269
1269
  /**
1270
- * @defaultValue false
1271
- *
1272
1270
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1273
1271
  *
1274
1272
  * Note: if the Platform Provider is showing, it won't close automatically.
1275
1273
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1274
+ *
1275
+ * @default false
1276
1276
  */
1277
1277
  preventQuitOnLastWindowClosed: boolean;
1278
1278
  /**
@@ -1280,9 +1280,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1280
1280
  */
1281
1281
  interopBrokerConfiguration: InteropBrokerOptions;
1282
1282
  /**
1283
- * @defaultValue true
1284
- *
1285
1283
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1284
+ *
1285
+ * @default true
1286
1286
  */
1287
1287
  apiDiagnostics: boolean;
1288
1288
  /**
@@ -1298,16 +1298,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1298
1298
  */
1299
1299
  permissions?: Partial<Permissions_2>;
1300
1300
  /**
1301
- * @defaultValue false
1302
- *
1303
1301
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1304
1302
  * Only relevant in Windows.
1303
+ *
1304
+ * @default false
1305
1305
  */
1306
1306
  enableJumpList: boolean;
1307
1307
  /**
1308
- * @defaultValue false
1309
- *
1310
1308
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1309
+ *
1310
+ * @default false
1311
1311
  */
1312
1312
  enableBeforeUnload: boolean;
1313
1313
  /**
@@ -1388,25 +1388,25 @@ declare type ApplicationWindowInfo = {
1388
1388
  */
1389
1389
  declare type ApplySnapshotOptions = {
1390
1390
  /**
1391
- * @defaultValue false
1392
- *
1393
1391
  * When true, applySnapshot will close existing windows,
1394
1392
  * replacing current Platform state with the given snapshot.
1393
+ *
1394
+ * @default false
1395
1395
  */
1396
1396
  closeExistingWindows?: boolean;
1397
1397
  /**
1398
- * @defaultValue false
1399
- *
1400
1398
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1401
1399
  * replacing current Platform state with the given snapshot.
1400
+ *
1401
+ * @default false
1402
1402
  */
1403
1403
  closeSnapshotWindows?: boolean;
1404
1404
  /**
1405
- * @defaultValue false
1406
- *
1407
1405
  * When true, applySnapshot will not check whether any windows in a
1408
1406
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1409
1407
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1408
+ *
1409
+ * @default false
1410
1410
  */
1411
1411
  skipOutOfBoundsCheck?: boolean;
1412
1412
  };
@@ -2063,15 +2063,15 @@ declare type CapturePageOptions = {
2063
2063
  */
2064
2064
  area?: Rectangle;
2065
2065
  /**
2066
- * @defaultValue 'png'
2067
- *
2068
2066
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2067
+ *
2068
+ * @default 'png'
2069
2069
  */
2070
2070
  format?: 'bmp' | 'jpg' | 'png';
2071
2071
  /**
2072
- * @defaultValue 100
2073
- *
2074
2072
  * Quality of JPEG image. Between 0 - 100.
2073
+ *
2074
+ * @default 100
2075
2075
  */
2076
2076
  quality?: number;
2077
2077
  };
@@ -2704,9 +2704,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2704
2704
  */
2705
2705
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2706
2706
  /**
2707
- * @defaultValue true
2708
- *
2709
2707
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2708
+ *
2709
+ * @default true
2710
2710
  */
2711
2711
  wait?: boolean;
2712
2712
  /**
@@ -3000,6 +3000,10 @@ declare type ChromiumPolicies = {
3000
3000
  * Disable AutofillAddressEnabled policy for a Window or View.
3001
3001
  */
3002
3002
  AutofillAddressEnabled?: PolicyOptions;
3003
+ /**
3004
+ * Disable AutofillCreditCardEnabled policy for a Window or View.
3005
+ */
3006
+ AutofillCreditCardEnabled?: PolicyOptions;
3003
3007
  };
3004
3008
 
3005
3009
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3365,9 +3369,9 @@ declare interface CloseWindowPayload {
3365
3369
  windowId: Identity_4;
3366
3370
  options: {
3367
3371
  /**
3368
- * @defaultValue false
3369
- *
3370
3372
  * When set to true skips any before handler set on views that are part of the window
3373
+ *
3374
+ * @default false
3371
3375
  */
3372
3376
  skipBeforeUnload?: boolean;
3373
3377
  };
@@ -3472,9 +3476,9 @@ declare type ConstViewOptions = {
3472
3476
  */
3473
3477
  name: string;
3474
3478
  /**
3475
- * @defaultValue "about:blank"
3476
- *
3477
3479
  * The URL of the window
3480
+ *
3481
+ * @default "about:blank"
3478
3482
  */
3479
3483
  url: string;
3480
3484
  /**
@@ -3499,6 +3503,15 @@ declare type ConstViewOptions = {
3499
3503
  * Custom headers for requests sent by the view.
3500
3504
  */
3501
3505
  customRequestHeaders: CustomRequestHeaders[];
3506
+ /**
3507
+ * @experimental
3508
+ *
3509
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
3510
+ * These css properties are used to enable dragging of a frameless window.
3511
+ *
3512
+ * @default false
3513
+ */
3514
+ disableAppRegion: boolean;
3502
3515
  /**
3503
3516
  * Initial bounds given relative to the window.
3504
3517
  */
@@ -3535,9 +3548,9 @@ declare type ConstViewOptions = {
3535
3548
  experimental: any;
3536
3549
  fdc3InteropApi?: string;
3537
3550
  /**
3538
- * @defaultValue false
3539
- *
3540
3551
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3552
+ *
3553
+ * @default false
3541
3554
  */
3542
3555
  enableBeforeUnload: boolean;
3543
3556
  /**
@@ -3618,13 +3631,12 @@ declare type ConstWindowOptions = {
3618
3631
  */
3619
3632
  backgroundColor: string;
3620
3633
  /**
3621
- * @defaultValue false
3622
- *
3623
3634
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3624
3635
  * This also affects the Page Visibility API.
3625
3636
  *
3626
3637
  * When `true`, the page is throttled whether it is hidden or not.
3627
3638
  *
3639
+ * @default false
3628
3640
  */
3629
3641
  backgroundThrottling: boolean;
3630
3642
  /**
@@ -3648,21 +3660,30 @@ declare type ConstWindowOptions = {
3648
3660
  */
3649
3661
  customRequestHeaders: CustomRequestHeaders[];
3650
3662
  /**
3651
- * @defaultValue true
3652
- *
3653
3663
  * Setting this to false would keep the Window alive even if all its Views were closed.
3654
3664
  * This is meant for advanced users and should be used with caution.
3655
3665
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3656
3666
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3657
3667
  * **NOTE:** - This option is ignored in non-Platforms apps.
3668
+ *
3669
+ * @default true
3658
3670
  */
3659
3671
  closeOnLastViewRemoved: boolean;
3660
3672
  /**
3661
- * @defaultValue 'all'
3673
+ * @experimental
3662
3674
  *
3675
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
3676
+ * These css properties are used to enable dragging of a frameless window.
3677
+ *
3678
+ * @default false
3679
+ */
3680
+ disableAppRegion: boolean;
3681
+ /**
3663
3682
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3664
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3683
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3665
3684
  * **NOTE:** - This option is ignored in non-Platforms apps.
3685
+ *
3686
+ * @default 'all'
3666
3687
  */
3667
3688
  viewsPreventingClose: 'all' | 'layout';
3668
3689
  /**
@@ -3673,31 +3694,31 @@ declare type ConstWindowOptions = {
3673
3694
  */
3674
3695
  defaultCentered: boolean;
3675
3696
  /**
3676
- * @defaultValue 500
3677
- *
3678
3697
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3679
3698
  * in favor of the cached value.
3699
+ *
3700
+ * @default 500
3680
3701
  */
3681
3702
  defaultHeight: number;
3682
3703
  /**
3683
- * @defaultValue 100
3684
- *
3685
3704
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3686
3705
  * launches in favor of the cached value.
3706
+ *
3707
+ * @default 100
3687
3708
  */
3688
3709
  defaultLeft: number;
3689
3710
  /**
3690
- * @defaultValue 100
3691
- *
3692
3711
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3693
3712
  * launches in favor of the cached value.
3713
+ *
3714
+ * @default 100
3694
3715
  */
3695
3716
  defaultTop: number;
3696
3717
  /**
3697
- * @defaultValue 800
3698
- *
3699
3718
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3700
3719
  * launches in favor of the cached value.
3720
+ *
3721
+ * @default 800
3701
3722
  */
3702
3723
  defaultWidth: number;
3703
3724
  /**
@@ -3743,19 +3764,19 @@ declare type ConstWindowOptions = {
3743
3764
  */
3744
3765
  processAffinity: string;
3745
3766
  /**
3746
- * @defaultValue false
3747
- *
3748
3767
  * Displays a shadow on frameless windows.
3749
3768
  * `shadow` and `cornerRounding` are mutually exclusive.
3750
3769
  * On Windows 7, Aero theme is required.
3770
+ *
3771
+ * @default false
3751
3772
  */
3752
3773
  shadow: boolean;
3753
3774
  /**
3754
- * @defaultValue true
3755
- *
3756
3775
  * Caches the location of the window.
3757
3776
  *
3758
3777
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3778
+ *
3779
+ * @default true
3759
3780
  */
3760
3781
  saveWindowState: boolean;
3761
3782
  /**
@@ -3764,22 +3785,22 @@ declare type ConstWindowOptions = {
3764
3785
  */
3765
3786
  ignoreSavedWindowState: boolean;
3766
3787
  /**
3767
- * @defaultValue false
3768
- *
3769
3788
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3770
3789
  *
3771
3790
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3772
3791
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3792
+ *
3793
+ * @default false
3773
3794
  */
3774
3795
  smallWindow: boolean;
3775
3796
  /**
3776
- * @defaultValue "normal"
3777
- *
3778
3797
  * The visible state of the window on creation.
3779
3798
  * One of:
3780
3799
  * * `"maximized"`
3781
3800
  * * `"minimized"`
3782
3801
  * * `"normal"`
3802
+ *
3803
+ * @default "normal"
3783
3804
  */
3784
3805
  state: WindowState;
3785
3806
  /**
@@ -3794,26 +3815,26 @@ declare type ConstWindowOptions = {
3794
3815
  */
3795
3816
  taskbarIconGroup: string;
3796
3817
  /**
3797
- * @defaultValue "about:blank"
3798
- *
3799
3818
  * The URL of the window
3819
+ *
3820
+ * @default "about:blank"
3800
3821
  */
3801
3822
  url: string;
3802
3823
  /**
3803
- * @defaultValue <application UUID>
3804
- *
3805
3824
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3806
3825
  * If omitted, defaults to the `uuid` of the application spawning the window.
3807
3826
  * If given, must match the `uuid` of the application spawning the window.
3808
3827
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3809
3828
  * really no need to provide it.
3829
+ *
3830
+ * @default <application UUID>
3810
3831
  */
3811
3832
  uuid: string;
3812
3833
  /**
3813
- * @defaultValue false
3814
- *
3815
3834
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3816
3835
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3836
+ *
3837
+ * @default false
3817
3838
  */
3818
3839
  waitForPageLoad: boolean;
3819
3840
  width: number;
@@ -3833,6 +3854,10 @@ declare type ConstWindowOptions = {
3833
3854
  * Control which options to ignore when creating a Platform Window.
3834
3855
  */
3835
3856
  excludeOptions: ExcludeOptions;
3857
+ /**
3858
+ * 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.
3859
+ */
3860
+ roundedCorners: boolean;
3836
3861
  };
3837
3862
 
3838
3863
  /**
@@ -4095,13 +4120,13 @@ declare type CopyBlockedEventReason = 'disabled';
4095
4120
  */
4096
4121
  declare type CopyPermissions = {
4097
4122
  /**
4098
- * @defaultValue 'allowed'
4099
- *
4100
4123
  * Controls the behavior for copy operations for a matched URL.
4101
4124
  *
4102
4125
  * allow: Enables all copy operations.
4103
4126
  * block: Disables all copy operations.
4104
4127
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4128
+ *
4129
+ * @default 'allowed'
4105
4130
  */
4106
4131
  behavior: 'allow' | 'block' | 'protect';
4107
4132
  /**
@@ -4109,9 +4134,9 @@ declare type CopyPermissions = {
4109
4134
  */
4110
4135
  options?: {
4111
4136
  /**
4112
- * @defaultValue ''
4113
- *
4114
4137
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4138
+ *
4139
+ * @default ''
4115
4140
  */
4116
4141
  replacementText: string;
4117
4142
  };
@@ -4125,15 +4150,15 @@ declare type CopyPermissions = {
4125
4150
  */
4126
4151
  declare type CornerRounding = {
4127
4152
  /**
4128
- * @defaultValue 0
4129
- *
4130
4153
  * The height in pixels.
4154
+ *
4155
+ * @default 0
4131
4156
  */
4132
4157
  height: number;
4133
4158
  /**
4134
- * @defaultValue 0
4135
- *
4136
4159
  * The width in pixels.
4160
+ *
4161
+ * @default 0
4137
4162
  */
4138
4163
  width: number;
4139
4164
  };
@@ -4223,8 +4248,6 @@ declare type CreateLayoutOptions = {
4223
4248
  layoutName: string;
4224
4249
  layout: LayoutOptions;
4225
4250
  /**
4226
- * @defaultValue 'default'
4227
- *
4228
4251
  * Controls the View behavior for the given `layout` property. Note
4229
4252
  * that the selected behavior only applies to unnamed Views or
4230
4253
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4246,6 +4269,8 @@ declare type CreateLayoutOptions = {
4246
4269
  * override. Note that during applyLayoutSnapshot, Views are created and
4247
4270
  * attached to the Provider while the Window is being created, so it's
4248
4271
  * important to not 'duplicate' Views in this workflow.
4272
+ *
4273
+ * @default 'default'
4249
4274
  */
4250
4275
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4251
4276
  };
@@ -4504,7 +4529,7 @@ declare type DomainApiSettings = {
4504
4529
  * * 'none': The `fin` API will be not available.
4505
4530
  * * 'global': The entire `fin` API will be available.
4506
4531
  *
4507
- * @defaultValue 'global'
4532
+ * @default 'global'
4508
4533
  */
4509
4534
  fin?: InjectionType;
4510
4535
  /**
@@ -5089,9 +5114,9 @@ declare type EventType_9 = Event_12['type'];
5089
5114
  */
5090
5115
  declare type ExcludeOptions = {
5091
5116
  /**
5092
- * @defaultValue false
5093
- *
5094
5117
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5118
+ *
5119
+ * @default false
5095
5120
  */
5096
5121
  preloadScripts: boolean;
5097
5122
  };
@@ -5910,34 +5935,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
5910
5935
  */
5911
5936
  declare type FindInPageOptions = {
5912
5937
  /**
5913
- * @defaultValue true
5914
- *
5915
5938
  * Searches in the forward direction (backward otherwise)
5939
+ *
5940
+ * @default true
5916
5941
  */
5917
5942
  forward?: boolean;
5918
5943
  /**
5919
- * @defaultValue false
5920
- *
5921
5944
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5945
+ *
5946
+ * @default false
5922
5947
  */
5923
5948
  findNext?: boolean;
5924
5949
  /**
5925
- * @defaultValue false
5926
- *
5927
5950
  * Enables case-sensitive searching.
5951
+ *
5952
+ * @default false
5928
5953
  */
5929
5954
  matchCase?: boolean;
5930
5955
  /**
5931
- * @defaultValue false
5932
- *
5933
5956
  * Only searches from the start of words.
5957
+ *
5958
+ * @default false
5934
5959
  */
5935
5960
  wordStart?: boolean;
5936
5961
  /**
5937
- * @defaultValue false
5938
- *
5939
5962
  * 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>
5940
5963
  * lowercase or non-letter. Accepts several other intra-word matches.
5964
+ *
5965
+ * @default false
5941
5966
  */
5942
5967
  medialCapitalAsWordStart?: boolean;
5943
5968
  };
@@ -6445,9 +6470,9 @@ declare type Hotkey = {
6445
6470
  */
6446
6471
  keys: string;
6447
6472
  /**
6448
- * @defaultValue false
6449
- *
6450
6473
  * Prevent default key handling before emitting the event.
6474
+ *
6475
+ * @default false
6451
6476
  */
6452
6477
  preventDefault?: boolean;
6453
6478
  };
@@ -8804,77 +8829,79 @@ declare type LayoutOptions = {
8804
8829
  */
8805
8830
  newTabButtonUrl?: string;
8806
8831
  /**
8807
- * @defaultValue false
8808
- *
8809
8832
  * When true the splitters will not be draggable and the layout will not resize.
8833
+ *
8834
+ * @default false
8810
8835
  */
8811
8836
  preventSplitterResize?: boolean;
8812
8837
  /**
8813
- * @defaultValue false
8814
- *
8815
8838
  * Whether the popout button will only act on the entire stack,
8816
8839
  * as opposed to only the active tab.
8840
+ *
8841
+ * @default false
8817
8842
  */
8818
8843
  popoutWholeStack?: boolean;
8819
8844
  /**
8820
- * @defaultValue false
8821
- *
8822
8845
  * Limits the area to which tabs can be dragged.
8823
8846
  * If true, the layout container is the only area where tabs can be dropped.
8847
+ *
8848
+ * @default false
8824
8849
  */
8825
8850
  constrainDragToContainer?: boolean;
8826
8851
  /**
8827
- * @defaultValue false
8828
- *
8829
8852
  * Whether to show the popout button on stack header.
8830
8853
  * The button will create a new window with current tab as its content.
8831
8854
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8855
+ *
8856
+ * @default false
8832
8857
  */
8833
8858
  showPopoutIcon?: boolean;
8834
8859
  /**
8835
- * @defaultValue false
8836
- *
8837
8860
  * Whether to show the maximize button on stack header.
8838
8861
  * The button will maximize the current tab to fill the entire window.
8862
+ *
8863
+ * @default false
8839
8864
  */
8840
8865
  showMaximiseIcon?: boolean;
8841
8866
  /**
8842
- * @defaultValue false
8843
- *
8844
8867
  * Whether to show the close button on stack header
8845
8868
  * (not to be confused with close button on every tab).
8869
+ *
8870
+ * @default false
8846
8871
  */
8847
8872
  showCloseIcon?: boolean;
8848
8873
  /**
8849
- * @defaultValue false
8850
- *
8851
8874
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8875
+ *
8876
+ * @default false
8852
8877
  */
8853
8878
  constrainDragToHeaders?: boolean;
8854
8879
  /**
8855
- * @defaultValue true
8856
- *
8857
8880
  * Turns tab headers on or off.
8858
8881
  * If false, the layout will be displayed with splitters only.
8882
+ *
8883
+ * @default true
8859
8884
  */
8860
8885
  hasHeaders?: boolean;
8861
8886
  /**
8862
- * @defaultValue true
8863
- *
8864
8887
  * If true, the user can re-arrange the layout by
8865
8888
  * dragging items by their tabs to the desired location.
8889
+ *
8890
+ * @default true
8866
8891
  */
8867
8892
  reorderEnabled?: boolean;
8868
8893
  /**
8869
- * @defaultValue false
8870
- *
8871
8894
  * If true, tabs can't be dragged out of the window.
8895
+ *
8896
+ * @default false
8872
8897
  */
8873
8898
  preventDragOut?: boolean;
8874
8899
  /**
8875
8900
  * @defaultValue=false
8876
8901
  *
8877
8902
  * If true, tabs can't be dragged into the window.
8903
+ *
8904
+ * @default false
8878
8905
  */
8879
8906
  preventDragIn?: boolean;
8880
8907
  };
@@ -9326,10 +9353,10 @@ declare type MutableViewOptions = {
9326
9353
  /**
9327
9354
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9328
9355
  *
9329
- * @defaultValue true
9330
- *
9331
9356
  * Show the context menu when right-clicking on the view.
9332
9357
  * Gives access to the devtools for the view.
9358
+ *
9359
+ * @default true
9333
9360
  */
9334
9361
  contextMenu: boolean;
9335
9362
  /**
@@ -9376,24 +9403,25 @@ declare type MutableViewOptions = {
9376
9403
  contentNavigation: ContentNavigation;
9377
9404
  contentRedirect: ContentRedirect;
9378
9405
  /**
9379
- * @defaultValue false
9380
9406
  * @deprecated
9381
9407
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9382
9408
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9409
+ *
9410
+ * @default false
9383
9411
  */
9384
9412
  detachOnClose: boolean;
9385
9413
  /**
9386
- * @defaultValue true
9387
- *
9388
9414
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9389
9415
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9390
9416
  * if the view isn't part of the new layout when running `Layout.replace`.
9417
+ *
9418
+ * @default true
9391
9419
  */
9392
9420
  isClosable: boolean;
9393
9421
  /**
9394
- * @defaultValue false
9395
- *
9396
9422
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9423
+ *
9424
+ * @default false
9397
9425
  */
9398
9426
  preventDragOut: boolean;
9399
9427
  interop?: InteropConfig;
@@ -9401,7 +9429,7 @@ declare type MutableViewOptions = {
9401
9429
  /**
9402
9430
  * {@inheritDoc ViewThrottling}
9403
9431
  *
9404
- * @defaultValue 'enabled'
9432
+ * @default 'enabled'
9405
9433
  */
9406
9434
  throttling: ViewThrottling;
9407
9435
  /**
@@ -9420,7 +9448,7 @@ declare type MutableWindowOptions = {
9420
9448
  * Turns anything of matching RGB value transparent.
9421
9449
  *
9422
9450
  * Caveats:
9423
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9451
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9424
9452
  * * User cannot click-through transparent regions
9425
9453
  * * Not supported on Mac
9426
9454
  * * Windows Aero must be enabled
@@ -9429,25 +9457,25 @@ declare type MutableWindowOptions = {
9429
9457
  */
9430
9458
  alphaMask: RGB;
9431
9459
  /**
9432
- * @defaultValue false
9433
- *
9434
9460
  * Always position the window at the top of the window stack.
9461
+ *
9462
+ * @default false
9435
9463
  */
9436
9464
  alwaysOnTop: boolean;
9437
9465
  /**
9438
- * @defaultValue 0
9439
- *
9440
9466
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9441
9467
  * an aspect ratio will not be enforced.
9468
+ *
9469
+ * @default 0
9442
9470
  */
9443
9471
  aspectRatio: number;
9444
9472
  /**
9445
9473
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9446
9474
  *
9447
- * @defaultValue true
9448
- *
9449
9475
  * Show the context menu when right-clicking on the window.
9450
9476
  * Gives access to the devtools for the window.
9477
+ *
9478
+ * @default true
9451
9479
  */
9452
9480
  contextMenu: boolean;
9453
9481
  /**
@@ -9514,15 +9542,18 @@ declare type MutableWindowOptions = {
9514
9542
  */
9515
9543
  customData: any;
9516
9544
  /**
9545
+ * @deprecated Will be removed in runtime version 45
9517
9546
  * @defaultValue true
9518
9547
  *
9519
9548
  * Show the window's frame.
9549
+ *
9550
+ * @default true
9520
9551
  */
9521
9552
  frame: boolean;
9522
9553
  /**
9523
- * @defaultValue false
9524
- *
9525
9554
  * Hides the window instead of closing it when the close button is pressed.
9555
+ *
9556
+ * @default false
9526
9557
  */
9527
9558
  hideOnClose: boolean;
9528
9559
  /**
@@ -9575,60 +9606,61 @@ declare type MutableWindowOptions = {
9575
9606
  */
9576
9607
  icon: string;
9577
9608
  /**
9578
- * @defaultValue true
9579
- *
9580
9609
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9581
9610
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9611
+ *
9612
+ * @default true
9582
9613
  */
9583
9614
  includeInSnapshots: boolean;
9584
9615
  /**
9585
- * @defaultValue -1
9586
- *
9587
9616
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9617
+ *
9618
+ * @default -1
9588
9619
  */
9589
9620
  maxHeight: number;
9590
9621
  /**
9591
- * @defaultValue true
9592
- *
9593
9622
  * Allows the window to be maximized.
9623
+ *
9624
+ * @default true
9594
9625
  */
9595
9626
  maximizable: boolean;
9596
9627
  /**
9597
- * @defaultValue -1
9598
- *
9599
9628
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9629
+ *
9630
+ * @default -1
9600
9631
  */
9601
9632
  maxWidth: number;
9602
9633
  /**
9603
- * @defaultValue 0
9604
- *
9605
9634
  * The minimum height of the window.
9635
+ *
9636
+ * @default 0
9606
9637
  */
9607
9638
  minHeight: number;
9608
9639
  /**
9609
- * @defaultValue true
9610
- *
9611
9640
  * Allows the window to be minimized.
9641
+ *
9642
+ * @default true
9612
9643
  */
9613
9644
  minimizable: boolean;
9614
9645
  /**
9615
- * @defaultValue true
9616
- *
9617
9646
  * The minimum width of the window.
9647
+ *
9648
+ * @default true
9618
9649
  */
9619
9650
  minWidth: number;
9620
9651
  /**
9621
- * @defaultValue 1
9622
- *
9623
9652
  * A flag that specifies how transparent the window will be.
9624
9653
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9625
9654
  * This value is clamped between `0.0` and `1.0`.
9655
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9656
+ *
9657
+ * @default 1
9626
9658
  */
9627
9659
  opacity: number;
9628
9660
  /**
9629
- * @defaultValue true
9630
- *
9631
9661
  * A flag to allow the user to resize the window.
9662
+ *
9663
+ * @default true
9632
9664
  */
9633
9665
  resizable: boolean;
9634
9666
  /**
@@ -9636,16 +9668,22 @@ declare type MutableWindowOptions = {
9636
9668
  */
9637
9669
  resizeRegion: ResizeRegion;
9638
9670
  /**
9639
- * @defaultValue false
9640
- *
9641
9671
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9642
9672
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9673
+ *
9674
+ * @default false
9643
9675
  */
9644
9676
  showBackgroundImages: boolean;
9645
9677
  /**
9646
- * @defaultValue true
9647
- *
9648
9678
  * Shows the window's icon in the taskbar.
9679
+ *
9680
+ * @remarks
9681
+ * In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
9682
+ * In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
9683
+ * `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
9684
+ * {@link Window._Window.showPopupWindow}.
9685
+ *
9686
+ * @default true
9649
9687
  */
9650
9688
  showTaskbarIcon: boolean;
9651
9689
  /**
@@ -9664,7 +9702,7 @@ declare type MutableWindowOptions = {
9664
9702
  /**
9665
9703
  * {@inheritDoc WindowThrottling}
9666
9704
  *
9667
- * @defaultValue 'enabled'
9705
+ * @default 'enabled'
9668
9706
  *
9669
9707
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9670
9708
  */
@@ -10274,12 +10312,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10274
10312
  */
10275
10313
  declare type PastePermissions = {
10276
10314
  /**
10277
- * @defaultValue 'non-protected-content'
10278
- *
10279
10315
  * Controls the behavior for paste operations for a matched URL.
10280
10316
  *
10281
10317
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10282
10318
  * 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.
10319
+ *
10320
+ * @default 'non-protected-content'
10283
10321
  */
10284
10322
  behavior: 'non-protected-content' | 'all-content';
10285
10323
  };
@@ -11310,11 +11348,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11310
11348
  */
11311
11349
  providerUrl?: string;
11312
11350
  /**
11313
- * @defaultValue true
11314
- *
11315
11351
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11316
11352
  *
11317
11353
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11354
+ *
11355
+ * @default true
11318
11356
  */
11319
11357
  allowLaunchIntoPlatform?: boolean;
11320
11358
  };
@@ -11958,22 +11996,22 @@ declare type PopupOptions = {
11958
11996
  url?: string;
11959
11997
  /**
11960
11998
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11961
- * @defaultValue 300
11999
+ * @default 300
11962
12000
  */
11963
12001
  height?: number;
11964
12002
  /**
11965
12003
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11966
- * @defaultValue 300
12004
+ * @default 300
11967
12005
  */
11968
12006
  width?: number;
11969
12007
  /**
11970
12008
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11971
- * @defaultValue 0
12009
+ * @default 0
11972
12010
  */
11973
12011
  x?: number;
11974
12012
  /**
11975
12013
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11976
- * @defaultValue 0
12014
+ * @default 0
11977
12015
  */
11978
12016
  y?: number;
11979
12017
  /**
@@ -11981,7 +12019,7 @@ declare type PopupOptions = {
11981
12019
  * * 'modal' restricts resizing and positioning in the caller.
11982
12020
  * * 'hide' hides the popup window on blur.
11983
12021
  * * 'close' closes the popup window on blur.
11984
- * @defaultValue 'close'
12022
+ * @default 'close'
11985
12023
  */
11986
12024
  blurBehavior?: PopupBlurBehavior;
11987
12025
  /**
@@ -11989,19 +12027,19 @@ declare type PopupOptions = {
11989
12027
  * * 'none' will do nothing.
11990
12028
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11991
12029
  * * 'close' closes the popup window on `dispatchPopupResult`.
11992
- * @defaultValue 'close'
12030
+ * @default 'close'
11993
12031
  */
11994
12032
  resultDispatchBehavior?: PopupResultBehavior;
11995
12033
  /**
11996
12034
  * Hide the popup window instead of closing when `close` is called on it.
11997
12035
  *
11998
12036
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11999
- * @defaultValue false
12037
+ * @default false
12000
12038
  */
12001
12039
  hideOnClose?: boolean;
12002
12040
  /**
12003
12041
  * Determines if the popup window should or should not be focused when it is shown.
12004
- * @defaultValue true
12042
+ * @default true
12005
12043
  */
12006
12044
  focus?: boolean;
12007
12045
  /**
@@ -12095,9 +12133,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12095
12133
  */
12096
12134
  declare type PreloadScript = {
12097
12135
  /**
12098
- * @defaultValue false
12099
- *
12100
12136
  * Fail to load the window if this preload script fails
12137
+ *
12138
+ * @default false
12101
12139
  */
12102
12140
  mandatory?: boolean;
12103
12141
  /**
@@ -12193,15 +12231,15 @@ declare type PrinterInfo = {
12193
12231
  declare type PrintOptions = {
12194
12232
  content?: 'self';
12195
12233
  /**
12196
- * @defaultValue false
12197
- *
12198
12234
  * Disables prompting the user for print settings.
12235
+ *
12236
+ * @default false
12199
12237
  */
12200
12238
  silent?: boolean;
12201
12239
  /**
12202
- * @defaultValue false
12203
- *
12204
12240
  * Includes the webpage background color and image when printing.
12241
+ *
12242
+ * @default false
12205
12243
  */
12206
12244
  printBackground?: boolean;
12207
12245
  /**
@@ -12209,9 +12247,9 @@ declare type PrintOptions = {
12209
12247
  */
12210
12248
  deviceName?: string;
12211
12249
  /**
12212
- * @defaultValue true
12213
- *
12214
12250
  * Prints in full color (greyscale otherwise).
12251
+ *
12252
+ * @default true
12215
12253
  */
12216
12254
  color?: boolean;
12217
12255
  /**
@@ -12219,9 +12257,9 @@ declare type PrintOptions = {
12219
12257
  */
12220
12258
  margins?: Margins;
12221
12259
  /**
12222
- * @defaultValue true
12223
- *
12224
12260
  * Prints in landscape mode (portrait otherwise).
12261
+ *
12262
+ * @default true
12225
12263
  */
12226
12264
  landscape?: boolean;
12227
12265
  /**
@@ -13402,15 +13440,15 @@ declare type ReplaceViewPayload = {
13402
13440
  */
13403
13441
  declare type ResizeRegion = {
13404
13442
  /**
13405
- * @defaultValue 7
13406
- *
13407
13443
  * The size of the resize region in pixels.
13444
+ *
13445
+ * @default 7
13408
13446
  */
13409
13447
  size?: number;
13410
13448
  /**
13411
- * @defaultValue 9
13412
- *
13413
13449
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13450
+ *
13451
+ * @default 9
13414
13452
  */
13415
13453
  bottomRightCorner?: number;
13416
13454
  /**
@@ -13418,27 +13456,27 @@ declare type ResizeRegion = {
13418
13456
  */
13419
13457
  sides?: {
13420
13458
  /**
13421
- * @defaultValue true
13422
- *
13423
13459
  * Enables resizing from the top of the window.
13460
+ *
13461
+ * @default true
13424
13462
  */
13425
13463
  top?: boolean;
13426
13464
  /**
13427
- * @defaultValue true
13428
- *
13429
13465
  * Enables resizing from the bottom of the window.
13466
+ *
13467
+ * @default true
13430
13468
  */
13431
13469
  bottom?: boolean;
13432
13470
  /**
13433
- * @defaultValue true
13434
- *
13435
13471
  * Enables resizing from the left side of the window.
13472
+ *
13473
+ * @default true
13436
13474
  */
13437
13475
  left?: boolean;
13438
13476
  /**
13439
- * @defaultValue true
13440
- *
13441
13477
  * Enables resizing from the right side of the window.
13478
+ *
13479
+ * @default true
13442
13480
  */
13443
13481
  right?: boolean;
13444
13482
  };
@@ -13990,9 +14028,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13990
14028
  */
13991
14029
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13992
14030
  /**
13993
- * @defaultValue 0
13994
- *
13995
14031
  * Number of milliseconds to wait between view repaints.
14032
+ *
14033
+ * @default 0
13996
14034
  */
13997
14035
  paintIntervalMs?: number;
13998
14036
  };
@@ -16036,9 +16074,9 @@ declare type TransitionBase = {
16036
16074
  */
16037
16075
  duration: number;
16038
16076
  /**
16039
- * @defaultValue false
16040
- *
16041
16077
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16078
+ *
16079
+ * @default false
16042
16080
  */
16043
16081
  relative?: boolean;
16044
16082
  };
@@ -16054,9 +16092,9 @@ declare type TransitionOptions = {
16054
16092
  */
16055
16093
  interrupt: boolean;
16056
16094
  /**
16057
- * @defaultValue false
16058
- *
16059
16095
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16096
+ *
16097
+ * @default false
16060
16098
  */
16061
16099
  relative?: boolean;
16062
16100
  tween?: tween;
@@ -17090,9 +17128,9 @@ declare type ViewTitlePriority = 'document' | 'options';
17090
17128
  */
17091
17129
  declare type ViewVisibilityOption = {
17092
17130
  /**
17093
- * @defaultValue false
17094
- *
17095
17131
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17132
+ *
17133
+ * @default false
17096
17134
  */
17097
17135
  enabled?: boolean;
17098
17136
  };