@openfin/fdc3-api 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.
@@ -136,13 +136,13 @@ declare type ApiSettings = {
136
136
  /**
137
137
  * Inject OpenFin API into cross-origin iframes
138
138
  *
139
- * @defaultValue false
139
+ * @default false
140
140
  */
141
141
  crossOriginInjection?: boolean;
142
142
  /**
143
143
  * Inject OpenFin API into same-origin iframes
144
144
  *
145
- * @defaultValue true
145
+ * @default true
146
146
  */
147
147
  sameOriginInjection?: boolean;
148
148
  /**
@@ -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
  };
@@ -2069,15 +2069,15 @@ declare type CapturePageOptions = {
2069
2069
  */
2070
2070
  area?: Rectangle;
2071
2071
  /**
2072
- * @defaultValue 'png'
2073
- *
2074
2072
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2073
+ *
2074
+ * @default 'png'
2075
2075
  */
2076
2076
  format?: 'bmp' | 'jpg' | 'png';
2077
2077
  /**
2078
- * @defaultValue 100
2079
- *
2080
2078
  * Quality of JPEG image. Between 0 - 100.
2079
+ *
2080
+ * @default 100
2081
2081
  */
2082
2082
  quality?: number;
2083
2083
  };
@@ -2710,9 +2710,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2710
2710
  */
2711
2711
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2712
2712
  /**
2713
- * @defaultValue true
2714
- *
2715
2713
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2714
+ *
2715
+ * @default true
2716
2716
  */
2717
2717
  wait?: boolean;
2718
2718
  /**
@@ -3006,6 +3006,10 @@ declare type ChromiumPolicies = {
3006
3006
  * Disable AutofillAddressEnabled policy for a Window or View.
3007
3007
  */
3008
3008
  AutofillAddressEnabled?: PolicyOptions;
3009
+ /**
3010
+ * Disable AutofillCreditCardEnabled policy for a Window or View.
3011
+ */
3012
+ AutofillCreditCardEnabled?: PolicyOptions;
3009
3013
  };
3010
3014
 
3011
3015
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3371,9 +3375,9 @@ declare interface CloseWindowPayload {
3371
3375
  windowId: Identity_4;
3372
3376
  options: {
3373
3377
  /**
3374
- * @defaultValue false
3375
- *
3376
3378
  * When set to true skips any before handler set on views that are part of the window
3379
+ *
3380
+ * @default false
3377
3381
  */
3378
3382
  skipBeforeUnload?: boolean;
3379
3383
  };
@@ -3478,9 +3482,9 @@ declare type ConstViewOptions = {
3478
3482
  */
3479
3483
  name: string;
3480
3484
  /**
3481
- * @defaultValue "about:blank"
3482
- *
3483
3485
  * The URL of the window
3486
+ *
3487
+ * @default "about:blank"
3484
3488
  */
3485
3489
  url: string;
3486
3490
  /**
@@ -3505,6 +3509,15 @@ declare type ConstViewOptions = {
3505
3509
  * Custom headers for requests sent by the view.
3506
3510
  */
3507
3511
  customRequestHeaders: CustomRequestHeaders[];
3512
+ /**
3513
+ * @experimental
3514
+ *
3515
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
3516
+ * These css properties are used to enable dragging of a frameless window.
3517
+ *
3518
+ * @default false
3519
+ */
3520
+ disableAppRegion: boolean;
3508
3521
  /**
3509
3522
  * Initial bounds given relative to the window.
3510
3523
  */
@@ -3541,9 +3554,9 @@ declare type ConstViewOptions = {
3541
3554
  experimental: any;
3542
3555
  fdc3InteropApi?: string;
3543
3556
  /**
3544
- * @defaultValue false
3545
- *
3546
3557
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3558
+ *
3559
+ * @default false
3547
3560
  */
3548
3561
  enableBeforeUnload: boolean;
3549
3562
  /**
@@ -3624,13 +3637,12 @@ declare type ConstWindowOptions = {
3624
3637
  */
3625
3638
  backgroundColor: string;
3626
3639
  /**
3627
- * @defaultValue false
3628
- *
3629
3640
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3630
3641
  * This also affects the Page Visibility API.
3631
3642
  *
3632
3643
  * When `true`, the page is throttled whether it is hidden or not.
3633
3644
  *
3645
+ * @default false
3634
3646
  */
3635
3647
  backgroundThrottling: boolean;
3636
3648
  /**
@@ -3654,21 +3666,30 @@ declare type ConstWindowOptions = {
3654
3666
  */
3655
3667
  customRequestHeaders: CustomRequestHeaders[];
3656
3668
  /**
3657
- * @defaultValue true
3658
- *
3659
3669
  * Setting this to false would keep the Window alive even if all its Views were closed.
3660
3670
  * This is meant for advanced users and should be used with caution.
3661
3671
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3662
3672
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3663
3673
  * **NOTE:** - This option is ignored in non-Platforms apps.
3674
+ *
3675
+ * @default true
3664
3676
  */
3665
3677
  closeOnLastViewRemoved: boolean;
3666
3678
  /**
3667
- * @defaultValue 'all'
3679
+ * @experimental
3668
3680
  *
3681
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
3682
+ * These css properties are used to enable dragging of a frameless window.
3683
+ *
3684
+ * @default false
3685
+ */
3686
+ disableAppRegion: boolean;
3687
+ /**
3669
3688
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3670
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3689
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3671
3690
  * **NOTE:** - This option is ignored in non-Platforms apps.
3691
+ *
3692
+ * @default 'all'
3672
3693
  */
3673
3694
  viewsPreventingClose: 'all' | 'layout';
3674
3695
  /**
@@ -3679,31 +3700,31 @@ declare type ConstWindowOptions = {
3679
3700
  */
3680
3701
  defaultCentered: boolean;
3681
3702
  /**
3682
- * @defaultValue 500
3683
- *
3684
3703
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3685
3704
  * in favor of the cached value.
3705
+ *
3706
+ * @default 500
3686
3707
  */
3687
3708
  defaultHeight: number;
3688
3709
  /**
3689
- * @defaultValue 100
3690
- *
3691
3710
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3692
3711
  * launches in favor of the cached value.
3712
+ *
3713
+ * @default 100
3693
3714
  */
3694
3715
  defaultLeft: number;
3695
3716
  /**
3696
- * @defaultValue 100
3697
- *
3698
3717
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3699
3718
  * launches in favor of the cached value.
3719
+ *
3720
+ * @default 100
3700
3721
  */
3701
3722
  defaultTop: number;
3702
3723
  /**
3703
- * @defaultValue 800
3704
- *
3705
3724
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3706
3725
  * launches in favor of the cached value.
3726
+ *
3727
+ * @default 800
3707
3728
  */
3708
3729
  defaultWidth: number;
3709
3730
  /**
@@ -3749,19 +3770,19 @@ declare type ConstWindowOptions = {
3749
3770
  */
3750
3771
  processAffinity: string;
3751
3772
  /**
3752
- * @defaultValue false
3753
- *
3754
3773
  * Displays a shadow on frameless windows.
3755
3774
  * `shadow` and `cornerRounding` are mutually exclusive.
3756
3775
  * On Windows 7, Aero theme is required.
3776
+ *
3777
+ * @default false
3757
3778
  */
3758
3779
  shadow: boolean;
3759
3780
  /**
3760
- * @defaultValue true
3761
- *
3762
3781
  * Caches the location of the window.
3763
3782
  *
3764
3783
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3784
+ *
3785
+ * @default true
3765
3786
  */
3766
3787
  saveWindowState: boolean;
3767
3788
  /**
@@ -3770,22 +3791,22 @@ declare type ConstWindowOptions = {
3770
3791
  */
3771
3792
  ignoreSavedWindowState: boolean;
3772
3793
  /**
3773
- * @defaultValue false
3774
- *
3775
3794
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3776
3795
  *
3777
3796
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3778
3797
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3798
+ *
3799
+ * @default false
3779
3800
  */
3780
3801
  smallWindow: boolean;
3781
3802
  /**
3782
- * @defaultValue "normal"
3783
- *
3784
3803
  * The visible state of the window on creation.
3785
3804
  * One of:
3786
3805
  * * `"maximized"`
3787
3806
  * * `"minimized"`
3788
3807
  * * `"normal"`
3808
+ *
3809
+ * @default "normal"
3789
3810
  */
3790
3811
  state: WindowState;
3791
3812
  /**
@@ -3800,26 +3821,26 @@ declare type ConstWindowOptions = {
3800
3821
  */
3801
3822
  taskbarIconGroup: string;
3802
3823
  /**
3803
- * @defaultValue "about:blank"
3804
- *
3805
3824
  * The URL of the window
3825
+ *
3826
+ * @default "about:blank"
3806
3827
  */
3807
3828
  url: string;
3808
3829
  /**
3809
- * @defaultValue <application UUID>
3810
- *
3811
3830
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3812
3831
  * If omitted, defaults to the `uuid` of the application spawning the window.
3813
3832
  * If given, must match the `uuid` of the application spawning the window.
3814
3833
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3815
3834
  * really no need to provide it.
3835
+ *
3836
+ * @default <application UUID>
3816
3837
  */
3817
3838
  uuid: string;
3818
3839
  /**
3819
- * @defaultValue false
3820
- *
3821
3840
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3822
3841
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3842
+ *
3843
+ * @default false
3823
3844
  */
3824
3845
  waitForPageLoad: boolean;
3825
3846
  width: number;
@@ -3839,6 +3860,10 @@ declare type ConstWindowOptions = {
3839
3860
  * Control which options to ignore when creating a Platform Window.
3840
3861
  */
3841
3862
  excludeOptions: ExcludeOptions;
3863
+ /**
3864
+ * 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.
3865
+ */
3866
+ roundedCorners: boolean;
3842
3867
  };
3843
3868
 
3844
3869
  /**
@@ -4101,13 +4126,13 @@ declare type CopyBlockedEventReason = 'disabled';
4101
4126
  */
4102
4127
  declare type CopyPermissions = {
4103
4128
  /**
4104
- * @defaultValue 'allowed'
4105
- *
4106
4129
  * Controls the behavior for copy operations for a matched URL.
4107
4130
  *
4108
4131
  * allow: Enables all copy operations.
4109
4132
  * block: Disables all copy operations.
4110
4133
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4134
+ *
4135
+ * @default 'allowed'
4111
4136
  */
4112
4137
  behavior: 'allow' | 'block' | 'protect';
4113
4138
  /**
@@ -4115,9 +4140,9 @@ declare type CopyPermissions = {
4115
4140
  */
4116
4141
  options?: {
4117
4142
  /**
4118
- * @defaultValue ''
4119
- *
4120
4143
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4144
+ *
4145
+ * @default ''
4121
4146
  */
4122
4147
  replacementText: string;
4123
4148
  };
@@ -4131,15 +4156,15 @@ declare type CopyPermissions = {
4131
4156
  */
4132
4157
  declare type CornerRounding = {
4133
4158
  /**
4134
- * @defaultValue 0
4135
- *
4136
4159
  * The height in pixels.
4160
+ *
4161
+ * @default 0
4137
4162
  */
4138
4163
  height: number;
4139
4164
  /**
4140
- * @defaultValue 0
4141
- *
4142
4165
  * The width in pixels.
4166
+ *
4167
+ * @default 0
4143
4168
  */
4144
4169
  width: number;
4145
4170
  };
@@ -4229,8 +4254,6 @@ declare type CreateLayoutOptions = {
4229
4254
  layoutName: string;
4230
4255
  layout: LayoutOptions;
4231
4256
  /**
4232
- * @defaultValue 'default'
4233
- *
4234
4257
  * Controls the View behavior for the given `layout` property. Note
4235
4258
  * that the selected behavior only applies to unnamed Views or
4236
4259
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4252,6 +4275,8 @@ declare type CreateLayoutOptions = {
4252
4275
  * override. Note that during applyLayoutSnapshot, Views are created and
4253
4276
  * attached to the Provider while the Window is being created, so it's
4254
4277
  * important to not 'duplicate' Views in this workflow.
4278
+ *
4279
+ * @default 'default'
4255
4280
  */
4256
4281
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4257
4282
  };
@@ -4510,7 +4535,7 @@ declare type DomainApiSettings = {
4510
4535
  * * 'none': The `fin` API will be not available.
4511
4536
  * * 'global': The entire `fin` API will be available.
4512
4537
  *
4513
- * @defaultValue 'global'
4538
+ * @default 'global'
4514
4539
  */
4515
4540
  fin?: InjectionType;
4516
4541
  /**
@@ -5095,9 +5120,9 @@ declare type EventType_9 = Event_12['type'];
5095
5120
  */
5096
5121
  declare type ExcludeOptions = {
5097
5122
  /**
5098
- * @defaultValue false
5099
- *
5100
5123
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5124
+ *
5125
+ * @default false
5101
5126
  */
5102
5127
  preloadScripts: boolean;
5103
5128
  };
@@ -5930,34 +5955,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
5930
5955
  */
5931
5956
  declare type FindInPageOptions = {
5932
5957
  /**
5933
- * @defaultValue true
5934
- *
5935
5958
  * Searches in the forward direction (backward otherwise)
5959
+ *
5960
+ * @default true
5936
5961
  */
5937
5962
  forward?: boolean;
5938
5963
  /**
5939
- * @defaultValue false
5940
- *
5941
5964
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5965
+ *
5966
+ * @default false
5942
5967
  */
5943
5968
  findNext?: boolean;
5944
5969
  /**
5945
- * @defaultValue false
5946
- *
5947
5970
  * Enables case-sensitive searching.
5971
+ *
5972
+ * @default false
5948
5973
  */
5949
5974
  matchCase?: boolean;
5950
5975
  /**
5951
- * @defaultValue false
5952
- *
5953
5976
  * Only searches from the start of words.
5977
+ *
5978
+ * @default false
5954
5979
  */
5955
5980
  wordStart?: boolean;
5956
5981
  /**
5957
- * @defaultValue false
5958
- *
5959
5982
  * 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>
5960
5983
  * lowercase or non-letter. Accepts several other intra-word matches.
5984
+ *
5985
+ * @default false
5961
5986
  */
5962
5987
  medialCapitalAsWordStart?: boolean;
5963
5988
  };
@@ -6465,9 +6490,9 @@ declare type Hotkey = {
6465
6490
  */
6466
6491
  keys: string;
6467
6492
  /**
6468
- * @defaultValue false
6469
- *
6470
6493
  * Prevent default key handling before emitting the event.
6494
+ *
6495
+ * @default false
6471
6496
  */
6472
6497
  preventDefault?: boolean;
6473
6498
  };
@@ -8824,77 +8849,79 @@ declare type LayoutOptions = {
8824
8849
  */
8825
8850
  newTabButtonUrl?: string;
8826
8851
  /**
8827
- * @defaultValue false
8828
- *
8829
8852
  * When true the splitters will not be draggable and the layout will not resize.
8853
+ *
8854
+ * @default false
8830
8855
  */
8831
8856
  preventSplitterResize?: boolean;
8832
8857
  /**
8833
- * @defaultValue false
8834
- *
8835
8858
  * Whether the popout button will only act on the entire stack,
8836
8859
  * as opposed to only the active tab.
8860
+ *
8861
+ * @default false
8837
8862
  */
8838
8863
  popoutWholeStack?: boolean;
8839
8864
  /**
8840
- * @defaultValue false
8841
- *
8842
8865
  * Limits the area to which tabs can be dragged.
8843
8866
  * If true, the layout container is the only area where tabs can be dropped.
8867
+ *
8868
+ * @default false
8844
8869
  */
8845
8870
  constrainDragToContainer?: boolean;
8846
8871
  /**
8847
- * @defaultValue false
8848
- *
8849
8872
  * Whether to show the popout button on stack header.
8850
8873
  * The button will create a new window with current tab as its content.
8851
8874
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8875
+ *
8876
+ * @default false
8852
8877
  */
8853
8878
  showPopoutIcon?: boolean;
8854
8879
  /**
8855
- * @defaultValue false
8856
- *
8857
8880
  * Whether to show the maximize button on stack header.
8858
8881
  * The button will maximize the current tab to fill the entire window.
8882
+ *
8883
+ * @default false
8859
8884
  */
8860
8885
  showMaximiseIcon?: boolean;
8861
8886
  /**
8862
- * @defaultValue false
8863
- *
8864
8887
  * Whether to show the close button on stack header
8865
8888
  * (not to be confused with close button on every tab).
8889
+ *
8890
+ * @default false
8866
8891
  */
8867
8892
  showCloseIcon?: boolean;
8868
8893
  /**
8869
- * @defaultValue false
8870
- *
8871
8894
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8895
+ *
8896
+ * @default false
8872
8897
  */
8873
8898
  constrainDragToHeaders?: boolean;
8874
8899
  /**
8875
- * @defaultValue true
8876
- *
8877
8900
  * Turns tab headers on or off.
8878
8901
  * If false, the layout will be displayed with splitters only.
8902
+ *
8903
+ * @default true
8879
8904
  */
8880
8905
  hasHeaders?: boolean;
8881
8906
  /**
8882
- * @defaultValue true
8883
- *
8884
8907
  * If true, the user can re-arrange the layout by
8885
8908
  * dragging items by their tabs to the desired location.
8909
+ *
8910
+ * @default true
8886
8911
  */
8887
8912
  reorderEnabled?: boolean;
8888
8913
  /**
8889
- * @defaultValue false
8890
- *
8891
8914
  * If true, tabs can't be dragged out of the window.
8915
+ *
8916
+ * @default false
8892
8917
  */
8893
8918
  preventDragOut?: boolean;
8894
8919
  /**
8895
- * @defaultValue false
8920
+ * @defaultValue=false
8896
8921
  *
8897
8922
  * If true, tabs can't be dragged into the window.
8923
+ *
8924
+ * @default false
8898
8925
  */
8899
8926
  preventDragIn?: boolean;
8900
8927
  /* Excluded from this release type: disableTabOverflowDropdown */
@@ -9402,10 +9429,10 @@ declare type MutableViewOptions = {
9402
9429
  /**
9403
9430
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9404
9431
  *
9405
- * @defaultValue true
9406
- *
9407
9432
  * Show the context menu when right-clicking on the view.
9408
9433
  * Gives access to the devtools for the view.
9434
+ *
9435
+ * @default true
9409
9436
  */
9410
9437
  contextMenu: boolean;
9411
9438
  /**
@@ -9452,24 +9479,25 @@ declare type MutableViewOptions = {
9452
9479
  contentNavigation: ContentNavigation;
9453
9480
  contentRedirect: ContentRedirect;
9454
9481
  /**
9455
- * @defaultValue false
9456
9482
  * @deprecated
9457
9483
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9458
9484
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9485
+ *
9486
+ * @default false
9459
9487
  */
9460
9488
  detachOnClose: boolean;
9461
9489
  /**
9462
- * @defaultValue true
9463
- *
9464
9490
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9465
9491
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9466
9492
  * if the view isn't part of the new layout when running `Layout.replace`.
9493
+ *
9494
+ * @default true
9467
9495
  */
9468
9496
  isClosable: boolean;
9469
9497
  /**
9470
- * @defaultValue false
9471
- *
9472
9498
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9499
+ *
9500
+ * @default false
9473
9501
  */
9474
9502
  preventDragOut: boolean;
9475
9503
  interop?: InteropConfig;
@@ -9477,7 +9505,7 @@ declare type MutableViewOptions = {
9477
9505
  /**
9478
9506
  * {@inheritDoc ViewThrottling}
9479
9507
  *
9480
- * @defaultValue 'enabled'
9508
+ * @default 'enabled'
9481
9509
  */
9482
9510
  throttling: ViewThrottling;
9483
9511
  /**
@@ -9496,7 +9524,7 @@ declare type MutableWindowOptions = {
9496
9524
  * Turns anything of matching RGB value transparent.
9497
9525
  *
9498
9526
  * Caveats:
9499
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9527
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9500
9528
  * * User cannot click-through transparent regions
9501
9529
  * * Not supported on Mac
9502
9530
  * * Windows Aero must be enabled
@@ -9505,25 +9533,25 @@ declare type MutableWindowOptions = {
9505
9533
  */
9506
9534
  alphaMask: RGB;
9507
9535
  /**
9508
- * @defaultValue false
9509
- *
9510
9536
  * Always position the window at the top of the window stack.
9537
+ *
9538
+ * @default false
9511
9539
  */
9512
9540
  alwaysOnTop: boolean;
9513
9541
  /**
9514
- * @defaultValue 0
9515
- *
9516
9542
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9517
9543
  * an aspect ratio will not be enforced.
9544
+ *
9545
+ * @default 0
9518
9546
  */
9519
9547
  aspectRatio: number;
9520
9548
  /**
9521
9549
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9522
9550
  *
9523
- * @defaultValue true
9524
- *
9525
9551
  * Show the context menu when right-clicking on the window.
9526
9552
  * Gives access to the devtools for the window.
9553
+ *
9554
+ * @default true
9527
9555
  */
9528
9556
  contextMenu: boolean;
9529
9557
  /**
@@ -9590,16 +9618,17 @@ declare type MutableWindowOptions = {
9590
9618
  */
9591
9619
  customData: any;
9592
9620
  /**
9593
- * @defaultValue true
9594
9621
  * @deprecated Will be removed in runtime version 45
9595
9622
  *
9596
9623
  * Show the window's frame.
9624
+ *
9625
+ * @default true
9597
9626
  */
9598
9627
  frame: boolean;
9599
9628
  /**
9600
- * @defaultValue false
9601
- *
9602
9629
  * Hides the window instead of closing it when the close button is pressed.
9630
+ *
9631
+ * @default false
9603
9632
  */
9604
9633
  hideOnClose: boolean;
9605
9634
  /**
@@ -9652,60 +9681,61 @@ declare type MutableWindowOptions = {
9652
9681
  */
9653
9682
  icon: string;
9654
9683
  /**
9655
- * @defaultValue true
9656
- *
9657
9684
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9658
9685
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9686
+ *
9687
+ * @default true
9659
9688
  */
9660
9689
  includeInSnapshots: boolean;
9661
9690
  /**
9662
- * @defaultValue -1
9663
- *
9664
9691
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9692
+ *
9693
+ * @default -1
9665
9694
  */
9666
9695
  maxHeight: number;
9667
9696
  /**
9668
- * @defaultValue true
9669
- *
9670
9697
  * Allows the window to be maximized.
9698
+ *
9699
+ * @default true
9671
9700
  */
9672
9701
  maximizable: boolean;
9673
9702
  /**
9674
- * @defaultValue -1
9675
- *
9676
9703
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9704
+ *
9705
+ * @default -1
9677
9706
  */
9678
9707
  maxWidth: number;
9679
9708
  /**
9680
- * @defaultValue 0
9681
- *
9682
9709
  * The minimum height of the window.
9710
+ *
9711
+ * @default 0
9683
9712
  */
9684
9713
  minHeight: number;
9685
9714
  /**
9686
- * @defaultValue true
9687
- *
9688
9715
  * Allows the window to be minimized.
9716
+ *
9717
+ * @default true
9689
9718
  */
9690
9719
  minimizable: boolean;
9691
9720
  /**
9692
- * @defaultValue true
9693
- *
9694
9721
  * The minimum width of the window.
9722
+ *
9723
+ * @default true
9695
9724
  */
9696
9725
  minWidth: number;
9697
9726
  /**
9698
- * @defaultValue 1
9699
- *
9700
9727
  * A flag that specifies how transparent the window will be.
9701
9728
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9702
9729
  * This value is clamped between `0.0` and `1.0`.
9730
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9731
+ *
9732
+ * @default 1
9703
9733
  */
9704
9734
  opacity: number;
9705
9735
  /**
9706
- * @defaultValue true
9707
- *
9708
9736
  * A flag to allow the user to resize the window.
9737
+ *
9738
+ * @default true
9709
9739
  */
9710
9740
  resizable: boolean;
9711
9741
  /**
@@ -9713,16 +9743,16 @@ declare type MutableWindowOptions = {
9713
9743
  */
9714
9744
  resizeRegion: ResizeRegion;
9715
9745
  /**
9716
- * @defaultValue false
9717
- *
9718
9746
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9719
9747
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9748
+ *
9749
+ * @default false
9720
9750
  */
9721
9751
  showBackgroundImages: boolean;
9722
9752
  /**
9723
- * @defaultValue true
9724
- *
9725
9753
  * Shows the window's icon in the taskbar.
9754
+ *
9755
+ * @default true
9726
9756
  */
9727
9757
  showTaskbarIcon: boolean;
9728
9758
  /**
@@ -9741,7 +9771,7 @@ declare type MutableWindowOptions = {
9741
9771
  /**
9742
9772
  * {@inheritDoc WindowThrottling}
9743
9773
  *
9744
- * @defaultValue 'enabled'
9774
+ * @default 'enabled'
9745
9775
  *
9746
9776
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9747
9777
  */
@@ -10385,12 +10415,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10385
10415
  */
10386
10416
  declare type PastePermissions = {
10387
10417
  /**
10388
- * @defaultValue 'non-protected-content'
10389
- *
10390
10418
  * Controls the behavior for paste operations for a matched URL.
10391
10419
  *
10392
10420
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10393
10421
  * 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.
10422
+ *
10423
+ * @default 'non-protected-content'
10394
10424
  */
10395
10425
  behavior: 'non-protected-content' | 'all-content';
10396
10426
  };
@@ -11422,11 +11452,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11422
11452
  */
11423
11453
  providerUrl?: string;
11424
11454
  /**
11425
- * @defaultValue true
11426
- *
11427
11455
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11428
11456
  *
11429
11457
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11458
+ *
11459
+ * @default true
11430
11460
  */
11431
11461
  allowLaunchIntoPlatform?: boolean;
11432
11462
  };
@@ -12074,22 +12104,22 @@ declare type PopupOptions = {
12074
12104
  url?: string;
12075
12105
  /**
12076
12106
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
12077
- * @defaultValue 300
12107
+ * @default 300
12078
12108
  */
12079
12109
  height?: number;
12080
12110
  /**
12081
12111
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
12082
- * @defaultValue 300
12112
+ * @default 300
12083
12113
  */
12084
12114
  width?: number;
12085
12115
  /**
12086
12116
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12087
- * @defaultValue 0
12117
+ * @default 0
12088
12118
  */
12089
12119
  x?: number;
12090
12120
  /**
12091
12121
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12092
- * @defaultValue 0
12122
+ * @default 0
12093
12123
  */
12094
12124
  y?: number;
12095
12125
  /**
@@ -12097,7 +12127,7 @@ declare type PopupOptions = {
12097
12127
  * * 'modal' restricts resizing and positioning in the caller.
12098
12128
  * * 'hide' hides the popup window on blur.
12099
12129
  * * 'close' closes the popup window on blur.
12100
- * @defaultValue 'close'
12130
+ * @default 'close'
12101
12131
  */
12102
12132
  blurBehavior?: PopupBlurBehavior;
12103
12133
  /**
@@ -12105,19 +12135,19 @@ declare type PopupOptions = {
12105
12135
  * * 'none' will do nothing.
12106
12136
  * * 'hide' hides the popup window on `dispatchPopupResult`.
12107
12137
  * * 'close' closes the popup window on `dispatchPopupResult`.
12108
- * @defaultValue 'close'
12138
+ * @default 'close'
12109
12139
  */
12110
12140
  resultDispatchBehavior?: PopupResultBehavior;
12111
12141
  /**
12112
12142
  * Hide the popup window instead of closing when `close` is called on it.
12113
12143
  *
12114
12144
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
12115
- * @defaultValue false
12145
+ * @default false
12116
12146
  */
12117
12147
  hideOnClose?: boolean;
12118
12148
  /**
12119
12149
  * Determines if the popup window should or should not be focused when it is shown.
12120
- * @defaultValue true
12150
+ * @default true
12121
12151
  */
12122
12152
  focus?: boolean;
12123
12153
  /**
@@ -12211,9 +12241,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12211
12241
  */
12212
12242
  declare type PreloadScript = {
12213
12243
  /**
12214
- * @defaultValue false
12215
- *
12216
12244
  * Fail to load the window if this preload script fails
12245
+ *
12246
+ * @default false
12217
12247
  */
12218
12248
  mandatory?: boolean;
12219
12249
  /**
@@ -12305,15 +12335,15 @@ declare type PrinterInfo = {
12305
12335
  declare type PrintOptions = {
12306
12336
  content?: 'self';
12307
12337
  /**
12308
- * @defaultValue false
12309
- *
12310
12338
  * Disables prompting the user for print settings.
12339
+ *
12340
+ * @default false
12311
12341
  */
12312
12342
  silent?: boolean;
12313
12343
  /**
12314
- * @defaultValue false
12315
- *
12316
12344
  * Includes the webpage background color and image when printing.
12345
+ *
12346
+ * @default false
12317
12347
  */
12318
12348
  printBackground?: boolean;
12319
12349
  /**
@@ -12321,9 +12351,9 @@ declare type PrintOptions = {
12321
12351
  */
12322
12352
  deviceName?: string;
12323
12353
  /**
12324
- * @defaultValue true
12325
- *
12326
12354
  * Prints in full color (greyscale otherwise).
12355
+ *
12356
+ * @default true
12327
12357
  */
12328
12358
  color?: boolean;
12329
12359
  /**
@@ -12331,9 +12361,9 @@ declare type PrintOptions = {
12331
12361
  */
12332
12362
  margins?: Margins;
12333
12363
  /**
12334
- * @defaultValue true
12335
- *
12336
12364
  * Prints in landscape mode (portrait otherwise).
12365
+ *
12366
+ * @default true
12337
12367
  */
12338
12368
  landscape?: boolean;
12339
12369
  /**
@@ -13709,15 +13739,15 @@ declare type ReplaceViewPayload = {
13709
13739
  */
13710
13740
  declare type ResizeRegion = {
13711
13741
  /**
13712
- * @defaultValue 7
13713
- *
13714
13742
  * The size of the resize region in pixels.
13743
+ *
13744
+ * @default 7
13715
13745
  */
13716
13746
  size?: number;
13717
13747
  /**
13718
- * @defaultValue 9
13719
- *
13720
13748
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13749
+ *
13750
+ * @default 9
13721
13751
  */
13722
13752
  bottomRightCorner?: number;
13723
13753
  /**
@@ -13725,27 +13755,27 @@ declare type ResizeRegion = {
13725
13755
  */
13726
13756
  sides?: {
13727
13757
  /**
13728
- * @defaultValue true
13729
- *
13730
13758
  * Enables resizing from the top of the window.
13759
+ *
13760
+ * @default true
13731
13761
  */
13732
13762
  top?: boolean;
13733
13763
  /**
13734
- * @defaultValue true
13735
- *
13736
13764
  * Enables resizing from the bottom of the window.
13765
+ *
13766
+ * @default true
13737
13767
  */
13738
13768
  bottom?: boolean;
13739
13769
  /**
13740
- * @defaultValue true
13741
- *
13742
13770
  * Enables resizing from the left side of the window.
13771
+ *
13772
+ * @default true
13743
13773
  */
13744
13774
  left?: boolean;
13745
13775
  /**
13746
- * @defaultValue true
13747
- *
13748
13776
  * Enables resizing from the right side of the window.
13777
+ *
13778
+ * @default true
13749
13779
  */
13750
13780
  right?: boolean;
13751
13781
  };
@@ -14299,9 +14329,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
14299
14329
  */
14300
14330
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
14301
14331
  /**
14302
- * @defaultValue 0
14303
- *
14304
14332
  * Number of milliseconds to wait between view repaints.
14333
+ *
14334
+ * @default 0
14305
14335
  */
14306
14336
  paintIntervalMs?: number;
14307
14337
  };
@@ -16353,9 +16383,9 @@ declare type TransitionBase = {
16353
16383
  */
16354
16384
  duration: number;
16355
16385
  /**
16356
- * @defaultValue false
16357
- *
16358
16386
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16387
+ *
16388
+ * @default false
16359
16389
  */
16360
16390
  relative?: boolean;
16361
16391
  };
@@ -16371,9 +16401,9 @@ declare type TransitionOptions = {
16371
16401
  */
16372
16402
  interrupt: boolean;
16373
16403
  /**
16374
- * @defaultValue false
16375
- *
16376
16404
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16405
+ *
16406
+ * @default false
16377
16407
  */
16378
16408
  relative?: boolean;
16379
16409
  tween?: tween;
@@ -17407,9 +17437,9 @@ declare type ViewTitlePriority = 'document' | 'options';
17407
17437
  */
17408
17438
  declare type ViewVisibilityOption = {
17409
17439
  /**
17410
- * @defaultValue false
17411
- *
17412
17440
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17441
+ *
17442
+ * @default false
17413
17443
  */
17414
17444
  enabled?: boolean;
17415
17445
  };