@openfin/fdc3-api 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.
@@ -126,13 +126,13 @@ declare type ApiSettings = {
126
126
  /**
127
127
  * Inject OpenFin API into cross-origin iframes
128
128
  *
129
- * @defaultValue false
129
+ * @default false
130
130
  */
131
131
  crossOriginInjection?: boolean;
132
132
  /**
133
133
  * Inject OpenFin API into same-origin iframes
134
134
  *
135
- * @defaultValue true
135
+ * @default true
136
136
  */
137
137
  sameOriginInjection?: boolean;
138
138
  /**
@@ -1171,19 +1171,19 @@ declare class ApplicationModule extends Base {
1171
1171
  */
1172
1172
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1173
1173
  /**
1174
- * @defaultValue false
1175
- *
1176
1174
  * Disables IAB secure logging for the app.
1175
+ *
1176
+ * @default false
1177
1177
  */
1178
1178
  disableIabSecureLogging: boolean;
1179
1179
  /**
1180
- * @defaultValue 'There was an error loading the application.'
1181
- *
1182
1180
  * An error message to display when the application (launched via manifest) fails to load.
1183
1181
  * A dialog box will be launched with the error message just before the runtime exits.
1184
1182
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1185
1183
  * will trigger this dialog.
1186
1184
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1185
+ *
1186
+ * @default 'There was an error loading the application.'
1187
1187
  */
1188
1188
  loadErrorMessage: string;
1189
1189
  /**
@@ -1202,28 +1202,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1202
1202
  */
1203
1203
  name: string;
1204
1204
  /**
1205
- * @defaultValue false
1206
- *
1207
1205
  * A flag to configure the application as non-persistent.
1208
1206
  * Runtime exits when there are no persistent apps running.
1207
+ *
1208
+ * @default false
1209
1209
  */
1210
1210
  nonPersistent: boolean;
1211
1211
  /**
1212
- * @defaultValue false
1213
- *
1214
1212
  * Enable Flash at the application level.
1213
+ *
1214
+ * @default false
1215
1215
  */
1216
1216
  plugins: boolean;
1217
1217
  /**
1218
- * @defaultValue false
1219
- *
1220
1218
  * Enable spell check at the application level.
1219
+ *
1220
+ * @default false
1221
1221
  */
1222
1222
  spellCheck: boolean;
1223
1223
  /**
1224
- * @defaultValue 'about:blank'
1225
- *
1226
1224
  * The url to the application (specifically the application's main window).
1225
+ *
1226
+ * @default 'about:blank'
1227
1227
  */
1228
1228
  url: string;
1229
1229
  /**
@@ -1232,9 +1232,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1232
1232
  */
1233
1233
  uuid: string;
1234
1234
  /**
1235
- * @defaultValue true
1236
- *
1237
1235
  * When set to `false` it will disable the same-origin policy for the app.
1236
+ *
1237
+ * @default true
1238
1238
  */
1239
1239
  webSecurity: boolean;
1240
1240
  /**
@@ -1244,10 +1244,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1244
1244
  commands: ShortcutOverride[];
1245
1245
  isPlatformController: boolean;
1246
1246
  /**
1247
- * @defaultValue 1000
1248
- *
1249
1247
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1250
1248
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1249
+ *
1250
+ * @default 1000
1251
1251
  */
1252
1252
  maxViewPoolSize: number;
1253
1253
  /**
@@ -1263,12 +1263,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1263
1263
  */
1264
1264
  snapshot: Snapshot;
1265
1265
  /**
1266
- * @defaultValue false
1267
- *
1268
1266
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1269
1267
  *
1270
1268
  * Note: if the Platform Provider is showing, it won't close automatically.
1271
1269
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1270
+ *
1271
+ * @default false
1272
1272
  */
1273
1273
  preventQuitOnLastWindowClosed: boolean;
1274
1274
  /**
@@ -1276,9 +1276,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1276
1276
  */
1277
1277
  interopBrokerConfiguration: InteropBrokerOptions;
1278
1278
  /**
1279
- * @defaultValue true
1280
- *
1281
1279
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1280
+ *
1281
+ * @default true
1282
1282
  */
1283
1283
  apiDiagnostics: boolean;
1284
1284
  /**
@@ -1294,16 +1294,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1294
1294
  */
1295
1295
  permissions?: Partial<Permissions_2>;
1296
1296
  /**
1297
- * @defaultValue false
1298
- *
1299
1297
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1300
1298
  * Only relevant in Windows.
1299
+ *
1300
+ * @default false
1301
1301
  */
1302
1302
  enableJumpList: boolean;
1303
1303
  /**
1304
- * @defaultValue false
1305
- *
1306
1304
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1305
+ *
1306
+ * @default false
1307
1307
  */
1308
1308
  enableBeforeUnload: boolean;
1309
1309
  /**
@@ -1384,25 +1384,25 @@ declare type ApplicationWindowInfo = {
1384
1384
  */
1385
1385
  declare type ApplySnapshotOptions = {
1386
1386
  /**
1387
- * @defaultValue false
1388
- *
1389
1387
  * When true, applySnapshot will close existing windows,
1390
1388
  * replacing current Platform state with the given snapshot.
1389
+ *
1390
+ * @default false
1391
1391
  */
1392
1392
  closeExistingWindows?: boolean;
1393
1393
  /**
1394
- * @defaultValue false
1395
- *
1396
1394
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1397
1395
  * replacing current Platform state with the given snapshot.
1396
+ *
1397
+ * @default false
1398
1398
  */
1399
1399
  closeSnapshotWindows?: boolean;
1400
1400
  /**
1401
- * @defaultValue false
1402
- *
1403
1401
  * When true, applySnapshot will not check whether any windows in a
1404
1402
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1405
1403
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1404
+ *
1405
+ * @default false
1406
1406
  */
1407
1407
  skipOutOfBoundsCheck?: boolean;
1408
1408
  };
@@ -2059,15 +2059,15 @@ declare type CapturePageOptions = {
2059
2059
  */
2060
2060
  area?: Rectangle;
2061
2061
  /**
2062
- * @defaultValue 'png'
2063
- *
2064
2062
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2063
+ *
2064
+ * @default 'png'
2065
2065
  */
2066
2066
  format?: 'bmp' | 'jpg' | 'png';
2067
2067
  /**
2068
- * @defaultValue 100
2069
- *
2070
2068
  * Quality of JPEG image. Between 0 - 100.
2069
+ *
2070
+ * @default 100
2071
2071
  */
2072
2072
  quality?: number;
2073
2073
  };
@@ -2700,9 +2700,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2700
2700
  */
2701
2701
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2702
2702
  /**
2703
- * @defaultValue true
2704
- *
2705
2703
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2704
+ *
2705
+ * @default true
2706
2706
  */
2707
2707
  wait?: boolean;
2708
2708
  /**
@@ -2996,6 +2996,10 @@ declare type ChromiumPolicies = {
2996
2996
  * Disable AutofillAddressEnabled policy for a Window or View.
2997
2997
  */
2998
2998
  AutofillAddressEnabled?: PolicyOptions;
2999
+ /**
3000
+ * Disable AutofillCreditCardEnabled policy for a Window or View.
3001
+ */
3002
+ AutofillCreditCardEnabled?: PolicyOptions;
2999
3003
  };
3000
3004
 
3001
3005
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3361,9 +3365,9 @@ declare interface CloseWindowPayload {
3361
3365
  windowId: Identity_4;
3362
3366
  options: {
3363
3367
  /**
3364
- * @defaultValue false
3365
- *
3366
3368
  * When set to true skips any before handler set on views that are part of the window
3369
+ *
3370
+ * @default false
3367
3371
  */
3368
3372
  skipBeforeUnload?: boolean;
3369
3373
  };
@@ -3468,9 +3472,9 @@ declare type ConstViewOptions = {
3468
3472
  */
3469
3473
  name: string;
3470
3474
  /**
3471
- * @defaultValue "about:blank"
3472
- *
3473
3475
  * The URL of the window
3476
+ *
3477
+ * @default "about:blank"
3474
3478
  */
3475
3479
  url: string;
3476
3480
  /**
@@ -3528,9 +3532,9 @@ declare type ConstViewOptions = {
3528
3532
  experimental: any;
3529
3533
  fdc3InteropApi?: string;
3530
3534
  /**
3531
- * @defaultValue false
3532
- *
3533
3535
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3536
+ *
3537
+ * @default false
3534
3538
  */
3535
3539
  enableBeforeUnload: boolean;
3536
3540
  /**
@@ -3611,13 +3615,12 @@ declare type ConstWindowOptions = {
3611
3615
  */
3612
3616
  backgroundColor: string;
3613
3617
  /**
3614
- * @defaultValue false
3615
- *
3616
3618
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3617
3619
  * This also affects the Page Visibility API.
3618
3620
  *
3619
3621
  * When `true`, the page is throttled whether it is hidden or not.
3620
3622
  *
3623
+ * @default false
3621
3624
  */
3622
3625
  backgroundThrottling: boolean;
3623
3626
  /**
@@ -3641,21 +3644,21 @@ declare type ConstWindowOptions = {
3641
3644
  */
3642
3645
  customRequestHeaders: CustomRequestHeaders[];
3643
3646
  /**
3644
- * @defaultValue true
3645
- *
3646
3647
  * Setting this to false would keep the Window alive even if all its Views were closed.
3647
3648
  * This is meant for advanced users and should be used with caution.
3648
3649
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3649
3650
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3650
3651
  * **NOTE:** - This option is ignored in non-Platforms apps.
3652
+ *
3653
+ * @default true
3651
3654
  */
3652
3655
  closeOnLastViewRemoved: boolean;
3653
3656
  /**
3654
- * @defaultValue 'all'
3655
- *
3656
3657
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3657
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3658
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3658
3659
  * **NOTE:** - This option is ignored in non-Platforms apps.
3660
+ *
3661
+ * @default 'all'
3659
3662
  */
3660
3663
  viewsPreventingClose: 'all' | 'layout';
3661
3664
  /**
@@ -3666,31 +3669,31 @@ declare type ConstWindowOptions = {
3666
3669
  */
3667
3670
  defaultCentered: boolean;
3668
3671
  /**
3669
- * @defaultValue 500
3670
- *
3671
3672
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3672
3673
  * in favor of the cached value.
3674
+ *
3675
+ * @default 500
3673
3676
  */
3674
3677
  defaultHeight: number;
3675
3678
  /**
3676
- * @defaultValue 100
3677
- *
3678
3679
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3679
3680
  * launches in favor of the cached value.
3681
+ *
3682
+ * @default 100
3680
3683
  */
3681
3684
  defaultLeft: number;
3682
3685
  /**
3683
- * @defaultValue 100
3684
- *
3685
3686
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3686
3687
  * launches in favor of the cached value.
3688
+ *
3689
+ * @default 100
3687
3690
  */
3688
3691
  defaultTop: number;
3689
3692
  /**
3690
- * @defaultValue 800
3691
- *
3692
3693
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3693
3694
  * launches in favor of the cached value.
3695
+ *
3696
+ * @default 800
3694
3697
  */
3695
3698
  defaultWidth: number;
3696
3699
  /**
@@ -3736,19 +3739,19 @@ declare type ConstWindowOptions = {
3736
3739
  */
3737
3740
  processAffinity: string;
3738
3741
  /**
3739
- * @defaultValue false
3740
- *
3741
3742
  * Displays a shadow on frameless windows.
3742
3743
  * `shadow` and `cornerRounding` are mutually exclusive.
3743
3744
  * On Windows 7, Aero theme is required.
3745
+ *
3746
+ * @default false
3744
3747
  */
3745
3748
  shadow: boolean;
3746
3749
  /**
3747
- * @defaultValue true
3748
- *
3749
3750
  * Caches the location of the window.
3750
3751
  *
3751
3752
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3753
+ *
3754
+ * @default true
3752
3755
  */
3753
3756
  saveWindowState: boolean;
3754
3757
  /**
@@ -3757,22 +3760,22 @@ declare type ConstWindowOptions = {
3757
3760
  */
3758
3761
  ignoreSavedWindowState: boolean;
3759
3762
  /**
3760
- * @defaultValue false
3761
- *
3762
3763
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3763
3764
  *
3764
3765
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3765
3766
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3767
+ *
3768
+ * @default false
3766
3769
  */
3767
3770
  smallWindow: boolean;
3768
3771
  /**
3769
- * @defaultValue "normal"
3770
- *
3771
3772
  * The visible state of the window on creation.
3772
3773
  * One of:
3773
3774
  * * `"maximized"`
3774
3775
  * * `"minimized"`
3775
3776
  * * `"normal"`
3777
+ *
3778
+ * @default "normal"
3776
3779
  */
3777
3780
  state: WindowState;
3778
3781
  /**
@@ -3786,20 +3789,20 @@ declare type ConstWindowOptions = {
3786
3789
  */
3787
3790
  url: string;
3788
3791
  /**
3789
- * @defaultValue <application UUID>
3790
- *
3791
3792
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3792
3793
  * If omitted, defaults to the `uuid` of the application spawning the window.
3793
3794
  * If given, must match the `uuid` of the application spawning the window.
3794
3795
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3795
3796
  * really no need to provide it.
3797
+ *
3798
+ * @default <application UUID>
3796
3799
  */
3797
3800
  uuid: string;
3798
3801
  /**
3799
- * @defaultValue false
3800
- *
3801
3802
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3802
3803
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3804
+ *
3805
+ * @default false
3803
3806
  */
3804
3807
  waitForPageLoad: boolean;
3805
3808
  width: number;
@@ -4071,13 +4074,13 @@ declare type CopyBlockedEventReason = 'disabled';
4071
4074
  */
4072
4075
  declare type CopyPermissions = {
4073
4076
  /**
4074
- * @defaultValue 'allowed'
4075
- *
4076
4077
  * Controls the behavior for copy operations for a matched URL.
4077
4078
  *
4078
4079
  * allow: Enables all copy operations.
4079
4080
  * block: Disables all copy operations.
4080
4081
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4082
+ *
4083
+ * @default 'allowed'
4081
4084
  */
4082
4085
  behavior: 'allow' | 'block' | 'protect';
4083
4086
  /**
@@ -4085,9 +4088,9 @@ declare type CopyPermissions = {
4085
4088
  */
4086
4089
  options?: {
4087
4090
  /**
4088
- * @defaultValue ''
4089
- *
4090
4091
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4092
+ *
4093
+ * @default ''
4091
4094
  */
4092
4095
  replacementText: string;
4093
4096
  };
@@ -4101,15 +4104,15 @@ declare type CopyPermissions = {
4101
4104
  */
4102
4105
  declare type CornerRounding = {
4103
4106
  /**
4104
- * @defaultValue 0
4105
- *
4106
4107
  * The height in pixels.
4108
+ *
4109
+ * @default 0
4107
4110
  */
4108
4111
  height: number;
4109
4112
  /**
4110
- * @defaultValue 0
4111
- *
4112
4113
  * The width in pixels.
4114
+ *
4115
+ * @default 0
4113
4116
  */
4114
4117
  width: number;
4115
4118
  };
@@ -4199,8 +4202,6 @@ declare type CreateLayoutOptions = {
4199
4202
  layoutName: string;
4200
4203
  layout: LayoutOptions;
4201
4204
  /**
4202
- * @defaultValue 'default'
4203
- *
4204
4205
  * Controls the View behavior for the given `layout` property. Note
4205
4206
  * that the selected behavior only applies to unnamed Views or
4206
4207
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4222,6 +4223,8 @@ declare type CreateLayoutOptions = {
4222
4223
  * override. Note that during applyLayoutSnapshot, Views are created and
4223
4224
  * attached to the Provider while the Window is being created, so it's
4224
4225
  * important to not 'duplicate' Views in this workflow.
4226
+ *
4227
+ * @default 'default'
4225
4228
  */
4226
4229
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4227
4230
  };
@@ -4481,7 +4484,7 @@ declare type DomainApiSettings = {
4481
4484
  * * 'none': The `fin` API will be not available.
4482
4485
  * * 'global': The entire `fin` API will be available.
4483
4486
  *
4484
- * @defaultValue 'global'
4487
+ * @default 'global'
4485
4488
  */
4486
4489
  fin?: InjectionType;
4487
4490
  /**
@@ -5059,9 +5062,9 @@ declare type EventType_9 = Event_12['type'];
5059
5062
  */
5060
5063
  declare type ExcludeOptions = {
5061
5064
  /**
5062
- * @defaultValue false
5063
- *
5064
5065
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5066
+ *
5067
+ * @default false
5065
5068
  */
5066
5069
  preloadScripts: boolean;
5067
5070
  };
@@ -5880,34 +5883,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
5880
5883
  */
5881
5884
  declare type FindInPageOptions = {
5882
5885
  /**
5883
- * @defaultValue true
5884
- *
5885
5886
  * Searches in the forward direction (backward otherwise)
5887
+ *
5888
+ * @default true
5886
5889
  */
5887
5890
  forward?: boolean;
5888
5891
  /**
5889
- * @defaultValue false
5890
- *
5891
5892
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5893
+ *
5894
+ * @default false
5892
5895
  */
5893
5896
  findNext?: boolean;
5894
5897
  /**
5895
- * @defaultValue false
5896
- *
5897
5898
  * Enables case-sensitive searching.
5899
+ *
5900
+ * @default false
5898
5901
  */
5899
5902
  matchCase?: boolean;
5900
5903
  /**
5901
- * @defaultValue false
5902
- *
5903
5904
  * Only searches from the start of words.
5905
+ *
5906
+ * @default false
5904
5907
  */
5905
5908
  wordStart?: boolean;
5906
5909
  /**
5907
- * @defaultValue false
5908
- *
5909
5910
  * 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>
5910
5911
  * lowercase or non-letter. Accepts several other intra-word matches.
5912
+ *
5913
+ * @default false
5911
5914
  */
5912
5915
  medialCapitalAsWordStart?: boolean;
5913
5916
  };
@@ -6415,9 +6418,9 @@ declare type Hotkey = {
6415
6418
  */
6416
6419
  keys: string;
6417
6420
  /**
6418
- * @defaultValue false
6419
- *
6420
6421
  * Prevent default key handling before emitting the event.
6422
+ *
6423
+ * @default false
6421
6424
  */
6422
6425
  preventDefault?: boolean;
6423
6426
  };
@@ -8753,77 +8756,79 @@ declare type LayoutOptions = {
8753
8756
  */
8754
8757
  settings?: {
8755
8758
  /**
8756
- * @defaultValue false
8757
- *
8758
8759
  * When true the splitters will not be draggable and the layout will not resize.
8760
+ *
8761
+ * @default false
8759
8762
  */
8760
8763
  preventSplitterResize?: boolean;
8761
8764
  /**
8762
- * @defaultValue false
8763
- *
8764
8765
  * Whether the popout button will only act on the entire stack,
8765
8766
  * as opposed to only the active tab.
8767
+ *
8768
+ * @default false
8766
8769
  */
8767
8770
  popoutWholeStack?: boolean;
8768
8771
  /**
8769
- * @defaultValue false
8770
- *
8771
8772
  * Limits the area to which tabs can be dragged.
8772
8773
  * If true, the layout container is the only area where tabs can be dropped.
8774
+ *
8775
+ * @default false
8773
8776
  */
8774
8777
  constrainDragToContainer?: boolean;
8775
8778
  /**
8776
- * @defaultValue false
8777
- *
8778
8779
  * Whether to show the popout button on stack header.
8779
8780
  * The button will create a new window with current tab as its content.
8780
8781
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8782
+ *
8783
+ * @default false
8781
8784
  */
8782
8785
  showPopoutIcon?: boolean;
8783
8786
  /**
8784
- * @defaultValue false
8785
- *
8786
8787
  * Whether to show the maximize button on stack header.
8787
8788
  * The button will maximize the current tab to fill the entire window.
8789
+ *
8790
+ * @default false
8788
8791
  */
8789
8792
  showMaximiseIcon?: boolean;
8790
8793
  /**
8791
- * @defaultValue false
8792
- *
8793
8794
  * Whether to show the close button on stack header
8794
8795
  * (not to be confused with close button on every tab).
8796
+ *
8797
+ * @default false
8795
8798
  */
8796
8799
  showCloseIcon?: boolean;
8797
8800
  /**
8798
- * @defaultValue false
8799
- *
8800
8801
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8802
+ *
8803
+ * @default false
8801
8804
  */
8802
8805
  constrainDragToHeaders?: boolean;
8803
8806
  /**
8804
- * @defaultValue true
8805
- *
8806
8807
  * Turns tab headers on or off.
8807
8808
  * If false, the layout will be displayed with splitters only.
8809
+ *
8810
+ * @default true
8808
8811
  */
8809
8812
  hasHeaders?: boolean;
8810
8813
  /**
8811
- * @defaultValue true
8812
- *
8813
8814
  * If true, the user can re-arrange the layout by
8814
8815
  * dragging items by their tabs to the desired location.
8816
+ *
8817
+ * @default true
8815
8818
  */
8816
8819
  reorderEnabled?: boolean;
8817
8820
  /**
8818
- * @defaultValue false
8819
- *
8820
8821
  * If true, tabs can't be dragged out of the window.
8822
+ *
8823
+ * @default false
8821
8824
  */
8822
8825
  preventDragOut?: boolean;
8823
8826
  /**
8824
8827
  * @defaultValue=false
8825
8828
  *
8826
8829
  * If true, tabs can't be dragged into the window.
8830
+ *
8831
+ * @default false
8827
8832
  */
8828
8833
  preventDragIn?: boolean;
8829
8834
  };
@@ -9266,10 +9271,10 @@ declare type MutableViewOptions = {
9266
9271
  /**
9267
9272
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9268
9273
  *
9269
- * @defaultValue true
9270
- *
9271
9274
  * Show the context menu when right-clicking on the view.
9272
9275
  * Gives access to the devtools for the view.
9276
+ *
9277
+ * @default true
9273
9278
  */
9274
9279
  contextMenu: boolean;
9275
9280
  /**
@@ -9316,24 +9321,25 @@ declare type MutableViewOptions = {
9316
9321
  contentNavigation: ContentNavigation;
9317
9322
  contentRedirect: ContentRedirect;
9318
9323
  /**
9319
- * @defaultValue false
9320
9324
  * @deprecated
9321
9325
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9322
9326
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9327
+ *
9328
+ * @default false
9323
9329
  */
9324
9330
  detachOnClose: boolean;
9325
9331
  /**
9326
- * @defaultValue true
9327
- *
9328
9332
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9329
9333
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9330
9334
  * if the view isn't part of the new layout when running `Layout.replace`.
9335
+ *
9336
+ * @default true
9331
9337
  */
9332
9338
  isClosable: boolean;
9333
9339
  /**
9334
- * @defaultValue false
9335
- *
9336
9340
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9341
+ *
9342
+ * @default false
9337
9343
  */
9338
9344
  preventDragOut: boolean;
9339
9345
  interop?: InteropConfig;
@@ -9341,7 +9347,7 @@ declare type MutableViewOptions = {
9341
9347
  /**
9342
9348
  * {@inheritDoc ViewThrottling}
9343
9349
  *
9344
- * @defaultValue 'enabled'
9350
+ * @default 'enabled'
9345
9351
  */
9346
9352
  throttling: ViewThrottling;
9347
9353
  /**
@@ -9360,7 +9366,7 @@ declare type MutableWindowOptions = {
9360
9366
  * Turns anything of matching RGB value transparent.
9361
9367
  *
9362
9368
  * Caveats:
9363
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9369
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9364
9370
  * * User cannot click-through transparent regions
9365
9371
  * * Not supported on Mac
9366
9372
  * * Windows Aero must be enabled
@@ -9369,25 +9375,25 @@ declare type MutableWindowOptions = {
9369
9375
  */
9370
9376
  alphaMask: RGB;
9371
9377
  /**
9372
- * @defaultValue false
9373
- *
9374
9378
  * Always position the window at the top of the window stack.
9379
+ *
9380
+ * @default false
9375
9381
  */
9376
9382
  alwaysOnTop: boolean;
9377
9383
  /**
9378
- * @defaultValue 0
9379
- *
9380
9384
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9381
9385
  * an aspect ratio will not be enforced.
9386
+ *
9387
+ * @default 0
9382
9388
  */
9383
9389
  aspectRatio: number;
9384
9390
  /**
9385
9391
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9386
9392
  *
9387
- * @defaultValue true
9388
- *
9389
9393
  * Show the context menu when right-clicking on the window.
9390
9394
  * Gives access to the devtools for the window.
9395
+ *
9396
+ * @default true
9391
9397
  */
9392
9398
  contextMenu: boolean;
9393
9399
  /**
@@ -9457,12 +9463,14 @@ declare type MutableWindowOptions = {
9457
9463
  * @defaultValue true
9458
9464
  *
9459
9465
  * Show the window's frame.
9466
+ *
9467
+ * @default true
9460
9468
  */
9461
9469
  frame: boolean;
9462
9470
  /**
9463
- * @defaultValue false
9464
- *
9465
9471
  * Hides the window instead of closing it when the close button is pressed.
9472
+ *
9473
+ * @default false
9466
9474
  */
9467
9475
  hideOnClose: boolean;
9468
9476
  /**
@@ -9515,60 +9523,61 @@ declare type MutableWindowOptions = {
9515
9523
  */
9516
9524
  icon: string;
9517
9525
  /**
9518
- * @defaultValue true
9519
- *
9520
9526
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9521
9527
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9528
+ *
9529
+ * @default true
9522
9530
  */
9523
9531
  includeInSnapshots: boolean;
9524
9532
  /**
9525
- * @defaultValue -1
9526
- *
9527
9533
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9534
+ *
9535
+ * @default -1
9528
9536
  */
9529
9537
  maxHeight: number;
9530
9538
  /**
9531
- * @defaultValue true
9532
- *
9533
9539
  * Allows the window to be maximized.
9540
+ *
9541
+ * @default true
9534
9542
  */
9535
9543
  maximizable: boolean;
9536
9544
  /**
9537
- * @defaultValue -1
9538
- *
9539
9545
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9546
+ *
9547
+ * @default -1
9540
9548
  */
9541
9549
  maxWidth: number;
9542
9550
  /**
9543
- * @defaultValue 0
9544
- *
9545
9551
  * The minimum height of the window.
9552
+ *
9553
+ * @default 0
9546
9554
  */
9547
9555
  minHeight: number;
9548
9556
  /**
9549
- * @defaultValue true
9550
- *
9551
9557
  * Allows the window to be minimized.
9558
+ *
9559
+ * @default true
9552
9560
  */
9553
9561
  minimizable: boolean;
9554
9562
  /**
9555
- * @defaultValue true
9556
- *
9557
9563
  * The minimum width of the window.
9564
+ *
9565
+ * @default true
9558
9566
  */
9559
9567
  minWidth: number;
9560
9568
  /**
9561
- * @defaultValue 1
9562
- *
9563
9569
  * A flag that specifies how transparent the window will be.
9564
9570
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9565
9571
  * This value is clamped between `0.0` and `1.0`.
9572
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9573
+ *
9574
+ * @default 1
9566
9575
  */
9567
9576
  opacity: number;
9568
9577
  /**
9569
- * @defaultValue true
9570
- *
9571
9578
  * A flag to allow the user to resize the window.
9579
+ *
9580
+ * @default true
9572
9581
  */
9573
9582
  resizable: boolean;
9574
9583
  /**
@@ -9576,16 +9585,16 @@ declare type MutableWindowOptions = {
9576
9585
  */
9577
9586
  resizeRegion: ResizeRegion;
9578
9587
  /**
9579
- * @defaultValue false
9580
- *
9581
9588
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9582
9589
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9590
+ *
9591
+ * @default false
9583
9592
  */
9584
9593
  showBackgroundImages: boolean;
9585
9594
  /**
9586
- * @defaultValue true
9587
- *
9588
9595
  * Shows the window's icon in the taskbar.
9596
+ *
9597
+ * @default true
9589
9598
  */
9590
9599
  showTaskbarIcon: boolean;
9591
9600
  /**
@@ -9600,7 +9609,7 @@ declare type MutableWindowOptions = {
9600
9609
  /**
9601
9610
  * {@inheritDoc WindowThrottling}
9602
9611
  *
9603
- * @defaultValue 'enabled'
9612
+ * @default 'enabled'
9604
9613
  *
9605
9614
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9606
9615
  */
@@ -10207,12 +10216,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10207
10216
  */
10208
10217
  declare type PastePermissions = {
10209
10218
  /**
10210
- * @defaultValue 'non-protected-content'
10211
- *
10212
10219
  * Controls the behavior for paste operations for a matched URL.
10213
10220
  *
10214
10221
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10215
10222
  * 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.
10223
+ *
10224
+ * @default 'non-protected-content'
10216
10225
  */
10217
10226
  behavior: 'non-protected-content' | 'all-content';
10218
10227
  };
@@ -11239,11 +11248,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11239
11248
  */
11240
11249
  providerUrl?: string;
11241
11250
  /**
11242
- * @defaultValue true
11243
- *
11244
11251
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11245
11252
  *
11246
11253
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11254
+ *
11255
+ * @default true
11247
11256
  */
11248
11257
  allowLaunchIntoPlatform?: boolean;
11249
11258
  };
@@ -11887,22 +11896,22 @@ declare type PopupOptions = {
11887
11896
  url?: string;
11888
11897
  /**
11889
11898
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11890
- * @defaultValue 300
11899
+ * @default 300
11891
11900
  */
11892
11901
  height?: number;
11893
11902
  /**
11894
11903
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11895
- * @defaultValue 300
11904
+ * @default 300
11896
11905
  */
11897
11906
  width?: number;
11898
11907
  /**
11899
11908
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11900
- * @defaultValue 0
11909
+ * @default 0
11901
11910
  */
11902
11911
  x?: number;
11903
11912
  /**
11904
11913
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11905
- * @defaultValue 0
11914
+ * @default 0
11906
11915
  */
11907
11916
  y?: number;
11908
11917
  /**
@@ -11910,7 +11919,7 @@ declare type PopupOptions = {
11910
11919
  * * 'modal' restricts resizing and positioning in the caller.
11911
11920
  * * 'hide' hides the popup window on blur.
11912
11921
  * * 'close' closes the popup window on blur.
11913
- * @defaultValue 'close'
11922
+ * @default 'close'
11914
11923
  */
11915
11924
  blurBehavior?: PopupBlurBehavior;
11916
11925
  /**
@@ -11918,19 +11927,19 @@ declare type PopupOptions = {
11918
11927
  * * 'none' will do nothing.
11919
11928
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11920
11929
  * * 'close' closes the popup window on `dispatchPopupResult`.
11921
- * @defaultValue 'close'
11930
+ * @default 'close'
11922
11931
  */
11923
11932
  resultDispatchBehavior?: PopupResultBehavior;
11924
11933
  /**
11925
11934
  * Hide the popup window instead of closing when `close` is called on it.
11926
11935
  *
11927
11936
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11928
- * @defaultValue false
11937
+ * @default false
11929
11938
  */
11930
11939
  hideOnClose?: boolean;
11931
11940
  /**
11932
11941
  * Determines if the popup window should or should not be focused when it is shown.
11933
- * @defaultValue true
11942
+ * @default true
11934
11943
  */
11935
11944
  focus?: boolean;
11936
11945
  /**
@@ -12024,9 +12033,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12024
12033
  */
12025
12034
  declare type PreloadScript = {
12026
12035
  /**
12027
- * @defaultValue false
12028
- *
12029
12036
  * Fail to load the window if this preload script fails
12037
+ *
12038
+ * @default false
12030
12039
  */
12031
12040
  mandatory?: boolean;
12032
12041
  /**
@@ -12122,15 +12131,15 @@ declare type PrinterInfo = {
12122
12131
  declare type PrintOptions = {
12123
12132
  content?: 'self';
12124
12133
  /**
12125
- * @defaultValue false
12126
- *
12127
12134
  * Disables prompting the user for print settings.
12135
+ *
12136
+ * @default false
12128
12137
  */
12129
12138
  silent?: boolean;
12130
12139
  /**
12131
- * @defaultValue false
12132
- *
12133
12140
  * Includes the webpage background color and image when printing.
12141
+ *
12142
+ * @default false
12134
12143
  */
12135
12144
  printBackground?: boolean;
12136
12145
  /**
@@ -12138,9 +12147,9 @@ declare type PrintOptions = {
12138
12147
  */
12139
12148
  deviceName?: string;
12140
12149
  /**
12141
- * @defaultValue true
12142
- *
12143
12150
  * Prints in full color (greyscale otherwise).
12151
+ *
12152
+ * @default true
12144
12153
  */
12145
12154
  color?: boolean;
12146
12155
  /**
@@ -12148,9 +12157,9 @@ declare type PrintOptions = {
12148
12157
  */
12149
12158
  margins?: Margins;
12150
12159
  /**
12151
- * @defaultValue true
12152
- *
12153
12160
  * Prints in landscape mode (portrait otherwise).
12161
+ *
12162
+ * @default true
12154
12163
  */
12155
12164
  landscape?: boolean;
12156
12165
  /**
@@ -13321,15 +13330,15 @@ declare type ReplaceViewPayload = {
13321
13330
  */
13322
13331
  declare type ResizeRegion = {
13323
13332
  /**
13324
- * @defaultValue 7
13325
- *
13326
13333
  * The size of the resize region in pixels.
13334
+ *
13335
+ * @default 7
13327
13336
  */
13328
13337
  size?: number;
13329
13338
  /**
13330
- * @defaultValue 9
13331
- *
13332
13339
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13340
+ *
13341
+ * @default 9
13333
13342
  */
13334
13343
  bottomRightCorner?: number;
13335
13344
  /**
@@ -13337,27 +13346,27 @@ declare type ResizeRegion = {
13337
13346
  */
13338
13347
  sides?: {
13339
13348
  /**
13340
- * @defaultValue true
13341
- *
13342
13349
  * Enables resizing from the top of the window.
13350
+ *
13351
+ * @default true
13343
13352
  */
13344
13353
  top?: boolean;
13345
13354
  /**
13346
- * @defaultValue true
13347
- *
13348
13355
  * Enables resizing from the bottom of the window.
13356
+ *
13357
+ * @default true
13349
13358
  */
13350
13359
  bottom?: boolean;
13351
13360
  /**
13352
- * @defaultValue true
13353
- *
13354
13361
  * Enables resizing from the left side of the window.
13362
+ *
13363
+ * @default true
13355
13364
  */
13356
13365
  left?: boolean;
13357
13366
  /**
13358
- * @defaultValue true
13359
- *
13360
13367
  * Enables resizing from the right side of the window.
13368
+ *
13369
+ * @default true
13361
13370
  */
13362
13371
  right?: boolean;
13363
13372
  };
@@ -13901,9 +13910,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13901
13910
  */
13902
13911
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13903
13912
  /**
13904
- * @defaultValue 0
13905
- *
13906
13913
  * Number of milliseconds to wait between view repaints.
13914
+ *
13915
+ * @default 0
13907
13916
  */
13908
13917
  paintIntervalMs?: number;
13909
13918
  };
@@ -15941,9 +15950,9 @@ declare type TransitionBase = {
15941
15950
  */
15942
15951
  duration: number;
15943
15952
  /**
15944
- * @defaultValue false
15945
- *
15946
15953
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
15954
+ *
15955
+ * @default false
15947
15956
  */
15948
15957
  relative?: boolean;
15949
15958
  };
@@ -15959,9 +15968,9 @@ declare type TransitionOptions = {
15959
15968
  */
15960
15969
  interrupt: boolean;
15961
15970
  /**
15962
- * @defaultValue false
15963
- *
15964
15971
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
15972
+ *
15973
+ * @default false
15965
15974
  */
15966
15975
  relative?: boolean;
15967
15976
  tween?: tween;
@@ -16989,9 +16998,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
16989
16998
  */
16990
16999
  declare type ViewVisibilityOption = {
16991
17000
  /**
16992
- * @defaultValue false
16993
- *
16994
17001
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17002
+ *
17003
+ * @default false
16995
17004
  */
16996
17005
  enabled?: boolean;
16997
17006
  };