@openfin/core 42.100.97 → 42.100.99

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/out/stub.d.ts CHANGED
@@ -139,13 +139,13 @@ declare type ApiSettings = {
139
139
  /**
140
140
  * Inject OpenFin API into cross-origin iframes
141
141
  *
142
- * @defaultValue false
142
+ * @default false
143
143
  */
144
144
  crossOriginInjection?: boolean;
145
145
  /**
146
146
  * Inject OpenFin API into same-origin iframes
147
147
  *
148
- * @defaultValue true
148
+ * @default true
149
149
  */
150
150
  sameOriginInjection?: boolean;
151
151
  /**
@@ -1190,19 +1190,19 @@ declare class ApplicationModule extends Base {
1190
1190
  */
1191
1191
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1192
1192
  /**
1193
- * @defaultValue false
1194
- *
1195
1193
  * Disables IAB secure logging for the app.
1194
+ *
1195
+ * @default false
1196
1196
  */
1197
1197
  disableIabSecureLogging: boolean;
1198
1198
  /**
1199
- * @defaultValue 'There was an error loading the application.'
1200
- *
1201
1199
  * An error message to display when the application (launched via manifest) fails to load.
1202
1200
  * A dialog box will be launched with the error message just before the runtime exits.
1203
1201
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1204
1202
  * will trigger this dialog.
1205
1203
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1204
+ *
1205
+ * @default 'There was an error loading the application.'
1206
1206
  */
1207
1207
  loadErrorMessage: string;
1208
1208
  /**
@@ -1221,28 +1221,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1221
1221
  */
1222
1222
  name: string;
1223
1223
  /**
1224
- * @defaultValue false
1225
- *
1226
1224
  * A flag to configure the application as non-persistent.
1227
1225
  * Runtime exits when there are no persistent apps running.
1226
+ *
1227
+ * @default false
1228
1228
  */
1229
1229
  nonPersistent: boolean;
1230
1230
  /**
1231
- * @defaultValue false
1232
- *
1233
1231
  * Enable Flash at the application level.
1232
+ *
1233
+ * @default false
1234
1234
  */
1235
1235
  plugins: boolean;
1236
1236
  /**
1237
- * @defaultValue false
1238
- *
1239
1237
  * Enable spell check at the application level.
1238
+ *
1239
+ * @default false
1240
1240
  */
1241
1241
  spellCheck: boolean;
1242
1242
  /**
1243
- * @defaultValue 'about:blank'
1244
- *
1245
1243
  * The url to the application (specifically the application's main window).
1244
+ *
1245
+ * @default 'about:blank'
1246
1246
  */
1247
1247
  url: string;
1248
1248
  /**
@@ -1251,9 +1251,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1251
1251
  */
1252
1252
  uuid: string;
1253
1253
  /**
1254
- * @defaultValue true
1255
- *
1256
1254
  * When set to `false` it will disable the same-origin policy for the app.
1255
+ *
1256
+ * @default true
1257
1257
  */
1258
1258
  webSecurity: boolean;
1259
1259
  /**
@@ -1263,10 +1263,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1263
1263
  commands: ShortcutOverride[];
1264
1264
  isPlatformController: boolean;
1265
1265
  /**
1266
- * @defaultValue 1000
1267
- *
1268
1266
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1269
1267
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1268
+ *
1269
+ * @default 1000
1270
1270
  */
1271
1271
  maxViewPoolSize: number;
1272
1272
  /**
@@ -1282,12 +1282,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1282
1282
  */
1283
1283
  snapshot: Snapshot;
1284
1284
  /**
1285
- * @defaultValue false
1286
- *
1287
1285
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1288
1286
  *
1289
1287
  * Note: if the Platform Provider is showing, it won't close automatically.
1290
1288
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1289
+ *
1290
+ * @default false
1291
1291
  */
1292
1292
  preventQuitOnLastWindowClosed: boolean;
1293
1293
  /**
@@ -1295,9 +1295,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1295
1295
  */
1296
1296
  interopBrokerConfiguration: InteropBrokerOptions;
1297
1297
  /**
1298
- * @defaultValue true
1299
- *
1300
1298
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1299
+ *
1300
+ * @default true
1301
1301
  */
1302
1302
  apiDiagnostics: boolean;
1303
1303
  /**
@@ -1313,16 +1313,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1313
1313
  */
1314
1314
  permissions?: Partial<Permissions_2>;
1315
1315
  /**
1316
- * @defaultValue false
1317
- *
1318
1316
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1319
1317
  * Only relevant in Windows.
1318
+ *
1319
+ * @default false
1320
1320
  */
1321
1321
  enableJumpList: boolean;
1322
1322
  /**
1323
- * @defaultValue false
1324
- *
1325
1323
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1324
+ *
1325
+ * @default false
1326
1326
  */
1327
1327
  enableBeforeUnload: boolean;
1328
1328
  /**
@@ -1403,25 +1403,25 @@ declare type ApplicationWindowInfo = {
1403
1403
  */
1404
1404
  declare type ApplySnapshotOptions = {
1405
1405
  /**
1406
- * @defaultValue false
1407
- *
1408
1406
  * When true, applySnapshot will close existing windows,
1409
1407
  * replacing current Platform state with the given snapshot.
1408
+ *
1409
+ * @default false
1410
1410
  */
1411
1411
  closeExistingWindows?: boolean;
1412
1412
  /**
1413
- * @defaultValue false
1414
- *
1415
1413
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1416
1414
  * replacing current Platform state with the given snapshot.
1415
+ *
1416
+ * @default false
1417
1417
  */
1418
1418
  closeSnapshotWindows?: boolean;
1419
1419
  /**
1420
- * @defaultValue false
1421
- *
1422
1420
  * When true, applySnapshot will not check whether any windows in a
1423
1421
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1424
1422
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1423
+ *
1424
+ * @default false
1425
1425
  */
1426
1426
  skipOutOfBoundsCheck?: boolean;
1427
1427
  };
@@ -2104,15 +2104,15 @@ declare type CapturePageOptions = {
2104
2104
  */
2105
2105
  area?: Rectangle;
2106
2106
  /**
2107
- * @defaultValue 'png'
2108
- *
2109
2107
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2108
+ *
2109
+ * @default 'png'
2110
2110
  */
2111
2111
  format?: 'bmp' | 'jpg' | 'png';
2112
2112
  /**
2113
- * @defaultValue 100
2114
- *
2115
2113
  * Quality of JPEG image. Between 0 - 100.
2114
+ *
2115
+ * @default 100
2116
2116
  */
2117
2117
  quality?: number;
2118
2118
  };
@@ -2766,9 +2766,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2766
2766
  */
2767
2767
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2768
2768
  /**
2769
- * @defaultValue true
2770
- *
2771
2769
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2770
+ *
2771
+ * @default true
2772
2772
  */
2773
2773
  wait?: boolean;
2774
2774
  /**
@@ -3065,6 +3065,10 @@ declare type ChromiumPolicies = {
3065
3065
  * Disable AutofillAddressEnabled policy for a Window or View.
3066
3066
  */
3067
3067
  AutofillAddressEnabled?: PolicyOptions;
3068
+ /**
3069
+ * Disable AutofillCreditCardEnabled policy for a Window or View.
3070
+ */
3071
+ AutofillCreditCardEnabled?: PolicyOptions;
3068
3072
  };
3069
3073
 
3070
3074
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3430,9 +3434,9 @@ declare interface CloseWindowPayload {
3430
3434
  windowId: Identity_4;
3431
3435
  options: {
3432
3436
  /**
3433
- * @defaultValue false
3434
- *
3435
3437
  * When set to true skips any before handler set on views that are part of the window
3438
+ *
3439
+ * @default false
3436
3440
  */
3437
3441
  skipBeforeUnload?: boolean;
3438
3442
  };
@@ -3540,9 +3544,9 @@ declare type ConstViewOptions = {
3540
3544
  */
3541
3545
  name: string;
3542
3546
  /**
3543
- * @defaultValue "about:blank"
3544
- *
3545
3547
  * The URL of the window
3548
+ *
3549
+ * @default "about:blank"
3546
3550
  */
3547
3551
  url: string;
3548
3552
  /**
@@ -3567,6 +3571,15 @@ declare type ConstViewOptions = {
3567
3571
  * Custom headers for requests sent by the view.
3568
3572
  */
3569
3573
  customRequestHeaders: CustomRequestHeaders[];
3574
+ /**
3575
+ * @experimental
3576
+ *
3577
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
3578
+ * These css properties are used to enable dragging of a frameless window.
3579
+ *
3580
+ * @default false
3581
+ */
3582
+ disableAppRegion: boolean;
3570
3583
  /**
3571
3584
  * Initial bounds given relative to the window.
3572
3585
  */
@@ -3603,9 +3616,9 @@ declare type ConstViewOptions = {
3603
3616
  experimental: any;
3604
3617
  fdc3InteropApi?: string;
3605
3618
  /**
3606
- * @defaultValue false
3607
- *
3608
3619
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3620
+ *
3621
+ * @default false
3609
3622
  */
3610
3623
  enableBeforeUnload: boolean;
3611
3624
  /**
@@ -3686,13 +3699,12 @@ declare type ConstWindowOptions = {
3686
3699
  */
3687
3700
  backgroundColor: string;
3688
3701
  /**
3689
- * @defaultValue false
3690
- *
3691
3702
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3692
3703
  * This also affects the Page Visibility API.
3693
3704
  *
3694
3705
  * When `true`, the page is throttled whether it is hidden or not.
3695
3706
  *
3707
+ * @default false
3696
3708
  */
3697
3709
  backgroundThrottling: boolean;
3698
3710
  /**
@@ -3716,21 +3728,30 @@ declare type ConstWindowOptions = {
3716
3728
  */
3717
3729
  customRequestHeaders: CustomRequestHeaders[];
3718
3730
  /**
3719
- * @defaultValue true
3720
- *
3721
3731
  * Setting this to false would keep the Window alive even if all its Views were closed.
3722
3732
  * This is meant for advanced users and should be used with caution.
3723
3733
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3724
3734
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3725
3735
  * **NOTE:** - This option is ignored in non-Platforms apps.
3736
+ *
3737
+ * @default true
3726
3738
  */
3727
3739
  closeOnLastViewRemoved: boolean;
3728
3740
  /**
3729
- * @defaultValue 'all'
3741
+ * @experimental
3730
3742
  *
3743
+ * When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
3744
+ * These css properties are used to enable dragging of a frameless window.
3745
+ *
3746
+ * @default false
3747
+ */
3748
+ disableAppRegion: boolean;
3749
+ /**
3731
3750
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3732
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3751
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3733
3752
  * **NOTE:** - This option is ignored in non-Platforms apps.
3753
+ *
3754
+ * @default 'all'
3734
3755
  */
3735
3756
  viewsPreventingClose: 'all' | 'layout';
3736
3757
  /**
@@ -3741,31 +3762,31 @@ declare type ConstWindowOptions = {
3741
3762
  */
3742
3763
  defaultCentered: boolean;
3743
3764
  /**
3744
- * @defaultValue 500
3745
- *
3746
3765
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3747
3766
  * in favor of the cached value.
3767
+ *
3768
+ * @default 500
3748
3769
  */
3749
3770
  defaultHeight: number;
3750
3771
  /**
3751
- * @defaultValue 100
3752
- *
3753
3772
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3754
3773
  * launches in favor of the cached value.
3774
+ *
3775
+ * @default 100
3755
3776
  */
3756
3777
  defaultLeft: number;
3757
3778
  /**
3758
- * @defaultValue 100
3759
- *
3760
3779
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3761
3780
  * launches in favor of the cached value.
3781
+ *
3782
+ * @default 100
3762
3783
  */
3763
3784
  defaultTop: number;
3764
3785
  /**
3765
- * @defaultValue 800
3766
- *
3767
3786
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3768
3787
  * launches in favor of the cached value.
3788
+ *
3789
+ * @default 800
3769
3790
  */
3770
3791
  defaultWidth: number;
3771
3792
  /**
@@ -3811,19 +3832,19 @@ declare type ConstWindowOptions = {
3811
3832
  */
3812
3833
  processAffinity: string;
3813
3834
  /**
3814
- * @defaultValue false
3815
- *
3816
3835
  * Displays a shadow on frameless windows.
3817
3836
  * `shadow` and `cornerRounding` are mutually exclusive.
3818
3837
  * On Windows 7, Aero theme is required.
3838
+ *
3839
+ * @default false
3819
3840
  */
3820
3841
  shadow: boolean;
3821
3842
  /**
3822
- * @defaultValue true
3823
- *
3824
3843
  * Caches the location of the window.
3825
3844
  *
3826
3845
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3846
+ *
3847
+ * @default true
3827
3848
  */
3828
3849
  saveWindowState: boolean;
3829
3850
  /**
@@ -3832,22 +3853,22 @@ declare type ConstWindowOptions = {
3832
3853
  */
3833
3854
  ignoreSavedWindowState: boolean;
3834
3855
  /**
3835
- * @defaultValue false
3836
- *
3837
3856
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3838
3857
  *
3839
3858
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3840
3859
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3860
+ *
3861
+ * @default false
3841
3862
  */
3842
3863
  smallWindow: boolean;
3843
3864
  /**
3844
- * @defaultValue "normal"
3845
- *
3846
3865
  * The visible state of the window on creation.
3847
3866
  * One of:
3848
3867
  * * `"maximized"`
3849
3868
  * * `"minimized"`
3850
3869
  * * `"normal"`
3870
+ *
3871
+ * @default "normal"
3851
3872
  */
3852
3873
  state: WindowState;
3853
3874
  /**
@@ -3862,26 +3883,26 @@ declare type ConstWindowOptions = {
3862
3883
  */
3863
3884
  taskbarIconGroup: string;
3864
3885
  /**
3865
- * @defaultValue "about:blank"
3866
- *
3867
3886
  * The URL of the window
3887
+ *
3888
+ * @default "about:blank"
3868
3889
  */
3869
3890
  url: string;
3870
3891
  /**
3871
- * @defaultValue <application UUID>
3872
- *
3873
3892
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3874
3893
  * If omitted, defaults to the `uuid` of the application spawning the window.
3875
3894
  * If given, must match the `uuid` of the application spawning the window.
3876
3895
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3877
3896
  * really no need to provide it.
3897
+ *
3898
+ * @default <application UUID>
3878
3899
  */
3879
3900
  uuid: string;
3880
3901
  /**
3881
- * @defaultValue false
3882
- *
3883
3902
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3884
3903
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3904
+ *
3905
+ * @default false
3885
3906
  */
3886
3907
  waitForPageLoad: boolean;
3887
3908
  width: number;
@@ -3901,6 +3922,10 @@ declare type ConstWindowOptions = {
3901
3922
  * Control which options to ignore when creating a Platform Window.
3902
3923
  */
3903
3924
  excludeOptions: ExcludeOptions;
3925
+ /**
3926
+ * 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.
3927
+ */
3928
+ roundedCorners: boolean;
3904
3929
  };
3905
3930
 
3906
3931
  /**
@@ -4163,13 +4188,13 @@ declare type CopyBlockedEventReason = 'disabled';
4163
4188
  */
4164
4189
  declare type CopyPermissions = {
4165
4190
  /**
4166
- * @defaultValue 'allowed'
4167
- *
4168
4191
  * Controls the behavior for copy operations for a matched URL.
4169
4192
  *
4170
4193
  * allow: Enables all copy operations.
4171
4194
  * block: Disables all copy operations.
4172
4195
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4196
+ *
4197
+ * @default 'allowed'
4173
4198
  */
4174
4199
  behavior: 'allow' | 'block' | 'protect';
4175
4200
  /**
@@ -4177,9 +4202,9 @@ declare type CopyPermissions = {
4177
4202
  */
4178
4203
  options?: {
4179
4204
  /**
4180
- * @defaultValue ''
4181
- *
4182
4205
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4206
+ *
4207
+ * @default ''
4183
4208
  */
4184
4209
  replacementText: string;
4185
4210
  };
@@ -4193,15 +4218,15 @@ declare type CopyPermissions = {
4193
4218
  */
4194
4219
  declare type CornerRounding = {
4195
4220
  /**
4196
- * @defaultValue 0
4197
- *
4198
4221
  * The height in pixels.
4222
+ *
4223
+ * @default 0
4199
4224
  */
4200
4225
  height: number;
4201
4226
  /**
4202
- * @defaultValue 0
4203
- *
4204
4227
  * The width in pixels.
4228
+ *
4229
+ * @default 0
4205
4230
  */
4206
4231
  width: number;
4207
4232
  };
@@ -4291,8 +4316,6 @@ declare type CreateLayoutOptions = {
4291
4316
  layoutName: string;
4292
4317
  layout: LayoutOptions;
4293
4318
  /**
4294
- * @defaultValue 'default'
4295
- *
4296
4319
  * Controls the View behavior for the given `layout` property. Note
4297
4320
  * that the selected behavior only applies to unnamed Views or
4298
4321
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4314,6 +4337,8 @@ declare type CreateLayoutOptions = {
4314
4337
  * override. Note that during applyLayoutSnapshot, Views are created and
4315
4338
  * attached to the Provider while the Window is being created, so it's
4316
4339
  * important to not 'duplicate' Views in this workflow.
4340
+ *
4341
+ * @default 'default'
4317
4342
  */
4318
4343
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4319
4344
  };
@@ -4572,7 +4597,7 @@ declare type DomainApiSettings = {
4572
4597
  * * 'none': The `fin` API will be not available.
4573
4598
  * * 'global': The entire `fin` API will be available.
4574
4599
  *
4575
- * @defaultValue 'global'
4600
+ * @default 'global'
4576
4601
  */
4577
4602
  fin?: InjectionType;
4578
4603
  /**
@@ -5171,9 +5196,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5171
5196
  */
5172
5197
  declare type ExcludeOptions = {
5173
5198
  /**
5174
- * @defaultValue false
5175
- *
5176
5199
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5200
+ *
5201
+ * @default false
5177
5202
  */
5178
5203
  preloadScripts: boolean;
5179
5204
  };
@@ -5673,34 +5698,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5673
5698
  */
5674
5699
  declare type FindInPageOptions = {
5675
5700
  /**
5676
- * @defaultValue true
5677
- *
5678
5701
  * Searches in the forward direction (backward otherwise)
5702
+ *
5703
+ * @default true
5679
5704
  */
5680
5705
  forward?: boolean;
5681
5706
  /**
5682
- * @defaultValue false
5683
- *
5684
5707
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5708
+ *
5709
+ * @default false
5685
5710
  */
5686
5711
  findNext?: boolean;
5687
5712
  /**
5688
- * @defaultValue false
5689
- *
5690
5713
  * Enables case-sensitive searching.
5714
+ *
5715
+ * @default false
5691
5716
  */
5692
5717
  matchCase?: boolean;
5693
5718
  /**
5694
- * @defaultValue false
5695
- *
5696
5719
  * Only searches from the start of words.
5720
+ *
5721
+ * @default false
5697
5722
  */
5698
5723
  wordStart?: boolean;
5699
5724
  /**
5700
- * @defaultValue false
5701
- *
5702
5725
  * 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>
5703
5726
  * lowercase or non-letter. Accepts several other intra-word matches.
5727
+ *
5728
+ * @default false
5704
5729
  */
5705
5730
  medialCapitalAsWordStart?: boolean;
5706
5731
  };
@@ -6214,9 +6239,9 @@ declare type Hotkey = {
6214
6239
  */
6215
6240
  keys: string;
6216
6241
  /**
6217
- * @defaultValue false
6218
- *
6219
6242
  * Prevent default key handling before emitting the event.
6243
+ *
6244
+ * @default false
6220
6245
  */
6221
6246
  preventDefault?: boolean;
6222
6247
  };
@@ -8778,77 +8803,79 @@ declare type LayoutOptions = {
8778
8803
  */
8779
8804
  newTabButtonUrl?: string;
8780
8805
  /**
8781
- * @defaultValue false
8782
- *
8783
8806
  * When true the splitters will not be draggable and the layout will not resize.
8807
+ *
8808
+ * @default false
8784
8809
  */
8785
8810
  preventSplitterResize?: boolean;
8786
8811
  /**
8787
- * @defaultValue false
8788
- *
8789
8812
  * Whether the popout button will only act on the entire stack,
8790
8813
  * as opposed to only the active tab.
8814
+ *
8815
+ * @default false
8791
8816
  */
8792
8817
  popoutWholeStack?: boolean;
8793
8818
  /**
8794
- * @defaultValue false
8795
- *
8796
8819
  * Limits the area to which tabs can be dragged.
8797
8820
  * If true, the layout container is the only area where tabs can be dropped.
8821
+ *
8822
+ * @default false
8798
8823
  */
8799
8824
  constrainDragToContainer?: boolean;
8800
8825
  /**
8801
- * @defaultValue false
8802
- *
8803
8826
  * Whether to show the popout button on stack header.
8804
8827
  * The button will create a new window with current tab as its content.
8805
8828
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8829
+ *
8830
+ * @default false
8806
8831
  */
8807
8832
  showPopoutIcon?: boolean;
8808
8833
  /**
8809
- * @defaultValue false
8810
- *
8811
8834
  * Whether to show the maximize button on stack header.
8812
8835
  * The button will maximize the current tab to fill the entire window.
8836
+ *
8837
+ * @default false
8813
8838
  */
8814
8839
  showMaximiseIcon?: boolean;
8815
8840
  /**
8816
- * @defaultValue false
8817
- *
8818
8841
  * Whether to show the close button on stack header
8819
8842
  * (not to be confused with close button on every tab).
8843
+ *
8844
+ * @default false
8820
8845
  */
8821
8846
  showCloseIcon?: boolean;
8822
8847
  /**
8823
- * @defaultValue false
8824
- *
8825
8848
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8849
+ *
8850
+ * @default false
8826
8851
  */
8827
8852
  constrainDragToHeaders?: boolean;
8828
8853
  /**
8829
- * @defaultValue true
8830
- *
8831
8854
  * Turns tab headers on or off.
8832
8855
  * If false, the layout will be displayed with splitters only.
8856
+ *
8857
+ * @default true
8833
8858
  */
8834
8859
  hasHeaders?: boolean;
8835
8860
  /**
8836
- * @defaultValue true
8837
- *
8838
8861
  * If true, the user can re-arrange the layout by
8839
8862
  * dragging items by their tabs to the desired location.
8863
+ *
8864
+ * @default true
8840
8865
  */
8841
8866
  reorderEnabled?: boolean;
8842
8867
  /**
8843
- * @defaultValue false
8844
- *
8845
8868
  * If true, tabs can't be dragged out of the window.
8869
+ *
8870
+ * @default false
8846
8871
  */
8847
8872
  preventDragOut?: boolean;
8848
8873
  /**
8849
- * @defaultValue false
8874
+ * @defaultValue=false
8850
8875
  *
8851
8876
  * If true, tabs can't be dragged into the window.
8877
+ *
8878
+ * @default false
8852
8879
  */
8853
8880
  preventDragIn?: boolean;
8854
8881
  /**
@@ -9369,10 +9396,10 @@ declare type MutableViewOptions = {
9369
9396
  /**
9370
9397
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9371
9398
  *
9372
- * @defaultValue true
9373
- *
9374
9399
  * Show the context menu when right-clicking on the view.
9375
9400
  * Gives access to the devtools for the view.
9401
+ *
9402
+ * @default true
9376
9403
  */
9377
9404
  contextMenu: boolean;
9378
9405
  /**
@@ -9419,24 +9446,25 @@ declare type MutableViewOptions = {
9419
9446
  contentNavigation: ContentNavigation;
9420
9447
  contentRedirect: ContentRedirect;
9421
9448
  /**
9422
- * @defaultValue false
9423
9449
  * @deprecated
9424
9450
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9425
9451
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9452
+ *
9453
+ * @default false
9426
9454
  */
9427
9455
  detachOnClose: boolean;
9428
9456
  /**
9429
- * @defaultValue true
9430
- *
9431
9457
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9432
9458
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9433
9459
  * if the view isn't part of the new layout when running `Layout.replace`.
9460
+ *
9461
+ * @default true
9434
9462
  */
9435
9463
  isClosable: boolean;
9436
9464
  /**
9437
- * @defaultValue false
9438
- *
9439
9465
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9466
+ *
9467
+ * @default false
9440
9468
  */
9441
9469
  preventDragOut: boolean;
9442
9470
  interop?: InteropConfig;
@@ -9448,7 +9476,7 @@ declare type MutableViewOptions = {
9448
9476
  /**
9449
9477
  * {@inheritDoc ViewThrottling}
9450
9478
  *
9451
- * @defaultValue 'enabled'
9479
+ * @default 'enabled'
9452
9480
  */
9453
9481
  throttling: ViewThrottling;
9454
9482
  /**
@@ -9467,7 +9495,7 @@ declare type MutableWindowOptions = {
9467
9495
  * Turns anything of matching RGB value transparent.
9468
9496
  *
9469
9497
  * Caveats:
9470
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9498
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9471
9499
  * * User cannot click-through transparent regions
9472
9500
  * * Not supported on Mac
9473
9501
  * * Windows Aero must be enabled
@@ -9476,25 +9504,25 @@ declare type MutableWindowOptions = {
9476
9504
  */
9477
9505
  alphaMask: RGB;
9478
9506
  /**
9479
- * @defaultValue false
9480
- *
9481
9507
  * Always position the window at the top of the window stack.
9508
+ *
9509
+ * @default false
9482
9510
  */
9483
9511
  alwaysOnTop: boolean;
9484
9512
  /**
9485
- * @defaultValue 0
9486
- *
9487
9513
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9488
9514
  * an aspect ratio will not be enforced.
9515
+ *
9516
+ * @default 0
9489
9517
  */
9490
9518
  aspectRatio: number;
9491
9519
  /**
9492
9520
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9493
9521
  *
9494
- * @defaultValue true
9495
- *
9496
9522
  * Show the context menu when right-clicking on the window.
9497
9523
  * Gives access to the devtools for the window.
9524
+ *
9525
+ * @default true
9498
9526
  */
9499
9527
  contextMenu: boolean;
9500
9528
  /**
@@ -9561,16 +9589,17 @@ declare type MutableWindowOptions = {
9561
9589
  */
9562
9590
  customData: any;
9563
9591
  /**
9564
- * @defaultValue true
9565
9592
  * @deprecated Will be removed in runtime version 45
9566
9593
  *
9567
9594
  * Show the window's frame.
9595
+ *
9596
+ * @default true
9568
9597
  */
9569
9598
  frame: boolean;
9570
9599
  /**
9571
- * @defaultValue false
9572
- *
9573
9600
  * Hides the window instead of closing it when the close button is pressed.
9601
+ *
9602
+ * @default false
9574
9603
  */
9575
9604
  hideOnClose: boolean;
9576
9605
  /**
@@ -9623,60 +9652,61 @@ declare type MutableWindowOptions = {
9623
9652
  */
9624
9653
  icon: string;
9625
9654
  /**
9626
- * @defaultValue true
9627
- *
9628
9655
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9629
9656
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9657
+ *
9658
+ * @default true
9630
9659
  */
9631
9660
  includeInSnapshots: boolean;
9632
9661
  /**
9633
- * @defaultValue -1
9634
- *
9635
9662
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9663
+ *
9664
+ * @default -1
9636
9665
  */
9637
9666
  maxHeight: number;
9638
9667
  /**
9639
- * @defaultValue true
9640
- *
9641
9668
  * Allows the window to be maximized.
9669
+ *
9670
+ * @default true
9642
9671
  */
9643
9672
  maximizable: boolean;
9644
9673
  /**
9645
- * @defaultValue -1
9646
- *
9647
9674
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9675
+ *
9676
+ * @default -1
9648
9677
  */
9649
9678
  maxWidth: number;
9650
9679
  /**
9651
- * @defaultValue 0
9652
- *
9653
9680
  * The minimum height of the window.
9681
+ *
9682
+ * @default 0
9654
9683
  */
9655
9684
  minHeight: number;
9656
9685
  /**
9657
- * @defaultValue true
9658
- *
9659
9686
  * Allows the window to be minimized.
9687
+ *
9688
+ * @default true
9660
9689
  */
9661
9690
  minimizable: boolean;
9662
9691
  /**
9663
- * @defaultValue true
9664
- *
9665
9692
  * The minimum width of the window.
9693
+ *
9694
+ * @default true
9666
9695
  */
9667
9696
  minWidth: number;
9668
9697
  /**
9669
- * @defaultValue 1
9670
- *
9671
9698
  * A flag that specifies how transparent the window will be.
9672
9699
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9673
9700
  * This value is clamped between `0.0` and `1.0`.
9701
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9702
+ *
9703
+ * @default 1
9674
9704
  */
9675
9705
  opacity: number;
9676
9706
  /**
9677
- * @defaultValue true
9678
- *
9679
9707
  * A flag to allow the user to resize the window.
9708
+ *
9709
+ * @default true
9680
9710
  */
9681
9711
  resizable: boolean;
9682
9712
  /**
@@ -9684,16 +9714,16 @@ declare type MutableWindowOptions = {
9684
9714
  */
9685
9715
  resizeRegion: ResizeRegion;
9686
9716
  /**
9687
- * @defaultValue false
9688
- *
9689
9717
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9690
9718
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9719
+ *
9720
+ * @default false
9691
9721
  */
9692
9722
  showBackgroundImages: boolean;
9693
9723
  /**
9694
- * @defaultValue true
9695
- *
9696
9724
  * Shows the window's icon in the taskbar.
9725
+ *
9726
+ * @default true
9697
9727
  */
9698
9728
  showTaskbarIcon: boolean;
9699
9729
  /**
@@ -9720,7 +9750,7 @@ declare type MutableWindowOptions = {
9720
9750
  /**
9721
9751
  * {@inheritDoc WindowThrottling}
9722
9752
  *
9723
- * @defaultValue 'enabled'
9753
+ * @default 'enabled'
9724
9754
  *
9725
9755
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9726
9756
  */
@@ -10376,12 +10406,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10376
10406
  */
10377
10407
  declare type PastePermissions = {
10378
10408
  /**
10379
- * @defaultValue 'non-protected-content'
10380
- *
10381
10409
  * Controls the behavior for paste operations for a matched URL.
10382
10410
  *
10383
10411
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10384
10412
  * 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.
10413
+ *
10414
+ * @default 'non-protected-content'
10385
10415
  */
10386
10416
  behavior: 'non-protected-content' | 'all-content';
10387
10417
  };
@@ -11451,11 +11481,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11451
11481
  */
11452
11482
  providerUrl?: string;
11453
11483
  /**
11454
- * @defaultValue true
11455
- *
11456
11484
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11457
11485
  *
11458
11486
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11487
+ *
11488
+ * @default true
11459
11489
  */
11460
11490
  allowLaunchIntoPlatform?: boolean;
11461
11491
  };
@@ -12148,22 +12178,22 @@ declare type PopupOptions = {
12148
12178
  url?: string;
12149
12179
  /**
12150
12180
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
12151
- * @defaultValue 300
12181
+ * @default 300
12152
12182
  */
12153
12183
  height?: number;
12154
12184
  /**
12155
12185
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
12156
- * @defaultValue 300
12186
+ * @default 300
12157
12187
  */
12158
12188
  width?: number;
12159
12189
  /**
12160
12190
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12161
- * @defaultValue 0
12191
+ * @default 0
12162
12192
  */
12163
12193
  x?: number;
12164
12194
  /**
12165
12195
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12166
- * @defaultValue 0
12196
+ * @default 0
12167
12197
  */
12168
12198
  y?: number;
12169
12199
  /**
@@ -12171,7 +12201,7 @@ declare type PopupOptions = {
12171
12201
  * * 'modal' restricts resizing and positioning in the caller.
12172
12202
  * * 'hide' hides the popup window on blur.
12173
12203
  * * 'close' closes the popup window on blur.
12174
- * @defaultValue 'close'
12204
+ * @default 'close'
12175
12205
  */
12176
12206
  blurBehavior?: PopupBlurBehavior;
12177
12207
  /**
@@ -12179,19 +12209,19 @@ declare type PopupOptions = {
12179
12209
  * * 'none' will do nothing.
12180
12210
  * * 'hide' hides the popup window on `dispatchPopupResult`.
12181
12211
  * * 'close' closes the popup window on `dispatchPopupResult`.
12182
- * @defaultValue 'close'
12212
+ * @default 'close'
12183
12213
  */
12184
12214
  resultDispatchBehavior?: PopupResultBehavior;
12185
12215
  /**
12186
12216
  * Hide the popup window instead of closing when `close` is called on it.
12187
12217
  *
12188
12218
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
12189
- * @defaultValue false
12219
+ * @default false
12190
12220
  */
12191
12221
  hideOnClose?: boolean;
12192
12222
  /**
12193
12223
  * Determines if the popup window should or should not be focused when it is shown.
12194
- * @defaultValue true
12224
+ * @default true
12195
12225
  */
12196
12226
  focus?: boolean;
12197
12227
  /**
@@ -12285,9 +12315,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12285
12315
  */
12286
12316
  declare type PreloadScript = {
12287
12317
  /**
12288
- * @defaultValue false
12289
- *
12290
12318
  * Fail to load the window if this preload script fails
12319
+ *
12320
+ * @default false
12291
12321
  */
12292
12322
  mandatory?: boolean;
12293
12323
  /**
@@ -12379,15 +12409,15 @@ declare type PrinterInfo = {
12379
12409
  declare type PrintOptions = {
12380
12410
  content?: 'self';
12381
12411
  /**
12382
- * @defaultValue false
12383
- *
12384
12412
  * Disables prompting the user for print settings.
12413
+ *
12414
+ * @default false
12385
12415
  */
12386
12416
  silent?: boolean;
12387
12417
  /**
12388
- * @defaultValue false
12389
- *
12390
12418
  * Includes the webpage background color and image when printing.
12419
+ *
12420
+ * @default false
12391
12421
  */
12392
12422
  printBackground?: boolean;
12393
12423
  /**
@@ -12395,9 +12425,9 @@ declare type PrintOptions = {
12395
12425
  */
12396
12426
  deviceName?: string;
12397
12427
  /**
12398
- * @defaultValue true
12399
- *
12400
12428
  * Prints in full color (greyscale otherwise).
12429
+ *
12430
+ * @default true
12401
12431
  */
12402
12432
  color?: boolean;
12403
12433
  /**
@@ -12405,9 +12435,9 @@ declare type PrintOptions = {
12405
12435
  */
12406
12436
  margins?: Margins;
12407
12437
  /**
12408
- * @defaultValue true
12409
- *
12410
12438
  * Prints in landscape mode (portrait otherwise).
12439
+ *
12440
+ * @default true
12411
12441
  */
12412
12442
  landscape?: boolean;
12413
12443
  /**
@@ -13783,15 +13813,15 @@ declare type ReplaceViewPayload = {
13783
13813
  */
13784
13814
  declare type ResizeRegion = {
13785
13815
  /**
13786
- * @defaultValue 7
13787
- *
13788
13816
  * The size of the resize region in pixels.
13817
+ *
13818
+ * @default 7
13789
13819
  */
13790
13820
  size?: number;
13791
13821
  /**
13792
- * @defaultValue 9
13793
- *
13794
13822
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13823
+ *
13824
+ * @default 9
13795
13825
  */
13796
13826
  bottomRightCorner?: number;
13797
13827
  /**
@@ -13799,27 +13829,27 @@ declare type ResizeRegion = {
13799
13829
  */
13800
13830
  sides?: {
13801
13831
  /**
13802
- * @defaultValue true
13803
- *
13804
13832
  * Enables resizing from the top of the window.
13833
+ *
13834
+ * @default true
13805
13835
  */
13806
13836
  top?: boolean;
13807
13837
  /**
13808
- * @defaultValue true
13809
- *
13810
13838
  * Enables resizing from the bottom of the window.
13839
+ *
13840
+ * @default true
13811
13841
  */
13812
13842
  bottom?: boolean;
13813
13843
  /**
13814
- * @defaultValue true
13815
- *
13816
13844
  * Enables resizing from the left side of the window.
13845
+ *
13846
+ * @default true
13817
13847
  */
13818
13848
  left?: boolean;
13819
13849
  /**
13820
- * @defaultValue true
13821
- *
13822
13850
  * Enables resizing from the right side of the window.
13851
+ *
13852
+ * @default true
13823
13853
  */
13824
13854
  right?: boolean;
13825
13855
  };
@@ -14373,9 +14403,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
14373
14403
  */
14374
14404
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
14375
14405
  /**
14376
- * @defaultValue 0
14377
- *
14378
14406
  * Number of milliseconds to wait between view repaints.
14407
+ *
14408
+ * @default 0
14379
14409
  */
14380
14410
  paintIntervalMs?: number;
14381
14411
  };
@@ -16440,9 +16470,9 @@ declare type TransitionBase = {
16440
16470
  */
16441
16471
  duration: number;
16442
16472
  /**
16443
- * @defaultValue false
16444
- *
16445
16473
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16474
+ *
16475
+ * @default false
16446
16476
  */
16447
16477
  relative?: boolean;
16448
16478
  };
@@ -16458,9 +16488,9 @@ declare type TransitionOptions = {
16458
16488
  */
16459
16489
  interrupt: boolean;
16460
16490
  /**
16461
- * @defaultValue false
16462
- *
16463
16491
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16492
+ *
16493
+ * @default false
16464
16494
  */
16465
16495
  relative?: boolean;
16466
16496
  tween?: tween;
@@ -17425,9 +17455,9 @@ declare type ViewTitlePriority = 'document' | 'options';
17425
17455
  */
17426
17456
  declare type ViewVisibilityOption = {
17427
17457
  /**
17428
- * @defaultValue false
17429
- *
17430
17458
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17459
+ *
17460
+ * @default false
17431
17461
  */
17432
17462
  enabled?: boolean;
17433
17463
  };