@openfin/core 40.105.4 → 40.105.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.
@@ -129,13 +129,13 @@ declare type ApiSettings = {
129
129
  /**
130
130
  * Inject OpenFin API into cross-origin iframes
131
131
  *
132
- * @defaultValue false
132
+ * @default false
133
133
  */
134
134
  crossOriginInjection?: boolean;
135
135
  /**
136
136
  * Inject OpenFin API into same-origin iframes
137
137
  *
138
- * @defaultValue true
138
+ * @default true
139
139
  */
140
140
  sameOriginInjection?: boolean;
141
141
  /**
@@ -1174,19 +1174,19 @@ declare class ApplicationModule extends Base {
1174
1174
  */
1175
1175
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1176
1176
  /**
1177
- * @defaultValue false
1178
- *
1179
1177
  * Disables IAB secure logging for the app.
1178
+ *
1179
+ * @default false
1180
1180
  */
1181
1181
  disableIabSecureLogging: boolean;
1182
1182
  /**
1183
- * @defaultValue 'There was an error loading the application.'
1184
- *
1185
1183
  * An error message to display when the application (launched via manifest) fails to load.
1186
1184
  * A dialog box will be launched with the error message just before the runtime exits.
1187
1185
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1188
1186
  * will trigger this dialog.
1189
1187
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1188
+ *
1189
+ * @default 'There was an error loading the application.'
1190
1190
  */
1191
1191
  loadErrorMessage: string;
1192
1192
  /**
@@ -1205,28 +1205,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1205
1205
  */
1206
1206
  name: string;
1207
1207
  /**
1208
- * @defaultValue false
1209
- *
1210
1208
  * A flag to configure the application as non-persistent.
1211
1209
  * Runtime exits when there are no persistent apps running.
1210
+ *
1211
+ * @default false
1212
1212
  */
1213
1213
  nonPersistent: boolean;
1214
1214
  /**
1215
- * @defaultValue false
1216
- *
1217
1215
  * Enable Flash at the application level.
1216
+ *
1217
+ * @default false
1218
1218
  */
1219
1219
  plugins: boolean;
1220
1220
  /**
1221
- * @defaultValue false
1222
- *
1223
1221
  * Enable spell check at the application level.
1222
+ *
1223
+ * @default false
1224
1224
  */
1225
1225
  spellCheck: boolean;
1226
1226
  /**
1227
- * @defaultValue 'about:blank'
1228
- *
1229
1227
  * The url to the application (specifically the application's main window).
1228
+ *
1229
+ * @default 'about:blank'
1230
1230
  */
1231
1231
  url: string;
1232
1232
  /**
@@ -1235,9 +1235,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1235
1235
  */
1236
1236
  uuid: string;
1237
1237
  /**
1238
- * @defaultValue true
1239
- *
1240
1238
  * When set to `false` it will disable the same-origin policy for the app.
1239
+ *
1240
+ * @default true
1241
1241
  */
1242
1242
  webSecurity: boolean;
1243
1243
  /**
@@ -1247,10 +1247,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1247
1247
  commands: ShortcutOverride[];
1248
1248
  isPlatformController: boolean;
1249
1249
  /**
1250
- * @defaultValue 1000
1251
- *
1252
1250
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1253
1251
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1252
+ *
1253
+ * @default 1000
1254
1254
  */
1255
1255
  maxViewPoolSize: number;
1256
1256
  /**
@@ -1266,12 +1266,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1266
1266
  */
1267
1267
  snapshot: Snapshot;
1268
1268
  /**
1269
- * @defaultValue false
1270
- *
1271
1269
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1272
1270
  *
1273
1271
  * Note: if the Platform Provider is showing, it won't close automatically.
1274
1272
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1273
+ *
1274
+ * @default false
1275
1275
  */
1276
1276
  preventQuitOnLastWindowClosed: boolean;
1277
1277
  /**
@@ -1279,9 +1279,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1279
1279
  */
1280
1280
  interopBrokerConfiguration: InteropBrokerOptions;
1281
1281
  /**
1282
- * @defaultValue true
1283
- *
1284
1282
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1283
+ *
1284
+ * @default true
1285
1285
  */
1286
1286
  apiDiagnostics: boolean;
1287
1287
  /**
@@ -1297,16 +1297,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1297
1297
  */
1298
1298
  permissions?: Partial<Permissions_2>;
1299
1299
  /**
1300
- * @defaultValue false
1301
- *
1302
1300
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1303
1301
  * Only relevant in Windows.
1302
+ *
1303
+ * @default false
1304
1304
  */
1305
1305
  enableJumpList: boolean;
1306
1306
  /**
1307
- * @defaultValue false
1308
- *
1309
1307
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1308
+ *
1309
+ * @default false
1310
1310
  */
1311
1311
  enableBeforeUnload: boolean;
1312
1312
  /**
@@ -1387,25 +1387,25 @@ declare type ApplicationWindowInfo = {
1387
1387
  */
1388
1388
  declare type ApplySnapshotOptions = {
1389
1389
  /**
1390
- * @defaultValue false
1391
- *
1392
1390
  * When true, applySnapshot will close existing windows,
1393
1391
  * replacing current Platform state with the given snapshot.
1392
+ *
1393
+ * @default false
1394
1394
  */
1395
1395
  closeExistingWindows?: boolean;
1396
1396
  /**
1397
- * @defaultValue false
1398
- *
1399
1397
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1400
1398
  * replacing current Platform state with the given snapshot.
1399
+ *
1400
+ * @default false
1401
1401
  */
1402
1402
  closeSnapshotWindows?: boolean;
1403
1403
  /**
1404
- * @defaultValue false
1405
- *
1406
1404
  * When true, applySnapshot will not check whether any windows in a
1407
1405
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1408
1406
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1407
+ *
1408
+ * @default false
1409
1409
  */
1410
1410
  skipOutOfBoundsCheck?: boolean;
1411
1411
  };
@@ -2062,15 +2062,15 @@ declare type CapturePageOptions = {
2062
2062
  */
2063
2063
  area?: Rectangle;
2064
2064
  /**
2065
- * @defaultValue 'png'
2066
- *
2067
2065
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2066
+ *
2067
+ * @default 'png'
2068
2068
  */
2069
2069
  format?: 'bmp' | 'jpg' | 'png';
2070
2070
  /**
2071
- * @defaultValue 100
2072
- *
2073
2071
  * Quality of JPEG image. Between 0 - 100.
2072
+ *
2073
+ * @default 100
2074
2074
  */
2075
2075
  quality?: number;
2076
2076
  };
@@ -2703,9 +2703,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2703
2703
  */
2704
2704
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2705
2705
  /**
2706
- * @defaultValue true
2707
- *
2708
2706
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2707
+ *
2708
+ * @default true
2709
2709
  */
2710
2710
  wait?: boolean;
2711
2711
  /**
@@ -2999,6 +2999,10 @@ declare type ChromiumPolicies = {
2999
2999
  * Disable AutofillAddressEnabled policy for a Window or View.
3000
3000
  */
3001
3001
  AutofillAddressEnabled?: PolicyOptions;
3002
+ /**
3003
+ * Disable AutofillCreditCardEnabled policy for a Window or View.
3004
+ */
3005
+ AutofillCreditCardEnabled?: PolicyOptions;
3002
3006
  };
3003
3007
 
3004
3008
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3364,9 +3368,9 @@ declare interface CloseWindowPayload {
3364
3368
  windowId: Identity_4;
3365
3369
  options: {
3366
3370
  /**
3367
- * @defaultValue false
3368
- *
3369
3371
  * When set to true skips any before handler set on views that are part of the window
3372
+ *
3373
+ * @default false
3370
3374
  */
3371
3375
  skipBeforeUnload?: boolean;
3372
3376
  };
@@ -3471,9 +3475,9 @@ declare type ConstViewOptions = {
3471
3475
  */
3472
3476
  name: string;
3473
3477
  /**
3474
- * @defaultValue "about:blank"
3475
- *
3476
3478
  * The URL of the window
3479
+ *
3480
+ * @default "about:blank"
3477
3481
  */
3478
3482
  url: string;
3479
3483
  /**
@@ -3531,9 +3535,9 @@ declare type ConstViewOptions = {
3531
3535
  experimental: any;
3532
3536
  fdc3InteropApi?: string;
3533
3537
  /**
3534
- * @defaultValue false
3535
- *
3536
3538
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3539
+ *
3540
+ * @default false
3537
3541
  */
3538
3542
  enableBeforeUnload: boolean;
3539
3543
  /**
@@ -3614,13 +3618,12 @@ declare type ConstWindowOptions = {
3614
3618
  */
3615
3619
  backgroundColor: string;
3616
3620
  /**
3617
- * @defaultValue false
3618
- *
3619
3621
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3620
3622
  * This also affects the Page Visibility API.
3621
3623
  *
3622
3624
  * When `true`, the page is throttled whether it is hidden or not.
3623
3625
  *
3626
+ * @default false
3624
3627
  */
3625
3628
  backgroundThrottling: boolean;
3626
3629
  /**
@@ -3644,21 +3647,21 @@ declare type ConstWindowOptions = {
3644
3647
  */
3645
3648
  customRequestHeaders: CustomRequestHeaders[];
3646
3649
  /**
3647
- * @defaultValue true
3648
- *
3649
3650
  * Setting this to false would keep the Window alive even if all its Views were closed.
3650
3651
  * This is meant for advanced users and should be used with caution.
3651
3652
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3652
3653
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3653
3654
  * **NOTE:** - This option is ignored in non-Platforms apps.
3655
+ *
3656
+ * @default true
3654
3657
  */
3655
3658
  closeOnLastViewRemoved: boolean;
3656
3659
  /**
3657
- * @defaultValue 'all'
3658
- *
3659
3660
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3660
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3661
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3661
3662
  * **NOTE:** - This option is ignored in non-Platforms apps.
3663
+ *
3664
+ * @default 'all'
3662
3665
  */
3663
3666
  viewsPreventingClose: 'all' | 'layout';
3664
3667
  /**
@@ -3669,31 +3672,31 @@ declare type ConstWindowOptions = {
3669
3672
  */
3670
3673
  defaultCentered: boolean;
3671
3674
  /**
3672
- * @defaultValue 500
3673
- *
3674
3675
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3675
3676
  * in favor of the cached value.
3677
+ *
3678
+ * @default 500
3676
3679
  */
3677
3680
  defaultHeight: number;
3678
3681
  /**
3679
- * @defaultValue 100
3680
- *
3681
3682
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3682
3683
  * launches in favor of the cached value.
3684
+ *
3685
+ * @default 100
3683
3686
  */
3684
3687
  defaultLeft: number;
3685
3688
  /**
3686
- * @defaultValue 100
3687
- *
3688
3689
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3689
3690
  * launches in favor of the cached value.
3691
+ *
3692
+ * @default 100
3690
3693
  */
3691
3694
  defaultTop: number;
3692
3695
  /**
3693
- * @defaultValue 800
3694
- *
3695
3696
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3696
3697
  * launches in favor of the cached value.
3698
+ *
3699
+ * @default 800
3697
3700
  */
3698
3701
  defaultWidth: number;
3699
3702
  /**
@@ -3739,19 +3742,19 @@ declare type ConstWindowOptions = {
3739
3742
  */
3740
3743
  processAffinity: string;
3741
3744
  /**
3742
- * @defaultValue false
3743
- *
3744
3745
  * Displays a shadow on frameless windows.
3745
3746
  * `shadow` and `cornerRounding` are mutually exclusive.
3746
3747
  * On Windows 7, Aero theme is required.
3748
+ *
3749
+ * @default false
3747
3750
  */
3748
3751
  shadow: boolean;
3749
3752
  /**
3750
- * @defaultValue true
3751
- *
3752
3753
  * Caches the location of the window.
3753
3754
  *
3754
3755
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3756
+ *
3757
+ * @default true
3755
3758
  */
3756
3759
  saveWindowState: boolean;
3757
3760
  /**
@@ -3760,22 +3763,22 @@ declare type ConstWindowOptions = {
3760
3763
  */
3761
3764
  ignoreSavedWindowState: boolean;
3762
3765
  /**
3763
- * @defaultValue false
3764
- *
3765
3766
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3766
3767
  *
3767
3768
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3768
3769
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3770
+ *
3771
+ * @default false
3769
3772
  */
3770
3773
  smallWindow: boolean;
3771
3774
  /**
3772
- * @defaultValue "normal"
3773
- *
3774
3775
  * The visible state of the window on creation.
3775
3776
  * One of:
3776
3777
  * * `"maximized"`
3777
3778
  * * `"minimized"`
3778
3779
  * * `"normal"`
3780
+ *
3781
+ * @default "normal"
3779
3782
  */
3780
3783
  state: WindowState;
3781
3784
  /**
@@ -3789,20 +3792,20 @@ declare type ConstWindowOptions = {
3789
3792
  */
3790
3793
  url: string;
3791
3794
  /**
3792
- * @defaultValue <application UUID>
3793
- *
3794
3795
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3795
3796
  * If omitted, defaults to the `uuid` of the application spawning the window.
3796
3797
  * If given, must match the `uuid` of the application spawning the window.
3797
3798
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3798
3799
  * really no need to provide it.
3800
+ *
3801
+ * @default <application UUID>
3799
3802
  */
3800
3803
  uuid: string;
3801
3804
  /**
3802
- * @defaultValue false
3803
- *
3804
3805
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3805
3806
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3807
+ *
3808
+ * @default false
3806
3809
  */
3807
3810
  waitForPageLoad: boolean;
3808
3811
  width: number;
@@ -4074,13 +4077,13 @@ declare type CopyBlockedEventReason = 'disabled';
4074
4077
  */
4075
4078
  declare type CopyPermissions = {
4076
4079
  /**
4077
- * @defaultValue 'allowed'
4078
- *
4079
4080
  * Controls the behavior for copy operations for a matched URL.
4080
4081
  *
4081
4082
  * allow: Enables all copy operations.
4082
4083
  * block: Disables all copy operations.
4083
4084
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4085
+ *
4086
+ * @default 'allowed'
4084
4087
  */
4085
4088
  behavior: 'allow' | 'block' | 'protect';
4086
4089
  /**
@@ -4088,9 +4091,9 @@ declare type CopyPermissions = {
4088
4091
  */
4089
4092
  options?: {
4090
4093
  /**
4091
- * @defaultValue ''
4092
- *
4093
4094
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4095
+ *
4096
+ * @default ''
4094
4097
  */
4095
4098
  replacementText: string;
4096
4099
  };
@@ -4104,15 +4107,15 @@ declare type CopyPermissions = {
4104
4107
  */
4105
4108
  declare type CornerRounding = {
4106
4109
  /**
4107
- * @defaultValue 0
4108
- *
4109
4110
  * The height in pixels.
4111
+ *
4112
+ * @default 0
4110
4113
  */
4111
4114
  height: number;
4112
4115
  /**
4113
- * @defaultValue 0
4114
- *
4115
4116
  * The width in pixels.
4117
+ *
4118
+ * @default 0
4116
4119
  */
4117
4120
  width: number;
4118
4121
  };
@@ -4202,8 +4205,6 @@ declare type CreateLayoutOptions = {
4202
4205
  layoutName: string;
4203
4206
  layout: LayoutOptions;
4204
4207
  /**
4205
- * @defaultValue 'default'
4206
- *
4207
4208
  * Controls the View behavior for the given `layout` property. Note
4208
4209
  * that the selected behavior only applies to unnamed Views or
4209
4210
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4225,6 +4226,8 @@ declare type CreateLayoutOptions = {
4225
4226
  * override. Note that during applyLayoutSnapshot, Views are created and
4226
4227
  * attached to the Provider while the Window is being created, so it's
4227
4228
  * important to not 'duplicate' Views in this workflow.
4229
+ *
4230
+ * @default 'default'
4228
4231
  */
4229
4232
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4230
4233
  };
@@ -4484,7 +4487,7 @@ declare type DomainApiSettings = {
4484
4487
  * * 'none': The `fin` API will be not available.
4485
4488
  * * 'global': The entire `fin` API will be available.
4486
4489
  *
4487
- * @defaultValue 'global'
4490
+ * @default 'global'
4488
4491
  */
4489
4492
  fin?: InjectionType;
4490
4493
  /**
@@ -5062,9 +5065,9 @@ declare type EventType_9 = Event_12['type'];
5062
5065
  */
5063
5066
  declare type ExcludeOptions = {
5064
5067
  /**
5065
- * @defaultValue false
5066
- *
5067
5068
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5069
+ *
5070
+ * @default false
5068
5071
  */
5069
5072
  preloadScripts: boolean;
5070
5073
  };
@@ -5538,34 +5541,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5538
5541
  */
5539
5542
  declare type FindInPageOptions = {
5540
5543
  /**
5541
- * @defaultValue true
5542
- *
5543
5544
  * Searches in the forward direction (backward otherwise)
5545
+ *
5546
+ * @default true
5544
5547
  */
5545
5548
  forward?: boolean;
5546
5549
  /**
5547
- * @defaultValue false
5548
- *
5549
5550
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5551
+ *
5552
+ * @default false
5550
5553
  */
5551
5554
  findNext?: boolean;
5552
5555
  /**
5553
- * @defaultValue false
5554
- *
5555
5556
  * Enables case-sensitive searching.
5557
+ *
5558
+ * @default false
5556
5559
  */
5557
5560
  matchCase?: boolean;
5558
5561
  /**
5559
- * @defaultValue false
5560
- *
5561
5562
  * Only searches from the start of words.
5563
+ *
5564
+ * @default false
5562
5565
  */
5563
5566
  wordStart?: boolean;
5564
5567
  /**
5565
- * @defaultValue false
5566
- *
5567
5568
  * 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>
5568
5569
  * lowercase or non-letter. Accepts several other intra-word matches.
5570
+ *
5571
+ * @default false
5569
5572
  */
5570
5573
  medialCapitalAsWordStart?: boolean;
5571
5574
  };
@@ -6073,9 +6076,9 @@ declare type Hotkey = {
6073
6076
  */
6074
6077
  keys: string;
6075
6078
  /**
6076
- * @defaultValue false
6077
- *
6078
6079
  * Prevent default key handling before emitting the event.
6080
+ *
6081
+ * @default false
6079
6082
  */
6080
6083
  preventDefault?: boolean;
6081
6084
  };
@@ -8411,77 +8414,79 @@ declare type LayoutOptions = {
8411
8414
  */
8412
8415
  settings?: {
8413
8416
  /**
8414
- * @defaultValue false
8415
- *
8416
8417
  * When true the splitters will not be draggable and the layout will not resize.
8418
+ *
8419
+ * @default false
8417
8420
  */
8418
8421
  preventSplitterResize?: boolean;
8419
8422
  /**
8420
- * @defaultValue false
8421
- *
8422
8423
  * Whether the popout button will only act on the entire stack,
8423
8424
  * as opposed to only the active tab.
8425
+ *
8426
+ * @default false
8424
8427
  */
8425
8428
  popoutWholeStack?: boolean;
8426
8429
  /**
8427
- * @defaultValue false
8428
- *
8429
8430
  * Limits the area to which tabs can be dragged.
8430
8431
  * If true, the layout container is the only area where tabs can be dropped.
8432
+ *
8433
+ * @default false
8431
8434
  */
8432
8435
  constrainDragToContainer?: boolean;
8433
8436
  /**
8434
- * @defaultValue false
8435
- *
8436
8437
  * Whether to show the popout button on stack header.
8437
8438
  * The button will create a new window with current tab as its content.
8438
8439
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8440
+ *
8441
+ * @default false
8439
8442
  */
8440
8443
  showPopoutIcon?: boolean;
8441
8444
  /**
8442
- * @defaultValue false
8443
- *
8444
8445
  * Whether to show the maximize button on stack header.
8445
8446
  * The button will maximize the current tab to fill the entire window.
8447
+ *
8448
+ * @default false
8446
8449
  */
8447
8450
  showMaximiseIcon?: boolean;
8448
8451
  /**
8449
- * @defaultValue false
8450
- *
8451
8452
  * Whether to show the close button on stack header
8452
8453
  * (not to be confused with close button on every tab).
8454
+ *
8455
+ * @default false
8453
8456
  */
8454
8457
  showCloseIcon?: boolean;
8455
8458
  /**
8456
- * @defaultValue false
8457
- *
8458
8459
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8460
+ *
8461
+ * @default false
8459
8462
  */
8460
8463
  constrainDragToHeaders?: boolean;
8461
8464
  /**
8462
- * @defaultValue true
8463
- *
8464
8465
  * Turns tab headers on or off.
8465
8466
  * If false, the layout will be displayed with splitters only.
8467
+ *
8468
+ * @default true
8466
8469
  */
8467
8470
  hasHeaders?: boolean;
8468
8471
  /**
8469
- * @defaultValue true
8470
- *
8471
8472
  * If true, the user can re-arrange the layout by
8472
8473
  * dragging items by their tabs to the desired location.
8474
+ *
8475
+ * @default true
8473
8476
  */
8474
8477
  reorderEnabled?: boolean;
8475
8478
  /**
8476
- * @defaultValue false
8477
- *
8478
8479
  * If true, tabs can't be dragged out of the window.
8480
+ *
8481
+ * @default false
8479
8482
  */
8480
8483
  preventDragOut?: boolean;
8481
8484
  /**
8482
8485
  * @defaultValue=false
8483
8486
  *
8484
8487
  * If true, tabs can't be dragged into the window.
8488
+ *
8489
+ * @default false
8485
8490
  */
8486
8491
  preventDragIn?: boolean;
8487
8492
  };
@@ -8924,10 +8929,10 @@ declare type MutableViewOptions = {
8924
8929
  /**
8925
8930
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
8926
8931
  *
8927
- * @defaultValue true
8928
- *
8929
8932
  * Show the context menu when right-clicking on the view.
8930
8933
  * Gives access to the devtools for the view.
8934
+ *
8935
+ * @default true
8931
8936
  */
8932
8937
  contextMenu: boolean;
8933
8938
  /**
@@ -8974,24 +8979,25 @@ declare type MutableViewOptions = {
8974
8979
  contentNavigation: ContentNavigation;
8975
8980
  contentRedirect: ContentRedirect;
8976
8981
  /**
8977
- * @defaultValue false
8978
8982
  * @deprecated
8979
8983
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
8980
8984
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
8985
+ *
8986
+ * @default false
8981
8987
  */
8982
8988
  detachOnClose: boolean;
8983
8989
  /**
8984
- * @defaultValue true
8985
- *
8986
8990
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
8987
8991
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
8988
8992
  * if the view isn't part of the new layout when running `Layout.replace`.
8993
+ *
8994
+ * @default true
8989
8995
  */
8990
8996
  isClosable: boolean;
8991
8997
  /**
8992
- * @defaultValue false
8993
- *
8994
8998
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
8999
+ *
9000
+ * @default false
8995
9001
  */
8996
9002
  preventDragOut: boolean;
8997
9003
  interop?: InteropConfig;
@@ -8999,7 +9005,7 @@ declare type MutableViewOptions = {
8999
9005
  /**
9000
9006
  * {@inheritDoc ViewThrottling}
9001
9007
  *
9002
- * @defaultValue 'enabled'
9008
+ * @default 'enabled'
9003
9009
  */
9004
9010
  throttling: ViewThrottling;
9005
9011
  /**
@@ -9018,7 +9024,7 @@ declare type MutableWindowOptions = {
9018
9024
  * Turns anything of matching RGB value transparent.
9019
9025
  *
9020
9026
  * Caveats:
9021
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9027
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9022
9028
  * * User cannot click-through transparent regions
9023
9029
  * * Not supported on Mac
9024
9030
  * * Windows Aero must be enabled
@@ -9027,25 +9033,25 @@ declare type MutableWindowOptions = {
9027
9033
  */
9028
9034
  alphaMask: RGB;
9029
9035
  /**
9030
- * @defaultValue false
9031
- *
9032
9036
  * Always position the window at the top of the window stack.
9037
+ *
9038
+ * @default false
9033
9039
  */
9034
9040
  alwaysOnTop: boolean;
9035
9041
  /**
9036
- * @defaultValue 0
9037
- *
9038
9042
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9039
9043
  * an aspect ratio will not be enforced.
9044
+ *
9045
+ * @default 0
9040
9046
  */
9041
9047
  aspectRatio: number;
9042
9048
  /**
9043
9049
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9044
9050
  *
9045
- * @defaultValue true
9046
- *
9047
9051
  * Show the context menu when right-clicking on the window.
9048
9052
  * Gives access to the devtools for the window.
9053
+ *
9054
+ * @default true
9049
9055
  */
9050
9056
  contextMenu: boolean;
9051
9057
  /**
@@ -9115,12 +9121,14 @@ declare type MutableWindowOptions = {
9115
9121
  * @defaultValue true
9116
9122
  *
9117
9123
  * Show the window's frame.
9124
+ *
9125
+ * @default true
9118
9126
  */
9119
9127
  frame: boolean;
9120
9128
  /**
9121
- * @defaultValue false
9122
- *
9123
9129
  * Hides the window instead of closing it when the close button is pressed.
9130
+ *
9131
+ * @default false
9124
9132
  */
9125
9133
  hideOnClose: boolean;
9126
9134
  /**
@@ -9173,60 +9181,61 @@ declare type MutableWindowOptions = {
9173
9181
  */
9174
9182
  icon: string;
9175
9183
  /**
9176
- * @defaultValue true
9177
- *
9178
9184
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9179
9185
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9186
+ *
9187
+ * @default true
9180
9188
  */
9181
9189
  includeInSnapshots: boolean;
9182
9190
  /**
9183
- * @defaultValue -1
9184
- *
9185
9191
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9192
+ *
9193
+ * @default -1
9186
9194
  */
9187
9195
  maxHeight: number;
9188
9196
  /**
9189
- * @defaultValue true
9190
- *
9191
9197
  * Allows the window to be maximized.
9198
+ *
9199
+ * @default true
9192
9200
  */
9193
9201
  maximizable: boolean;
9194
9202
  /**
9195
- * @defaultValue -1
9196
- *
9197
9203
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9204
+ *
9205
+ * @default -1
9198
9206
  */
9199
9207
  maxWidth: number;
9200
9208
  /**
9201
- * @defaultValue 0
9202
- *
9203
9209
  * The minimum height of the window.
9210
+ *
9211
+ * @default 0
9204
9212
  */
9205
9213
  minHeight: number;
9206
9214
  /**
9207
- * @defaultValue true
9208
- *
9209
9215
  * Allows the window to be minimized.
9216
+ *
9217
+ * @default true
9210
9218
  */
9211
9219
  minimizable: boolean;
9212
9220
  /**
9213
- * @defaultValue true
9214
- *
9215
9221
  * The minimum width of the window.
9222
+ *
9223
+ * @default true
9216
9224
  */
9217
9225
  minWidth: number;
9218
9226
  /**
9219
- * @defaultValue 1
9220
- *
9221
9227
  * A flag that specifies how transparent the window will be.
9222
9228
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9223
9229
  * This value is clamped between `0.0` and `1.0`.
9230
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9231
+ *
9232
+ * @default 1
9224
9233
  */
9225
9234
  opacity: number;
9226
9235
  /**
9227
- * @defaultValue true
9228
- *
9229
9236
  * A flag to allow the user to resize the window.
9237
+ *
9238
+ * @default true
9230
9239
  */
9231
9240
  resizable: boolean;
9232
9241
  /**
@@ -9234,16 +9243,16 @@ declare type MutableWindowOptions = {
9234
9243
  */
9235
9244
  resizeRegion: ResizeRegion;
9236
9245
  /**
9237
- * @defaultValue false
9238
- *
9239
9246
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9240
9247
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9248
+ *
9249
+ * @default false
9241
9250
  */
9242
9251
  showBackgroundImages: boolean;
9243
9252
  /**
9244
- * @defaultValue true
9245
- *
9246
9253
  * Shows the window's icon in the taskbar.
9254
+ *
9255
+ * @default true
9247
9256
  */
9248
9257
  showTaskbarIcon: boolean;
9249
9258
  /**
@@ -9258,7 +9267,7 @@ declare type MutableWindowOptions = {
9258
9267
  /**
9259
9268
  * {@inheritDoc WindowThrottling}
9260
9269
  *
9261
- * @defaultValue 'enabled'
9270
+ * @default 'enabled'
9262
9271
  *
9263
9272
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9264
9273
  */
@@ -9867,12 +9876,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
9867
9876
  */
9868
9877
  declare type PastePermissions = {
9869
9878
  /**
9870
- * @defaultValue 'non-protected-content'
9871
- *
9872
9879
  * Controls the behavior for paste operations for a matched URL.
9873
9880
  *
9874
9881
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
9875
9882
  * 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.
9883
+ *
9884
+ * @default 'non-protected-content'
9876
9885
  */
9877
9886
  behavior: 'non-protected-content' | 'all-content';
9878
9887
  };
@@ -10899,11 +10908,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
10899
10908
  */
10900
10909
  providerUrl?: string;
10901
10910
  /**
10902
- * @defaultValue true
10903
- *
10904
10911
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
10905
10912
  *
10906
10913
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
10914
+ *
10915
+ * @default true
10907
10916
  */
10908
10917
  allowLaunchIntoPlatform?: boolean;
10909
10918
  };
@@ -11547,22 +11556,22 @@ declare type PopupOptions = {
11547
11556
  url?: string;
11548
11557
  /**
11549
11558
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11550
- * @defaultValue 300
11559
+ * @default 300
11551
11560
  */
11552
11561
  height?: number;
11553
11562
  /**
11554
11563
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11555
- * @defaultValue 300
11564
+ * @default 300
11556
11565
  */
11557
11566
  width?: number;
11558
11567
  /**
11559
11568
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11560
- * @defaultValue 0
11569
+ * @default 0
11561
11570
  */
11562
11571
  x?: number;
11563
11572
  /**
11564
11573
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11565
- * @defaultValue 0
11574
+ * @default 0
11566
11575
  */
11567
11576
  y?: number;
11568
11577
  /**
@@ -11570,7 +11579,7 @@ declare type PopupOptions = {
11570
11579
  * * 'modal' restricts resizing and positioning in the caller.
11571
11580
  * * 'hide' hides the popup window on blur.
11572
11581
  * * 'close' closes the popup window on blur.
11573
- * @defaultValue 'close'
11582
+ * @default 'close'
11574
11583
  */
11575
11584
  blurBehavior?: PopupBlurBehavior;
11576
11585
  /**
@@ -11578,19 +11587,19 @@ declare type PopupOptions = {
11578
11587
  * * 'none' will do nothing.
11579
11588
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11580
11589
  * * 'close' closes the popup window on `dispatchPopupResult`.
11581
- * @defaultValue 'close'
11590
+ * @default 'close'
11582
11591
  */
11583
11592
  resultDispatchBehavior?: PopupResultBehavior;
11584
11593
  /**
11585
11594
  * Hide the popup window instead of closing when `close` is called on it.
11586
11595
  *
11587
11596
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11588
- * @defaultValue false
11597
+ * @default false
11589
11598
  */
11590
11599
  hideOnClose?: boolean;
11591
11600
  /**
11592
11601
  * Determines if the popup window should or should not be focused when it is shown.
11593
- * @defaultValue true
11602
+ * @default true
11594
11603
  */
11595
11604
  focus?: boolean;
11596
11605
  /**
@@ -11684,9 +11693,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
11684
11693
  */
11685
11694
  declare type PreloadScript = {
11686
11695
  /**
11687
- * @defaultValue false
11688
- *
11689
11696
  * Fail to load the window if this preload script fails
11697
+ *
11698
+ * @default false
11690
11699
  */
11691
11700
  mandatory?: boolean;
11692
11701
  /**
@@ -11782,15 +11791,15 @@ declare type PrinterInfo = {
11782
11791
  declare type PrintOptions = {
11783
11792
  content?: 'self';
11784
11793
  /**
11785
- * @defaultValue false
11786
- *
11787
11794
  * Disables prompting the user for print settings.
11795
+ *
11796
+ * @default false
11788
11797
  */
11789
11798
  silent?: boolean;
11790
11799
  /**
11791
- * @defaultValue false
11792
- *
11793
11800
  * Includes the webpage background color and image when printing.
11801
+ *
11802
+ * @default false
11794
11803
  */
11795
11804
  printBackground?: boolean;
11796
11805
  /**
@@ -11798,9 +11807,9 @@ declare type PrintOptions = {
11798
11807
  */
11799
11808
  deviceName?: string;
11800
11809
  /**
11801
- * @defaultValue true
11802
- *
11803
11810
  * Prints in full color (greyscale otherwise).
11811
+ *
11812
+ * @default true
11804
11813
  */
11805
11814
  color?: boolean;
11806
11815
  /**
@@ -11808,9 +11817,9 @@ declare type PrintOptions = {
11808
11817
  */
11809
11818
  margins?: Margins;
11810
11819
  /**
11811
- * @defaultValue true
11812
- *
11813
11820
  * Prints in landscape mode (portrait otherwise).
11821
+ *
11822
+ * @default true
11814
11823
  */
11815
11824
  landscape?: boolean;
11816
11825
  /**
@@ -12981,15 +12990,15 @@ declare type ReplaceViewPayload = {
12981
12990
  */
12982
12991
  declare type ResizeRegion = {
12983
12992
  /**
12984
- * @defaultValue 7
12985
- *
12986
12993
  * The size of the resize region in pixels.
12994
+ *
12995
+ * @default 7
12987
12996
  */
12988
12997
  size?: number;
12989
12998
  /**
12990
- * @defaultValue 9
12991
- *
12992
12999
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13000
+ *
13001
+ * @default 9
12993
13002
  */
12994
13003
  bottomRightCorner?: number;
12995
13004
  /**
@@ -12997,27 +13006,27 @@ declare type ResizeRegion = {
12997
13006
  */
12998
13007
  sides?: {
12999
13008
  /**
13000
- * @defaultValue true
13001
- *
13002
13009
  * Enables resizing from the top of the window.
13010
+ *
13011
+ * @default true
13003
13012
  */
13004
13013
  top?: boolean;
13005
13014
  /**
13006
- * @defaultValue true
13007
- *
13008
13015
  * Enables resizing from the bottom of the window.
13016
+ *
13017
+ * @default true
13009
13018
  */
13010
13019
  bottom?: boolean;
13011
13020
  /**
13012
- * @defaultValue true
13013
- *
13014
13021
  * Enables resizing from the left side of the window.
13022
+ *
13023
+ * @default true
13015
13024
  */
13016
13025
  left?: boolean;
13017
13026
  /**
13018
- * @defaultValue true
13019
- *
13020
13027
  * Enables resizing from the right side of the window.
13028
+ *
13029
+ * @default true
13021
13030
  */
13022
13031
  right?: boolean;
13023
13032
  };
@@ -13561,9 +13570,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13561
13570
  */
13562
13571
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13563
13572
  /**
13564
- * @defaultValue 0
13565
- *
13566
13573
  * Number of milliseconds to wait between view repaints.
13574
+ *
13575
+ * @default 0
13567
13576
  */
13568
13577
  paintIntervalMs?: number;
13569
13578
  };
@@ -15601,9 +15610,9 @@ declare type TransitionBase = {
15601
15610
  */
15602
15611
  duration: number;
15603
15612
  /**
15604
- * @defaultValue false
15605
- *
15606
15613
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
15614
+ *
15615
+ * @default false
15607
15616
  */
15608
15617
  relative?: boolean;
15609
15618
  };
@@ -15619,9 +15628,9 @@ declare type TransitionOptions = {
15619
15628
  */
15620
15629
  interrupt: boolean;
15621
15630
  /**
15622
- * @defaultValue false
15623
- *
15624
15631
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
15632
+ *
15633
+ * @default false
15625
15634
  */
15626
15635
  relative?: boolean;
15627
15636
  tween?: tween;
@@ -16543,9 +16552,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
16543
16552
  */
16544
16553
  declare type ViewVisibilityOption = {
16545
16554
  /**
16546
- * @defaultValue false
16547
- *
16548
16555
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
16556
+ *
16557
+ * @default false
16549
16558
  */
16550
16559
  enabled?: boolean;
16551
16560
  };