@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.
package/out/fdc3-api.d.ts CHANGED
@@ -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
  /**
@@ -1181,19 +1181,19 @@ declare class ApplicationModule extends Base {
1181
1181
  */
1182
1182
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1183
1183
  /**
1184
- * @defaultValue false
1185
- *
1186
1184
  * Disables IAB secure logging for the app.
1185
+ *
1186
+ * @default false
1187
1187
  */
1188
1188
  disableIabSecureLogging: boolean;
1189
1189
  /**
1190
- * @defaultValue 'There was an error loading the application.'
1191
- *
1192
1190
  * An error message to display when the application (launched via manifest) fails to load.
1193
1191
  * A dialog box will be launched with the error message just before the runtime exits.
1194
1192
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1195
1193
  * will trigger this dialog.
1196
1194
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1195
+ *
1196
+ * @default 'There was an error loading the application.'
1197
1197
  */
1198
1198
  loadErrorMessage: string;
1199
1199
  /**
@@ -1212,28 +1212,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1212
1212
  */
1213
1213
  name: string;
1214
1214
  /**
1215
- * @defaultValue false
1216
- *
1217
1215
  * A flag to configure the application as non-persistent.
1218
1216
  * Runtime exits when there are no persistent apps running.
1217
+ *
1218
+ * @default false
1219
1219
  */
1220
1220
  nonPersistent: boolean;
1221
1221
  /**
1222
- * @defaultValue false
1223
- *
1224
1222
  * Enable Flash at the application level.
1223
+ *
1224
+ * @default false
1225
1225
  */
1226
1226
  plugins: boolean;
1227
1227
  /**
1228
- * @defaultValue false
1229
- *
1230
1228
  * Enable spell check at the application level.
1229
+ *
1230
+ * @default false
1231
1231
  */
1232
1232
  spellCheck: boolean;
1233
1233
  /**
1234
- * @defaultValue 'about:blank'
1235
- *
1236
1234
  * The url to the application (specifically the application's main window).
1235
+ *
1236
+ * @default 'about:blank'
1237
1237
  */
1238
1238
  url: string;
1239
1239
  /**
@@ -1242,9 +1242,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1242
1242
  */
1243
1243
  uuid: string;
1244
1244
  /**
1245
- * @defaultValue true
1246
- *
1247
1245
  * When set to `false` it will disable the same-origin policy for the app.
1246
+ *
1247
+ * @default true
1248
1248
  */
1249
1249
  webSecurity: boolean;
1250
1250
  /**
@@ -1254,10 +1254,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1254
1254
  commands: ShortcutOverride[];
1255
1255
  isPlatformController: boolean;
1256
1256
  /**
1257
- * @defaultValue 1000
1258
- *
1259
1257
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1260
1258
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1259
+ *
1260
+ * @default 1000
1261
1261
  */
1262
1262
  maxViewPoolSize: number;
1263
1263
  /**
@@ -1273,12 +1273,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1273
1273
  */
1274
1274
  snapshot: Snapshot;
1275
1275
  /**
1276
- * @defaultValue false
1277
- *
1278
1276
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1279
1277
  *
1280
1278
  * Note: if the Platform Provider is showing, it won't close automatically.
1281
1279
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1280
+ *
1281
+ * @default false
1282
1282
  */
1283
1283
  preventQuitOnLastWindowClosed: boolean;
1284
1284
  /**
@@ -1286,9 +1286,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1286
1286
  */
1287
1287
  interopBrokerConfiguration: InteropBrokerOptions;
1288
1288
  /**
1289
- * @defaultValue true
1290
- *
1291
1289
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1290
+ *
1291
+ * @default true
1292
1292
  */
1293
1293
  apiDiagnostics: boolean;
1294
1294
  /**
@@ -1304,16 +1304,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1304
1304
  */
1305
1305
  permissions?: Partial<Permissions_2>;
1306
1306
  /**
1307
- * @defaultValue false
1308
- *
1309
1307
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1310
1308
  * Only relevant in Windows.
1309
+ *
1310
+ * @default false
1311
1311
  */
1312
1312
  enableJumpList: boolean;
1313
1313
  /**
1314
- * @defaultValue false
1315
- *
1316
1314
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1315
+ *
1316
+ * @default false
1317
1317
  */
1318
1318
  enableBeforeUnload: boolean;
1319
1319
  /**
@@ -1394,25 +1394,25 @@ declare type ApplicationWindowInfo = {
1394
1394
  */
1395
1395
  declare type ApplySnapshotOptions = {
1396
1396
  /**
1397
- * @defaultValue false
1398
- *
1399
1397
  * When true, applySnapshot will close existing windows,
1400
1398
  * replacing current Platform state with the given snapshot.
1399
+ *
1400
+ * @default false
1401
1401
  */
1402
1402
  closeExistingWindows?: boolean;
1403
1403
  /**
1404
- * @defaultValue false
1405
- *
1406
1404
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1407
1405
  * replacing current Platform state with the given snapshot.
1406
+ *
1407
+ * @default false
1408
1408
  */
1409
1409
  closeSnapshotWindows?: boolean;
1410
1410
  /**
1411
- * @defaultValue false
1412
- *
1413
1411
  * When true, applySnapshot will not check whether any windows in a
1414
1412
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1415
1413
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1414
+ *
1415
+ * @default false
1416
1416
  */
1417
1417
  skipOutOfBoundsCheck?: boolean;
1418
1418
  };
@@ -2095,15 +2095,15 @@ declare type CapturePageOptions = {
2095
2095
  */
2096
2096
  area?: Rectangle;
2097
2097
  /**
2098
- * @defaultValue 'png'
2099
- *
2100
2098
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2099
+ *
2100
+ * @default 'png'
2101
2101
  */
2102
2102
  format?: 'bmp' | 'jpg' | 'png';
2103
2103
  /**
2104
- * @defaultValue 100
2105
- *
2106
2104
  * Quality of JPEG image. Between 0 - 100.
2105
+ *
2106
+ * @default 100
2107
2107
  */
2108
2108
  quality?: number;
2109
2109
  };
@@ -2757,9 +2757,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2757
2757
  */
2758
2758
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2759
2759
  /**
2760
- * @defaultValue true
2761
- *
2762
2760
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2761
+ *
2762
+ * @default true
2763
2763
  */
2764
2764
  wait?: boolean;
2765
2765
  /**
@@ -3056,6 +3056,10 @@ declare type ChromiumPolicies = {
3056
3056
  * Disable AutofillAddressEnabled policy for a Window or View.
3057
3057
  */
3058
3058
  AutofillAddressEnabled?: PolicyOptions;
3059
+ /**
3060
+ * Disable AutofillCreditCardEnabled policy for a Window or View.
3061
+ */
3062
+ AutofillCreditCardEnabled?: PolicyOptions;
3059
3063
  };
3060
3064
 
3061
3065
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3421,9 +3425,9 @@ declare interface CloseWindowPayload {
3421
3425
  windowId: Identity_4;
3422
3426
  options: {
3423
3427
  /**
3424
- * @defaultValue false
3425
- *
3426
3428
  * When set to true skips any before handler set on views that are part of the window
3429
+ *
3430
+ * @default false
3427
3431
  */
3428
3432
  skipBeforeUnload?: boolean;
3429
3433
  };
@@ -3531,9 +3535,9 @@ declare type ConstViewOptions = {
3531
3535
  */
3532
3536
  name: string;
3533
3537
  /**
3534
- * @defaultValue "about:blank"
3535
- *
3536
3538
  * The URL of the window
3539
+ *
3540
+ * @default "about:blank"
3537
3541
  */
3538
3542
  url: string;
3539
3543
  /**
@@ -3558,6 +3562,15 @@ declare type ConstViewOptions = {
3558
3562
  * Custom headers for requests sent by the view.
3559
3563
  */
3560
3564
  customRequestHeaders: CustomRequestHeaders[];
3565
+ /**
3566
+ * @experimental
3567
+ *
3568
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
3569
+ * These css properties are used to enable dragging of a frameless window.
3570
+ *
3571
+ * @default false
3572
+ */
3573
+ disableAppRegion: boolean;
3561
3574
  /**
3562
3575
  * Initial bounds given relative to the window.
3563
3576
  */
@@ -3594,9 +3607,9 @@ declare type ConstViewOptions = {
3594
3607
  experimental: any;
3595
3608
  fdc3InteropApi?: string;
3596
3609
  /**
3597
- * @defaultValue false
3598
- *
3599
3610
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3611
+ *
3612
+ * @default false
3600
3613
  */
3601
3614
  enableBeforeUnload: boolean;
3602
3615
  /**
@@ -3677,13 +3690,12 @@ declare type ConstWindowOptions = {
3677
3690
  */
3678
3691
  backgroundColor: string;
3679
3692
  /**
3680
- * @defaultValue false
3681
- *
3682
3693
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3683
3694
  * This also affects the Page Visibility API.
3684
3695
  *
3685
3696
  * When `true`, the page is throttled whether it is hidden or not.
3686
3697
  *
3698
+ * @default false
3687
3699
  */
3688
3700
  backgroundThrottling: boolean;
3689
3701
  /**
@@ -3707,21 +3719,30 @@ declare type ConstWindowOptions = {
3707
3719
  */
3708
3720
  customRequestHeaders: CustomRequestHeaders[];
3709
3721
  /**
3710
- * @defaultValue true
3711
- *
3712
3722
  * Setting this to false would keep the Window alive even if all its Views were closed.
3713
3723
  * This is meant for advanced users and should be used with caution.
3714
3724
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3715
3725
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3716
3726
  * **NOTE:** - This option is ignored in non-Platforms apps.
3727
+ *
3728
+ * @default true
3717
3729
  */
3718
3730
  closeOnLastViewRemoved: boolean;
3719
3731
  /**
3720
- * @defaultValue 'all'
3732
+ * @experimental
3721
3733
  *
3734
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
3735
+ * These css properties are used to enable dragging of a frameless window.
3736
+ *
3737
+ * @default false
3738
+ */
3739
+ disableAppRegion: boolean;
3740
+ /**
3722
3741
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3723
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3742
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3724
3743
  * **NOTE:** - This option is ignored in non-Platforms apps.
3744
+ *
3745
+ * @default 'all'
3725
3746
  */
3726
3747
  viewsPreventingClose: 'all' | 'layout';
3727
3748
  /**
@@ -3732,31 +3753,31 @@ declare type ConstWindowOptions = {
3732
3753
  */
3733
3754
  defaultCentered: boolean;
3734
3755
  /**
3735
- * @defaultValue 500
3736
- *
3737
3756
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3738
3757
  * in favor of the cached value.
3758
+ *
3759
+ * @default 500
3739
3760
  */
3740
3761
  defaultHeight: number;
3741
3762
  /**
3742
- * @defaultValue 100
3743
- *
3744
3763
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3745
3764
  * launches in favor of the cached value.
3765
+ *
3766
+ * @default 100
3746
3767
  */
3747
3768
  defaultLeft: number;
3748
3769
  /**
3749
- * @defaultValue 100
3750
- *
3751
3770
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3752
3771
  * launches in favor of the cached value.
3772
+ *
3773
+ * @default 100
3753
3774
  */
3754
3775
  defaultTop: number;
3755
3776
  /**
3756
- * @defaultValue 800
3757
- *
3758
3777
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3759
3778
  * launches in favor of the cached value.
3779
+ *
3780
+ * @default 800
3760
3781
  */
3761
3782
  defaultWidth: number;
3762
3783
  /**
@@ -3802,19 +3823,19 @@ declare type ConstWindowOptions = {
3802
3823
  */
3803
3824
  processAffinity: string;
3804
3825
  /**
3805
- * @defaultValue false
3806
- *
3807
3826
  * Displays a shadow on frameless windows.
3808
3827
  * `shadow` and `cornerRounding` are mutually exclusive.
3809
3828
  * On Windows 7, Aero theme is required.
3829
+ *
3830
+ * @default false
3810
3831
  */
3811
3832
  shadow: boolean;
3812
3833
  /**
3813
- * @defaultValue true
3814
- *
3815
3834
  * Caches the location of the window.
3816
3835
  *
3817
3836
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3837
+ *
3838
+ * @default true
3818
3839
  */
3819
3840
  saveWindowState: boolean;
3820
3841
  /**
@@ -3823,22 +3844,22 @@ declare type ConstWindowOptions = {
3823
3844
  */
3824
3845
  ignoreSavedWindowState: boolean;
3825
3846
  /**
3826
- * @defaultValue false
3827
- *
3828
3847
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3829
3848
  *
3830
3849
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3831
3850
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3851
+ *
3852
+ * @default false
3832
3853
  */
3833
3854
  smallWindow: boolean;
3834
3855
  /**
3835
- * @defaultValue "normal"
3836
- *
3837
3856
  * The visible state of the window on creation.
3838
3857
  * One of:
3839
3858
  * * `"maximized"`
3840
3859
  * * `"minimized"`
3841
3860
  * * `"normal"`
3861
+ *
3862
+ * @default "normal"
3842
3863
  */
3843
3864
  state: WindowState;
3844
3865
  /**
@@ -3853,26 +3874,26 @@ declare type ConstWindowOptions = {
3853
3874
  */
3854
3875
  taskbarIconGroup: string;
3855
3876
  /**
3856
- * @defaultValue "about:blank"
3857
- *
3858
3877
  * The URL of the window
3878
+ *
3879
+ * @default "about:blank"
3859
3880
  */
3860
3881
  url: string;
3861
3882
  /**
3862
- * @defaultValue <application UUID>
3863
- *
3864
3883
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3865
3884
  * If omitted, defaults to the `uuid` of the application spawning the window.
3866
3885
  * If given, must match the `uuid` of the application spawning the window.
3867
3886
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3868
3887
  * really no need to provide it.
3888
+ *
3889
+ * @default <application UUID>
3869
3890
  */
3870
3891
  uuid: string;
3871
3892
  /**
3872
- * @defaultValue false
3873
- *
3874
3893
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3875
3894
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3895
+ *
3896
+ * @default false
3876
3897
  */
3877
3898
  waitForPageLoad: boolean;
3878
3899
  width: number;
@@ -3892,6 +3913,10 @@ declare type ConstWindowOptions = {
3892
3913
  * Control which options to ignore when creating a Platform Window.
3893
3914
  */
3894
3915
  excludeOptions: ExcludeOptions;
3916
+ /**
3917
+ * 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.
3918
+ */
3919
+ roundedCorners: boolean;
3895
3920
  };
3896
3921
 
3897
3922
  /**
@@ -4154,13 +4179,13 @@ declare type CopyBlockedEventReason = 'disabled';
4154
4179
  */
4155
4180
  declare type CopyPermissions = {
4156
4181
  /**
4157
- * @defaultValue 'allowed'
4158
- *
4159
4182
  * Controls the behavior for copy operations for a matched URL.
4160
4183
  *
4161
4184
  * allow: Enables all copy operations.
4162
4185
  * block: Disables all copy operations.
4163
4186
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4187
+ *
4188
+ * @default 'allowed'
4164
4189
  */
4165
4190
  behavior: 'allow' | 'block' | 'protect';
4166
4191
  /**
@@ -4168,9 +4193,9 @@ declare type CopyPermissions = {
4168
4193
  */
4169
4194
  options?: {
4170
4195
  /**
4171
- * @defaultValue ''
4172
- *
4173
4196
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4197
+ *
4198
+ * @default ''
4174
4199
  */
4175
4200
  replacementText: string;
4176
4201
  };
@@ -4184,15 +4209,15 @@ declare type CopyPermissions = {
4184
4209
  */
4185
4210
  declare type CornerRounding = {
4186
4211
  /**
4187
- * @defaultValue 0
4188
- *
4189
4212
  * The height in pixels.
4213
+ *
4214
+ * @default 0
4190
4215
  */
4191
4216
  height: number;
4192
4217
  /**
4193
- * @defaultValue 0
4194
- *
4195
4218
  * The width in pixels.
4219
+ *
4220
+ * @default 0
4196
4221
  */
4197
4222
  width: number;
4198
4223
  };
@@ -4282,8 +4307,6 @@ declare type CreateLayoutOptions = {
4282
4307
  layoutName: string;
4283
4308
  layout: LayoutOptions;
4284
4309
  /**
4285
- * @defaultValue 'default'
4286
- *
4287
4310
  * Controls the View behavior for the given `layout` property. Note
4288
4311
  * that the selected behavior only applies to unnamed Views or
4289
4312
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4305,6 +4328,8 @@ declare type CreateLayoutOptions = {
4305
4328
  * override. Note that during applyLayoutSnapshot, Views are created and
4306
4329
  * attached to the Provider while the Window is being created, so it's
4307
4330
  * important to not 'duplicate' Views in this workflow.
4331
+ *
4332
+ * @default 'default'
4308
4333
  */
4309
4334
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4310
4335
  };
@@ -4563,7 +4588,7 @@ declare type DomainApiSettings = {
4563
4588
  * * 'none': The `fin` API will be not available.
4564
4589
  * * 'global': The entire `fin` API will be available.
4565
4590
  *
4566
- * @defaultValue 'global'
4591
+ * @default 'global'
4567
4592
  */
4568
4593
  fin?: InjectionType;
4569
4594
  /**
@@ -5162,9 +5187,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5162
5187
  */
5163
5188
  declare type ExcludeOptions = {
5164
5189
  /**
5165
- * @defaultValue false
5166
- *
5167
5190
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5191
+ *
5192
+ * @default false
5168
5193
  */
5169
5194
  preloadScripts: boolean;
5170
5195
  };
@@ -5995,34 +6020,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
5995
6020
  */
5996
6021
  declare type FindInPageOptions = {
5997
6022
  /**
5998
- * @defaultValue true
5999
- *
6000
6023
  * Searches in the forward direction (backward otherwise)
6024
+ *
6025
+ * @default true
6001
6026
  */
6002
6027
  forward?: boolean;
6003
6028
  /**
6004
- * @defaultValue false
6005
- *
6006
6029
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
6030
+ *
6031
+ * @default false
6007
6032
  */
6008
6033
  findNext?: boolean;
6009
6034
  /**
6010
- * @defaultValue false
6011
- *
6012
6035
  * Enables case-sensitive searching.
6036
+ *
6037
+ * @default false
6013
6038
  */
6014
6039
  matchCase?: boolean;
6015
6040
  /**
6016
- * @defaultValue false
6017
- *
6018
6041
  * Only searches from the start of words.
6042
+ *
6043
+ * @default false
6019
6044
  */
6020
6045
  wordStart?: boolean;
6021
6046
  /**
6022
- * @defaultValue false
6023
- *
6024
6047
  * 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>
6025
6048
  * lowercase or non-letter. Accepts several other intra-word matches.
6049
+ *
6050
+ * @default false
6026
6051
  */
6027
6052
  medialCapitalAsWordStart?: boolean;
6028
6053
  };
@@ -6536,9 +6561,9 @@ declare type Hotkey = {
6536
6561
  */
6537
6562
  keys: string;
6538
6563
  /**
6539
- * @defaultValue false
6540
- *
6541
6564
  * Prevent default key handling before emitting the event.
6565
+ *
6566
+ * @default false
6542
6567
  */
6543
6568
  preventDefault?: boolean;
6544
6569
  };
@@ -9100,77 +9125,79 @@ declare type LayoutOptions = {
9100
9125
  */
9101
9126
  newTabButtonUrl?: string;
9102
9127
  /**
9103
- * @defaultValue false
9104
- *
9105
9128
  * When true the splitters will not be draggable and the layout will not resize.
9129
+ *
9130
+ * @default false
9106
9131
  */
9107
9132
  preventSplitterResize?: boolean;
9108
9133
  /**
9109
- * @defaultValue false
9110
- *
9111
9134
  * Whether the popout button will only act on the entire stack,
9112
9135
  * as opposed to only the active tab.
9136
+ *
9137
+ * @default false
9113
9138
  */
9114
9139
  popoutWholeStack?: boolean;
9115
9140
  /**
9116
- * @defaultValue false
9117
- *
9118
9141
  * Limits the area to which tabs can be dragged.
9119
9142
  * If true, the layout container is the only area where tabs can be dropped.
9143
+ *
9144
+ * @default false
9120
9145
  */
9121
9146
  constrainDragToContainer?: boolean;
9122
9147
  /**
9123
- * @defaultValue false
9124
- *
9125
9148
  * Whether to show the popout button on stack header.
9126
9149
  * The button will create a new window with current tab as its content.
9127
9150
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
9151
+ *
9152
+ * @default false
9128
9153
  */
9129
9154
  showPopoutIcon?: boolean;
9130
9155
  /**
9131
- * @defaultValue false
9132
- *
9133
9156
  * Whether to show the maximize button on stack header.
9134
9157
  * The button will maximize the current tab to fill the entire window.
9158
+ *
9159
+ * @default false
9135
9160
  */
9136
9161
  showMaximiseIcon?: boolean;
9137
9162
  /**
9138
- * @defaultValue false
9139
- *
9140
9163
  * Whether to show the close button on stack header
9141
9164
  * (not to be confused with close button on every tab).
9165
+ *
9166
+ * @default false
9142
9167
  */
9143
9168
  showCloseIcon?: boolean;
9144
9169
  /**
9145
- * @defaultValue false
9146
- *
9147
9170
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
9171
+ *
9172
+ * @default false
9148
9173
  */
9149
9174
  constrainDragToHeaders?: boolean;
9150
9175
  /**
9151
- * @defaultValue true
9152
- *
9153
9176
  * Turns tab headers on or off.
9154
9177
  * If false, the layout will be displayed with splitters only.
9178
+ *
9179
+ * @default true
9155
9180
  */
9156
9181
  hasHeaders?: boolean;
9157
9182
  /**
9158
- * @defaultValue true
9159
- *
9160
9183
  * If true, the user can re-arrange the layout by
9161
9184
  * dragging items by their tabs to the desired location.
9185
+ *
9186
+ * @default true
9162
9187
  */
9163
9188
  reorderEnabled?: boolean;
9164
9189
  /**
9165
- * @defaultValue false
9166
- *
9167
9190
  * If true, tabs can't be dragged out of the window.
9191
+ *
9192
+ * @default false
9168
9193
  */
9169
9194
  preventDragOut?: boolean;
9170
9195
  /**
9171
9196
  * @defaultValue=false
9172
9197
  *
9173
9198
  * If true, tabs can't be dragged into the window.
9199
+ *
9200
+ * @default false
9174
9201
  */
9175
9202
  preventDragIn?: boolean;
9176
9203
  };
@@ -9622,10 +9649,10 @@ declare type MutableViewOptions = {
9622
9649
  /**
9623
9650
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9624
9651
  *
9625
- * @defaultValue true
9626
- *
9627
9652
  * Show the context menu when right-clicking on the view.
9628
9653
  * Gives access to the devtools for the view.
9654
+ *
9655
+ * @default true
9629
9656
  */
9630
9657
  contextMenu: boolean;
9631
9658
  /**
@@ -9672,24 +9699,25 @@ declare type MutableViewOptions = {
9672
9699
  contentNavigation: ContentNavigation;
9673
9700
  contentRedirect: ContentRedirect;
9674
9701
  /**
9675
- * @defaultValue false
9676
9702
  * @deprecated
9677
9703
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9678
9704
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9705
+ *
9706
+ * @default false
9679
9707
  */
9680
9708
  detachOnClose: boolean;
9681
9709
  /**
9682
- * @defaultValue true
9683
- *
9684
9710
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9685
9711
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9686
9712
  * if the view isn't part of the new layout when running `Layout.replace`.
9713
+ *
9714
+ * @default true
9687
9715
  */
9688
9716
  isClosable: boolean;
9689
9717
  /**
9690
- * @defaultValue false
9691
- *
9692
9718
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9719
+ *
9720
+ * @default false
9693
9721
  */
9694
9722
  preventDragOut: boolean;
9695
9723
  interop?: InteropConfig;
@@ -9701,7 +9729,7 @@ declare type MutableViewOptions = {
9701
9729
  /**
9702
9730
  * {@inheritDoc ViewThrottling}
9703
9731
  *
9704
- * @defaultValue 'enabled'
9732
+ * @default 'enabled'
9705
9733
  */
9706
9734
  throttling: ViewThrottling;
9707
9735
  /**
@@ -9720,7 +9748,7 @@ declare type MutableWindowOptions = {
9720
9748
  * Turns anything of matching RGB value transparent.
9721
9749
  *
9722
9750
  * Caveats:
9723
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9751
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9724
9752
  * * User cannot click-through transparent regions
9725
9753
  * * Not supported on Mac
9726
9754
  * * Windows Aero must be enabled
@@ -9729,25 +9757,25 @@ declare type MutableWindowOptions = {
9729
9757
  */
9730
9758
  alphaMask: RGB;
9731
9759
  /**
9732
- * @defaultValue false
9733
- *
9734
9760
  * Always position the window at the top of the window stack.
9761
+ *
9762
+ * @default false
9735
9763
  */
9736
9764
  alwaysOnTop: boolean;
9737
9765
  /**
9738
- * @defaultValue 0
9739
- *
9740
9766
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9741
9767
  * an aspect ratio will not be enforced.
9768
+ *
9769
+ * @default 0
9742
9770
  */
9743
9771
  aspectRatio: number;
9744
9772
  /**
9745
9773
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9746
9774
  *
9747
- * @defaultValue true
9748
- *
9749
9775
  * Show the context menu when right-clicking on the window.
9750
9776
  * Gives access to the devtools for the window.
9777
+ *
9778
+ * @default true
9751
9779
  */
9752
9780
  contextMenu: boolean;
9753
9781
  /**
@@ -9814,15 +9842,18 @@ declare type MutableWindowOptions = {
9814
9842
  */
9815
9843
  customData: any;
9816
9844
  /**
9845
+ * @deprecated Will be removed in runtime version 45
9817
9846
  * @defaultValue true
9818
9847
  *
9819
9848
  * Show the window's frame.
9849
+ *
9850
+ * @default true
9820
9851
  */
9821
9852
  frame: boolean;
9822
9853
  /**
9823
- * @defaultValue false
9824
- *
9825
9854
  * Hides the window instead of closing it when the close button is pressed.
9855
+ *
9856
+ * @default false
9826
9857
  */
9827
9858
  hideOnClose: boolean;
9828
9859
  /**
@@ -9875,60 +9906,61 @@ declare type MutableWindowOptions = {
9875
9906
  */
9876
9907
  icon: string;
9877
9908
  /**
9878
- * @defaultValue true
9879
- *
9880
9909
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9881
9910
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9911
+ *
9912
+ * @default true
9882
9913
  */
9883
9914
  includeInSnapshots: boolean;
9884
9915
  /**
9885
- * @defaultValue -1
9886
- *
9887
9916
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9917
+ *
9918
+ * @default -1
9888
9919
  */
9889
9920
  maxHeight: number;
9890
9921
  /**
9891
- * @defaultValue true
9892
- *
9893
9922
  * Allows the window to be maximized.
9923
+ *
9924
+ * @default true
9894
9925
  */
9895
9926
  maximizable: boolean;
9896
9927
  /**
9897
- * @defaultValue -1
9898
- *
9899
9928
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9929
+ *
9930
+ * @default -1
9900
9931
  */
9901
9932
  maxWidth: number;
9902
9933
  /**
9903
- * @defaultValue 0
9904
- *
9905
9934
  * The minimum height of the window.
9935
+ *
9936
+ * @default 0
9906
9937
  */
9907
9938
  minHeight: number;
9908
9939
  /**
9909
- * @defaultValue true
9910
- *
9911
9940
  * Allows the window to be minimized.
9941
+ *
9942
+ * @default true
9912
9943
  */
9913
9944
  minimizable: boolean;
9914
9945
  /**
9915
- * @defaultValue true
9916
- *
9917
9946
  * The minimum width of the window.
9947
+ *
9948
+ * @default true
9918
9949
  */
9919
9950
  minWidth: number;
9920
9951
  /**
9921
- * @defaultValue 1
9922
- *
9923
9952
  * A flag that specifies how transparent the window will be.
9924
9953
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9925
9954
  * This value is clamped between `0.0` and `1.0`.
9955
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9956
+ *
9957
+ * @default 1
9926
9958
  */
9927
9959
  opacity: number;
9928
9960
  /**
9929
- * @defaultValue true
9930
- *
9931
9961
  * A flag to allow the user to resize the window.
9962
+ *
9963
+ * @default true
9932
9964
  */
9933
9965
  resizable: boolean;
9934
9966
  /**
@@ -9936,16 +9968,22 @@ declare type MutableWindowOptions = {
9936
9968
  */
9937
9969
  resizeRegion: ResizeRegion;
9938
9970
  /**
9939
- * @defaultValue false
9940
- *
9941
9971
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9942
9972
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9973
+ *
9974
+ * @default false
9943
9975
  */
9944
9976
  showBackgroundImages: boolean;
9945
9977
  /**
9946
- * @defaultValue true
9947
- *
9948
9978
  * Shows the window's icon in the taskbar.
9979
+ *
9980
+ * @remarks
9981
+ * In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
9982
+ * In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
9983
+ * `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
9984
+ * {@link Window._Window.showPopupWindow}.
9985
+ *
9986
+ * @default true
9949
9987
  */
9950
9988
  showTaskbarIcon: boolean;
9951
9989
  /**
@@ -9972,7 +10010,7 @@ declare type MutableWindowOptions = {
9972
10010
  /**
9973
10011
  * {@inheritDoc WindowThrottling}
9974
10012
  *
9975
- * @defaultValue 'enabled'
10013
+ * @default 'enabled'
9976
10014
  *
9977
10015
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9978
10016
  */
@@ -10592,12 +10630,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10592
10630
  */
10593
10631
  declare type PastePermissions = {
10594
10632
  /**
10595
- * @defaultValue 'non-protected-content'
10596
- *
10597
10633
  * Controls the behavior for paste operations for a matched URL.
10598
10634
  *
10599
10635
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10600
10636
  * 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.
10637
+ *
10638
+ * @default 'non-protected-content'
10601
10639
  */
10602
10640
  behavior: 'non-protected-content' | 'all-content';
10603
10641
  };
@@ -11666,11 +11704,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11666
11704
  */
11667
11705
  providerUrl?: string;
11668
11706
  /**
11669
- * @defaultValue true
11670
- *
11671
11707
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11672
11708
  *
11673
11709
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11710
+ *
11711
+ * @default true
11674
11712
  */
11675
11713
  allowLaunchIntoPlatform?: boolean;
11676
11714
  };
@@ -12359,22 +12397,22 @@ declare type PopupOptions = {
12359
12397
  url?: string;
12360
12398
  /**
12361
12399
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
12362
- * @defaultValue 300
12400
+ * @default 300
12363
12401
  */
12364
12402
  height?: number;
12365
12403
  /**
12366
12404
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
12367
- * @defaultValue 300
12405
+ * @default 300
12368
12406
  */
12369
12407
  width?: number;
12370
12408
  /**
12371
12409
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12372
- * @defaultValue 0
12410
+ * @default 0
12373
12411
  */
12374
12412
  x?: number;
12375
12413
  /**
12376
12414
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12377
- * @defaultValue 0
12415
+ * @default 0
12378
12416
  */
12379
12417
  y?: number;
12380
12418
  /**
@@ -12382,7 +12420,7 @@ declare type PopupOptions = {
12382
12420
  * * 'modal' restricts resizing and positioning in the caller.
12383
12421
  * * 'hide' hides the popup window on blur.
12384
12422
  * * 'close' closes the popup window on blur.
12385
- * @defaultValue 'close'
12423
+ * @default 'close'
12386
12424
  */
12387
12425
  blurBehavior?: PopupBlurBehavior;
12388
12426
  /**
@@ -12390,19 +12428,19 @@ declare type PopupOptions = {
12390
12428
  * * 'none' will do nothing.
12391
12429
  * * 'hide' hides the popup window on `dispatchPopupResult`.
12392
12430
  * * 'close' closes the popup window on `dispatchPopupResult`.
12393
- * @defaultValue 'close'
12431
+ * @default 'close'
12394
12432
  */
12395
12433
  resultDispatchBehavior?: PopupResultBehavior;
12396
12434
  /**
12397
12435
  * Hide the popup window instead of closing when `close` is called on it.
12398
12436
  *
12399
12437
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
12400
- * @defaultValue false
12438
+ * @default false
12401
12439
  */
12402
12440
  hideOnClose?: boolean;
12403
12441
  /**
12404
12442
  * Determines if the popup window should or should not be focused when it is shown.
12405
- * @defaultValue true
12443
+ * @default true
12406
12444
  */
12407
12445
  focus?: boolean;
12408
12446
  /**
@@ -12496,9 +12534,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12496
12534
  */
12497
12535
  declare type PreloadScript = {
12498
12536
  /**
12499
- * @defaultValue false
12500
- *
12501
12537
  * Fail to load the window if this preload script fails
12538
+ *
12539
+ * @default false
12502
12540
  */
12503
12541
  mandatory?: boolean;
12504
12542
  /**
@@ -12594,15 +12632,15 @@ declare type PrinterInfo = {
12594
12632
  declare type PrintOptions = {
12595
12633
  content?: 'self';
12596
12634
  /**
12597
- * @defaultValue false
12598
- *
12599
12635
  * Disables prompting the user for print settings.
12636
+ *
12637
+ * @default false
12600
12638
  */
12601
12639
  silent?: boolean;
12602
12640
  /**
12603
- * @defaultValue false
12604
- *
12605
12641
  * Includes the webpage background color and image when printing.
12642
+ *
12643
+ * @default false
12606
12644
  */
12607
12645
  printBackground?: boolean;
12608
12646
  /**
@@ -12610,9 +12648,9 @@ declare type PrintOptions = {
12610
12648
  */
12611
12649
  deviceName?: string;
12612
12650
  /**
12613
- * @defaultValue true
12614
- *
12615
12651
  * Prints in full color (greyscale otherwise).
12652
+ *
12653
+ * @default true
12616
12654
  */
12617
12655
  color?: boolean;
12618
12656
  /**
@@ -12620,9 +12658,9 @@ declare type PrintOptions = {
12620
12658
  */
12621
12659
  margins?: Margins;
12622
12660
  /**
12623
- * @defaultValue true
12624
- *
12625
12661
  * Prints in landscape mode (portrait otherwise).
12662
+ *
12663
+ * @default true
12626
12664
  */
12627
12665
  landscape?: boolean;
12628
12666
  /**
@@ -13803,15 +13841,15 @@ declare type ReplaceViewPayload = {
13803
13841
  */
13804
13842
  declare type ResizeRegion = {
13805
13843
  /**
13806
- * @defaultValue 7
13807
- *
13808
13844
  * The size of the resize region in pixels.
13845
+ *
13846
+ * @default 7
13809
13847
  */
13810
13848
  size?: number;
13811
13849
  /**
13812
- * @defaultValue 9
13813
- *
13814
13850
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13851
+ *
13852
+ * @default 9
13815
13853
  */
13816
13854
  bottomRightCorner?: number;
13817
13855
  /**
@@ -13819,27 +13857,27 @@ declare type ResizeRegion = {
13819
13857
  */
13820
13858
  sides?: {
13821
13859
  /**
13822
- * @defaultValue true
13823
- *
13824
13860
  * Enables resizing from the top of the window.
13861
+ *
13862
+ * @default true
13825
13863
  */
13826
13864
  top?: boolean;
13827
13865
  /**
13828
- * @defaultValue true
13829
- *
13830
13866
  * Enables resizing from the bottom of the window.
13867
+ *
13868
+ * @default true
13831
13869
  */
13832
13870
  bottom?: boolean;
13833
13871
  /**
13834
- * @defaultValue true
13835
- *
13836
13872
  * Enables resizing from the left side of the window.
13873
+ *
13874
+ * @default true
13837
13875
  */
13838
13876
  left?: boolean;
13839
13877
  /**
13840
- * @defaultValue true
13841
- *
13842
13878
  * Enables resizing from the right side of the window.
13879
+ *
13880
+ * @default true
13843
13881
  */
13844
13882
  right?: boolean;
13845
13883
  };
@@ -14391,9 +14429,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
14391
14429
  */
14392
14430
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
14393
14431
  /**
14394
- * @defaultValue 0
14395
- *
14396
14432
  * Number of milliseconds to wait between view repaints.
14433
+ *
14434
+ * @default 0
14397
14435
  */
14398
14436
  paintIntervalMs?: number;
14399
14437
  };
@@ -16450,9 +16488,9 @@ declare type TransitionBase = {
16450
16488
  */
16451
16489
  duration: number;
16452
16490
  /**
16453
- * @defaultValue false
16454
- *
16455
16491
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16492
+ *
16493
+ * @default false
16456
16494
  */
16457
16495
  relative?: boolean;
16458
16496
  };
@@ -16468,9 +16506,9 @@ declare type TransitionOptions = {
16468
16506
  */
16469
16507
  interrupt: boolean;
16470
16508
  /**
16471
- * @defaultValue false
16472
- *
16473
16509
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16510
+ *
16511
+ * @default false
16474
16512
  */
16475
16513
  relative?: boolean;
16476
16514
  tween?: tween;
@@ -17541,9 +17579,9 @@ declare type ViewTitlePriority = 'document' | 'options';
17541
17579
  */
17542
17580
  declare type ViewVisibilityOption = {
17543
17581
  /**
17544
- * @defaultValue false
17545
- *
17546
17582
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17583
+ *
17584
+ * @default false
17547
17585
  */
17548
17586
  enabled?: boolean;
17549
17587
  };