@openfin/core 40.105.4 → 40.105.6

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
@@ -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
  /**
@@ -1180,19 +1180,19 @@ declare class ApplicationModule extends Base {
1180
1180
  */
1181
1181
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1182
1182
  /**
1183
- * @defaultValue false
1184
- *
1185
1183
  * Disables IAB secure logging for the app.
1184
+ *
1185
+ * @default false
1186
1186
  */
1187
1187
  disableIabSecureLogging: boolean;
1188
1188
  /**
1189
- * @defaultValue 'There was an error loading the application.'
1190
- *
1191
1189
  * An error message to display when the application (launched via manifest) fails to load.
1192
1190
  * A dialog box will be launched with the error message just before the runtime exits.
1193
1191
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1194
1192
  * will trigger this dialog.
1195
1193
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1194
+ *
1195
+ * @default 'There was an error loading the application.'
1196
1196
  */
1197
1197
  loadErrorMessage: string;
1198
1198
  /**
@@ -1211,28 +1211,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1211
1211
  */
1212
1212
  name: string;
1213
1213
  /**
1214
- * @defaultValue false
1215
- *
1216
1214
  * A flag to configure the application as non-persistent.
1217
1215
  * Runtime exits when there are no persistent apps running.
1216
+ *
1217
+ * @default false
1218
1218
  */
1219
1219
  nonPersistent: boolean;
1220
1220
  /**
1221
- * @defaultValue false
1222
- *
1223
1221
  * Enable Flash at the application level.
1222
+ *
1223
+ * @default false
1224
1224
  */
1225
1225
  plugins: boolean;
1226
1226
  /**
1227
- * @defaultValue false
1228
- *
1229
1227
  * Enable spell check at the application level.
1228
+ *
1229
+ * @default false
1230
1230
  */
1231
1231
  spellCheck: boolean;
1232
1232
  /**
1233
- * @defaultValue 'about:blank'
1234
- *
1235
1233
  * The url to the application (specifically the application's main window).
1234
+ *
1235
+ * @default 'about:blank'
1236
1236
  */
1237
1237
  url: string;
1238
1238
  /**
@@ -1241,9 +1241,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1241
1241
  */
1242
1242
  uuid: string;
1243
1243
  /**
1244
- * @defaultValue true
1245
- *
1246
1244
  * When set to `false` it will disable the same-origin policy for the app.
1245
+ *
1246
+ * @default true
1247
1247
  */
1248
1248
  webSecurity: boolean;
1249
1249
  /**
@@ -1253,10 +1253,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1253
1253
  commands: ShortcutOverride[];
1254
1254
  isPlatformController: boolean;
1255
1255
  /**
1256
- * @defaultValue 1000
1257
- *
1258
1256
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1259
1257
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1258
+ *
1259
+ * @default 1000
1260
1260
  */
1261
1261
  maxViewPoolSize: number;
1262
1262
  /**
@@ -1272,12 +1272,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1272
1272
  */
1273
1273
  snapshot: Snapshot;
1274
1274
  /**
1275
- * @defaultValue false
1276
- *
1277
1275
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1278
1276
  *
1279
1277
  * Note: if the Platform Provider is showing, it won't close automatically.
1280
1278
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1279
+ *
1280
+ * @default false
1281
1281
  */
1282
1282
  preventQuitOnLastWindowClosed: boolean;
1283
1283
  /**
@@ -1285,9 +1285,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1285
1285
  */
1286
1286
  interopBrokerConfiguration: InteropBrokerOptions;
1287
1287
  /**
1288
- * @defaultValue true
1289
- *
1290
1288
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1289
+ *
1290
+ * @default true
1291
1291
  */
1292
1292
  apiDiagnostics: boolean;
1293
1293
  /**
@@ -1303,16 +1303,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1303
1303
  */
1304
1304
  permissions?: Partial<Permissions_2>;
1305
1305
  /**
1306
- * @defaultValue false
1307
- *
1308
1306
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1309
1307
  * Only relevant in Windows.
1308
+ *
1309
+ * @default false
1310
1310
  */
1311
1311
  enableJumpList: boolean;
1312
1312
  /**
1313
- * @defaultValue false
1314
- *
1315
1313
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1314
+ *
1315
+ * @default false
1316
1316
  */
1317
1317
  enableBeforeUnload: boolean;
1318
1318
  /**
@@ -1393,25 +1393,25 @@ declare type ApplicationWindowInfo = {
1393
1393
  */
1394
1394
  declare type ApplySnapshotOptions = {
1395
1395
  /**
1396
- * @defaultValue false
1397
- *
1398
1396
  * When true, applySnapshot will close existing windows,
1399
1397
  * replacing current Platform state with the given snapshot.
1398
+ *
1399
+ * @default false
1400
1400
  */
1401
1401
  closeExistingWindows?: boolean;
1402
1402
  /**
1403
- * @defaultValue false
1404
- *
1405
1403
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1406
1404
  * replacing current Platform state with the given snapshot.
1405
+ *
1406
+ * @default false
1407
1407
  */
1408
1408
  closeSnapshotWindows?: boolean;
1409
1409
  /**
1410
- * @defaultValue false
1411
- *
1412
1410
  * When true, applySnapshot will not check whether any windows in a
1413
1411
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1414
1412
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1413
+ *
1414
+ * @default false
1415
1415
  */
1416
1416
  skipOutOfBoundsCheck?: boolean;
1417
1417
  };
@@ -2094,15 +2094,15 @@ declare type CapturePageOptions = {
2094
2094
  */
2095
2095
  area?: Rectangle;
2096
2096
  /**
2097
- * @defaultValue 'png'
2098
- *
2099
2097
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2098
+ *
2099
+ * @default 'png'
2100
2100
  */
2101
2101
  format?: 'bmp' | 'jpg' | 'png';
2102
2102
  /**
2103
- * @defaultValue 100
2104
- *
2105
2103
  * Quality of JPEG image. Between 0 - 100.
2104
+ *
2105
+ * @default 100
2106
2106
  */
2107
2107
  quality?: number;
2108
2108
  };
@@ -2756,9 +2756,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2756
2756
  */
2757
2757
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2758
2758
  /**
2759
- * @defaultValue true
2760
- *
2761
2759
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2760
+ *
2761
+ * @default true
2762
2762
  */
2763
2763
  wait?: boolean;
2764
2764
  /**
@@ -3420,9 +3420,9 @@ declare interface CloseWindowPayload {
3420
3420
  windowId: Identity_4;
3421
3421
  options: {
3422
3422
  /**
3423
- * @defaultValue false
3424
- *
3425
3423
  * When set to true skips any before handler set on views that are part of the window
3424
+ *
3425
+ * @default false
3426
3426
  */
3427
3427
  skipBeforeUnload?: boolean;
3428
3428
  };
@@ -3530,9 +3530,9 @@ declare type ConstViewOptions = {
3530
3530
  */
3531
3531
  name: string;
3532
3532
  /**
3533
- * @defaultValue "about:blank"
3534
- *
3535
3533
  * The URL of the window
3534
+ *
3535
+ * @default "about:blank"
3536
3536
  */
3537
3537
  url: string;
3538
3538
  /**
@@ -3590,9 +3590,9 @@ declare type ConstViewOptions = {
3590
3590
  experimental: any;
3591
3591
  fdc3InteropApi?: string;
3592
3592
  /**
3593
- * @defaultValue false
3594
- *
3595
3593
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3594
+ *
3595
+ * @default false
3596
3596
  */
3597
3597
  enableBeforeUnload: boolean;
3598
3598
  /**
@@ -3673,13 +3673,12 @@ declare type ConstWindowOptions = {
3673
3673
  */
3674
3674
  backgroundColor: string;
3675
3675
  /**
3676
- * @defaultValue false
3677
- *
3678
3676
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3679
3677
  * This also affects the Page Visibility API.
3680
3678
  *
3681
3679
  * When `true`, the page is throttled whether it is hidden or not.
3682
3680
  *
3681
+ * @default false
3683
3682
  */
3684
3683
  backgroundThrottling: boolean;
3685
3684
  /**
@@ -3703,21 +3702,21 @@ declare type ConstWindowOptions = {
3703
3702
  */
3704
3703
  customRequestHeaders: CustomRequestHeaders[];
3705
3704
  /**
3706
- * @defaultValue true
3707
- *
3708
3705
  * Setting this to false would keep the Window alive even if all its Views were closed.
3709
3706
  * This is meant for advanced users and should be used with caution.
3710
3707
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3711
3708
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3712
3709
  * **NOTE:** - This option is ignored in non-Platforms apps.
3710
+ *
3711
+ * @default true
3713
3712
  */
3714
3713
  closeOnLastViewRemoved: boolean;
3715
3714
  /**
3716
- * @defaultValue 'all'
3717
- *
3718
3715
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3719
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3716
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3720
3717
  * **NOTE:** - This option is ignored in non-Platforms apps.
3718
+ *
3719
+ * @default 'all'
3721
3720
  */
3722
3721
  viewsPreventingClose: 'all' | 'layout';
3723
3722
  /**
@@ -3728,31 +3727,31 @@ declare type ConstWindowOptions = {
3728
3727
  */
3729
3728
  defaultCentered: boolean;
3730
3729
  /**
3731
- * @defaultValue 500
3732
- *
3733
3730
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3734
3731
  * in favor of the cached value.
3732
+ *
3733
+ * @default 500
3735
3734
  */
3736
3735
  defaultHeight: number;
3737
3736
  /**
3738
- * @defaultValue 100
3739
- *
3740
3737
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3741
3738
  * launches in favor of the cached value.
3739
+ *
3740
+ * @default 100
3742
3741
  */
3743
3742
  defaultLeft: number;
3744
3743
  /**
3745
- * @defaultValue 100
3746
- *
3747
3744
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3748
3745
  * launches in favor of the cached value.
3746
+ *
3747
+ * @default 100
3749
3748
  */
3750
3749
  defaultTop: number;
3751
3750
  /**
3752
- * @defaultValue 800
3753
- *
3754
3751
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3755
3752
  * launches in favor of the cached value.
3753
+ *
3754
+ * @default 800
3756
3755
  */
3757
3756
  defaultWidth: number;
3758
3757
  /**
@@ -3798,19 +3797,19 @@ declare type ConstWindowOptions = {
3798
3797
  */
3799
3798
  processAffinity: string;
3800
3799
  /**
3801
- * @defaultValue false
3802
- *
3803
3800
  * Displays a shadow on frameless windows.
3804
3801
  * `shadow` and `cornerRounding` are mutually exclusive.
3805
3802
  * On Windows 7, Aero theme is required.
3803
+ *
3804
+ * @default false
3806
3805
  */
3807
3806
  shadow: boolean;
3808
3807
  /**
3809
- * @defaultValue true
3810
- *
3811
3808
  * Caches the location of the window.
3812
3809
  *
3813
3810
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3811
+ *
3812
+ * @default true
3814
3813
  */
3815
3814
  saveWindowState: boolean;
3816
3815
  /**
@@ -3819,22 +3818,22 @@ declare type ConstWindowOptions = {
3819
3818
  */
3820
3819
  ignoreSavedWindowState: boolean;
3821
3820
  /**
3822
- * @defaultValue false
3823
- *
3824
3821
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3825
3822
  *
3826
3823
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3827
3824
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3825
+ *
3826
+ * @default false
3828
3827
  */
3829
3828
  smallWindow: boolean;
3830
3829
  /**
3831
- * @defaultValue "normal"
3832
- *
3833
3830
  * The visible state of the window on creation.
3834
3831
  * One of:
3835
3832
  * * `"maximized"`
3836
3833
  * * `"minimized"`
3837
3834
  * * `"normal"`
3835
+ *
3836
+ * @default "normal"
3838
3837
  */
3839
3838
  state: WindowState;
3840
3839
  /**
@@ -3848,20 +3847,20 @@ declare type ConstWindowOptions = {
3848
3847
  */
3849
3848
  url: string;
3850
3849
  /**
3851
- * @defaultValue <application UUID>
3852
- *
3853
3850
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3854
3851
  * If omitted, defaults to the `uuid` of the application spawning the window.
3855
3852
  * If given, must match the `uuid` of the application spawning the window.
3856
3853
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3857
3854
  * really no need to provide it.
3855
+ *
3856
+ * @default <application UUID>
3858
3857
  */
3859
3858
  uuid: string;
3860
3859
  /**
3861
- * @defaultValue false
3862
- *
3863
3860
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3864
3861
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3862
+ *
3863
+ * @default false
3865
3864
  */
3866
3865
  waitForPageLoad: boolean;
3867
3866
  width: number;
@@ -4133,13 +4132,13 @@ declare type CopyBlockedEventReason = 'disabled';
4133
4132
  */
4134
4133
  declare type CopyPermissions = {
4135
4134
  /**
4136
- * @defaultValue 'allowed'
4137
- *
4138
4135
  * Controls the behavior for copy operations for a matched URL.
4139
4136
  *
4140
4137
  * allow: Enables all copy operations.
4141
4138
  * block: Disables all copy operations.
4142
4139
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4140
+ *
4141
+ * @default 'allowed'
4143
4142
  */
4144
4143
  behavior: 'allow' | 'block' | 'protect';
4145
4144
  /**
@@ -4147,9 +4146,9 @@ declare type CopyPermissions = {
4147
4146
  */
4148
4147
  options?: {
4149
4148
  /**
4150
- * @defaultValue ''
4151
- *
4152
4149
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4150
+ *
4151
+ * @default ''
4153
4152
  */
4154
4153
  replacementText: string;
4155
4154
  };
@@ -4163,15 +4162,15 @@ declare type CopyPermissions = {
4163
4162
  */
4164
4163
  declare type CornerRounding = {
4165
4164
  /**
4166
- * @defaultValue 0
4167
- *
4168
4165
  * The height in pixels.
4166
+ *
4167
+ * @default 0
4169
4168
  */
4170
4169
  height: number;
4171
4170
  /**
4172
- * @defaultValue 0
4173
- *
4174
4171
  * The width in pixels.
4172
+ *
4173
+ * @default 0
4175
4174
  */
4176
4175
  width: number;
4177
4176
  };
@@ -4261,8 +4260,6 @@ declare type CreateLayoutOptions = {
4261
4260
  layoutName: string;
4262
4261
  layout: LayoutOptions;
4263
4262
  /**
4264
- * @defaultValue 'default'
4265
- *
4266
4263
  * Controls the View behavior for the given `layout` property. Note
4267
4264
  * that the selected behavior only applies to unnamed Views or
4268
4265
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4284,6 +4281,8 @@ declare type CreateLayoutOptions = {
4284
4281
  * override. Note that during applyLayoutSnapshot, Views are created and
4285
4282
  * attached to the Provider while the Window is being created, so it's
4286
4283
  * important to not 'duplicate' Views in this workflow.
4284
+ *
4285
+ * @default 'default'
4287
4286
  */
4288
4287
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4289
4288
  };
@@ -4543,7 +4542,7 @@ declare type DomainApiSettings = {
4543
4542
  * * 'none': The `fin` API will be not available.
4544
4543
  * * 'global': The entire `fin` API will be available.
4545
4544
  *
4546
- * @defaultValue 'global'
4545
+ * @default 'global'
4547
4546
  */
4548
4547
  fin?: InjectionType;
4549
4548
  /**
@@ -5135,9 +5134,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5135
5134
  */
5136
5135
  declare type ExcludeOptions = {
5137
5136
  /**
5138
- * @defaultValue false
5139
- *
5140
5137
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5138
+ *
5139
+ * @default false
5141
5140
  */
5142
5141
  preloadScripts: boolean;
5143
5142
  };
@@ -5623,34 +5622,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5623
5622
  */
5624
5623
  declare type FindInPageOptions = {
5625
5624
  /**
5626
- * @defaultValue true
5627
- *
5628
5625
  * Searches in the forward direction (backward otherwise)
5626
+ *
5627
+ * @default true
5629
5628
  */
5630
5629
  forward?: boolean;
5631
5630
  /**
5632
- * @defaultValue false
5633
- *
5634
5631
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5632
+ *
5633
+ * @default false
5635
5634
  */
5636
5635
  findNext?: boolean;
5637
5636
  /**
5638
- * @defaultValue false
5639
- *
5640
5637
  * Enables case-sensitive searching.
5638
+ *
5639
+ * @default false
5641
5640
  */
5642
5641
  matchCase?: boolean;
5643
5642
  /**
5644
- * @defaultValue false
5645
- *
5646
5643
  * Only searches from the start of words.
5644
+ *
5645
+ * @default false
5647
5646
  */
5648
5647
  wordStart?: boolean;
5649
5648
  /**
5650
- * @defaultValue false
5651
- *
5652
5649
  * 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>
5653
5650
  * lowercase or non-letter. Accepts several other intra-word matches.
5651
+ *
5652
+ * @default false
5654
5653
  */
5655
5654
  medialCapitalAsWordStart?: boolean;
5656
5655
  };
@@ -6164,9 +6163,9 @@ declare type Hotkey = {
6164
6163
  */
6165
6164
  keys: string;
6166
6165
  /**
6167
- * @defaultValue false
6168
- *
6169
6166
  * Prevent default key handling before emitting the event.
6167
+ *
6168
+ * @default false
6170
6169
  */
6171
6170
  preventDefault?: boolean;
6172
6171
  };
@@ -8707,77 +8706,79 @@ declare type LayoutOptions = {
8707
8706
  */
8708
8707
  settings?: {
8709
8708
  /**
8710
- * @defaultValue false
8711
- *
8712
8709
  * When true the splitters will not be draggable and the layout will not resize.
8710
+ *
8711
+ * @default false
8713
8712
  */
8714
8713
  preventSplitterResize?: boolean;
8715
8714
  /**
8716
- * @defaultValue false
8717
- *
8718
8715
  * Whether the popout button will only act on the entire stack,
8719
8716
  * as opposed to only the active tab.
8717
+ *
8718
+ * @default false
8720
8719
  */
8721
8720
  popoutWholeStack?: boolean;
8722
8721
  /**
8723
- * @defaultValue false
8724
- *
8725
8722
  * Limits the area to which tabs can be dragged.
8726
8723
  * If true, the layout container is the only area where tabs can be dropped.
8724
+ *
8725
+ * @default false
8727
8726
  */
8728
8727
  constrainDragToContainer?: boolean;
8729
8728
  /**
8730
- * @defaultValue false
8731
- *
8732
8729
  * Whether to show the popout button on stack header.
8733
8730
  * The button will create a new window with current tab as its content.
8734
8731
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8732
+ *
8733
+ * @default false
8735
8734
  */
8736
8735
  showPopoutIcon?: boolean;
8737
8736
  /**
8738
- * @defaultValue false
8739
- *
8740
8737
  * Whether to show the maximize button on stack header.
8741
8738
  * The button will maximize the current tab to fill the entire window.
8739
+ *
8740
+ * @default false
8742
8741
  */
8743
8742
  showMaximiseIcon?: boolean;
8744
8743
  /**
8745
- * @defaultValue false
8746
- *
8747
8744
  * Whether to show the close button on stack header
8748
8745
  * (not to be confused with close button on every tab).
8746
+ *
8747
+ * @default false
8749
8748
  */
8750
8749
  showCloseIcon?: boolean;
8751
8750
  /**
8752
- * @defaultValue false
8753
- *
8754
8751
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8752
+ *
8753
+ * @default false
8755
8754
  */
8756
8755
  constrainDragToHeaders?: boolean;
8757
8756
  /**
8758
- * @defaultValue true
8759
- *
8760
8757
  * Turns tab headers on or off.
8761
8758
  * If false, the layout will be displayed with splitters only.
8759
+ *
8760
+ * @default true
8762
8761
  */
8763
8762
  hasHeaders?: boolean;
8764
8763
  /**
8765
- * @defaultValue true
8766
- *
8767
8764
  * If true, the user can re-arrange the layout by
8768
8765
  * dragging items by their tabs to the desired location.
8766
+ *
8767
+ * @default true
8769
8768
  */
8770
8769
  reorderEnabled?: boolean;
8771
8770
  /**
8772
- * @defaultValue false
8773
- *
8774
8771
  * If true, tabs can't be dragged out of the window.
8772
+ *
8773
+ * @default false
8775
8774
  */
8776
8775
  preventDragOut?: boolean;
8777
8776
  /**
8778
8777
  * @defaultValue=false
8779
8778
  *
8780
8779
  * If true, tabs can't be dragged into the window.
8780
+ *
8781
+ * @default false
8781
8782
  */
8782
8783
  preventDragIn?: boolean;
8783
8784
  };
@@ -9220,10 +9221,10 @@ declare type MutableViewOptions = {
9220
9221
  /**
9221
9222
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9222
9223
  *
9223
- * @defaultValue true
9224
- *
9225
9224
  * Show the context menu when right-clicking on the view.
9226
9225
  * Gives access to the devtools for the view.
9226
+ *
9227
+ * @default true
9227
9228
  */
9228
9229
  contextMenu: boolean;
9229
9230
  /**
@@ -9270,24 +9271,25 @@ declare type MutableViewOptions = {
9270
9271
  contentNavigation: ContentNavigation;
9271
9272
  contentRedirect: ContentRedirect;
9272
9273
  /**
9273
- * @defaultValue false
9274
9274
  * @deprecated
9275
9275
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9276
9276
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9277
+ *
9278
+ * @default false
9277
9279
  */
9278
9280
  detachOnClose: boolean;
9279
9281
  /**
9280
- * @defaultValue true
9281
- *
9282
9282
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9283
9283
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9284
9284
  * if the view isn't part of the new layout when running `Layout.replace`.
9285
+ *
9286
+ * @default true
9285
9287
  */
9286
9288
  isClosable: boolean;
9287
9289
  /**
9288
- * @defaultValue false
9289
- *
9290
9290
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9291
+ *
9292
+ * @default false
9291
9293
  */
9292
9294
  preventDragOut: boolean;
9293
9295
  interop?: InteropConfig;
@@ -9299,7 +9301,7 @@ declare type MutableViewOptions = {
9299
9301
  /**
9300
9302
  * {@inheritDoc ViewThrottling}
9301
9303
  *
9302
- * @defaultValue 'enabled'
9304
+ * @default 'enabled'
9303
9305
  */
9304
9306
  throttling: ViewThrottling;
9305
9307
  /**
@@ -9318,7 +9320,7 @@ declare type MutableWindowOptions = {
9318
9320
  * Turns anything of matching RGB value transparent.
9319
9321
  *
9320
9322
  * Caveats:
9321
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9323
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9322
9324
  * * User cannot click-through transparent regions
9323
9325
  * * Not supported on Mac
9324
9326
  * * Windows Aero must be enabled
@@ -9327,25 +9329,25 @@ declare type MutableWindowOptions = {
9327
9329
  */
9328
9330
  alphaMask: RGB;
9329
9331
  /**
9330
- * @defaultValue false
9331
- *
9332
9332
  * Always position the window at the top of the window stack.
9333
+ *
9334
+ * @default false
9333
9335
  */
9334
9336
  alwaysOnTop: boolean;
9335
9337
  /**
9336
- * @defaultValue 0
9337
- *
9338
9338
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9339
9339
  * an aspect ratio will not be enforced.
9340
+ *
9341
+ * @default 0
9340
9342
  */
9341
9343
  aspectRatio: number;
9342
9344
  /**
9343
9345
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9344
9346
  *
9345
- * @defaultValue true
9346
- *
9347
9347
  * Show the context menu when right-clicking on the window.
9348
9348
  * Gives access to the devtools for the window.
9349
+ *
9350
+ * @default true
9349
9351
  */
9350
9352
  contextMenu: boolean;
9351
9353
  /**
@@ -9415,12 +9417,14 @@ declare type MutableWindowOptions = {
9415
9417
  * @defaultValue true
9416
9418
  *
9417
9419
  * Show the window's frame.
9420
+ *
9421
+ * @default true
9418
9422
  */
9419
9423
  frame: boolean;
9420
9424
  /**
9421
- * @defaultValue false
9422
- *
9423
9425
  * Hides the window instead of closing it when the close button is pressed.
9426
+ *
9427
+ * @default false
9424
9428
  */
9425
9429
  hideOnClose: boolean;
9426
9430
  /**
@@ -9473,60 +9477,61 @@ declare type MutableWindowOptions = {
9473
9477
  */
9474
9478
  icon: string;
9475
9479
  /**
9476
- * @defaultValue true
9477
- *
9478
9480
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9479
9481
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9482
+ *
9483
+ * @default true
9480
9484
  */
9481
9485
  includeInSnapshots: boolean;
9482
9486
  /**
9483
- * @defaultValue -1
9484
- *
9485
9487
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9488
+ *
9489
+ * @default -1
9486
9490
  */
9487
9491
  maxHeight: number;
9488
9492
  /**
9489
- * @defaultValue true
9490
- *
9491
9493
  * Allows the window to be maximized.
9494
+ *
9495
+ * @default true
9492
9496
  */
9493
9497
  maximizable: boolean;
9494
9498
  /**
9495
- * @defaultValue -1
9496
- *
9497
9499
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9500
+ *
9501
+ * @default -1
9498
9502
  */
9499
9503
  maxWidth: number;
9500
9504
  /**
9501
- * @defaultValue 0
9502
- *
9503
9505
  * The minimum height of the window.
9506
+ *
9507
+ * @default 0
9504
9508
  */
9505
9509
  minHeight: number;
9506
9510
  /**
9507
- * @defaultValue true
9508
- *
9509
9511
  * Allows the window to be minimized.
9512
+ *
9513
+ * @default true
9510
9514
  */
9511
9515
  minimizable: boolean;
9512
9516
  /**
9513
- * @defaultValue true
9514
- *
9515
9517
  * The minimum width of the window.
9518
+ *
9519
+ * @default true
9516
9520
  */
9517
9521
  minWidth: number;
9518
9522
  /**
9519
- * @defaultValue 1
9520
- *
9521
9523
  * A flag that specifies how transparent the window will be.
9522
9524
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9523
9525
  * This value is clamped between `0.0` and `1.0`.
9526
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9527
+ *
9528
+ * @default 1
9524
9529
  */
9525
9530
  opacity: number;
9526
9531
  /**
9527
- * @defaultValue true
9528
- *
9529
9532
  * A flag to allow the user to resize the window.
9533
+ *
9534
+ * @default true
9530
9535
  */
9531
9536
  resizable: boolean;
9532
9537
  /**
@@ -9534,16 +9539,16 @@ declare type MutableWindowOptions = {
9534
9539
  */
9535
9540
  resizeRegion: ResizeRegion;
9536
9541
  /**
9537
- * @defaultValue false
9538
- *
9539
9542
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9540
9543
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9544
+ *
9545
+ * @default false
9541
9546
  */
9542
9547
  showBackgroundImages: boolean;
9543
9548
  /**
9544
- * @defaultValue true
9545
- *
9546
9549
  * Shows the window's icon in the taskbar.
9550
+ *
9551
+ * @default true
9547
9552
  */
9548
9553
  showTaskbarIcon: boolean;
9549
9554
  /**
@@ -9566,7 +9571,7 @@ declare type MutableWindowOptions = {
9566
9571
  /**
9567
9572
  * {@inheritDoc WindowThrottling}
9568
9573
  *
9569
- * @defaultValue 'enabled'
9574
+ * @default 'enabled'
9570
9575
  *
9571
9576
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9572
9577
  */
@@ -10185,12 +10190,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10185
10190
  */
10186
10191
  declare type PastePermissions = {
10187
10192
  /**
10188
- * @defaultValue 'non-protected-content'
10189
- *
10190
10193
  * Controls the behavior for paste operations for a matched URL.
10191
10194
  *
10192
10195
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10193
10196
  * 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.
10197
+ *
10198
+ * @default 'non-protected-content'
10194
10199
  */
10195
10200
  behavior: 'non-protected-content' | 'all-content';
10196
10201
  };
@@ -11255,11 +11260,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11255
11260
  */
11256
11261
  providerUrl?: string;
11257
11262
  /**
11258
- * @defaultValue true
11259
- *
11260
11263
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11261
11264
  *
11262
11265
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11266
+ *
11267
+ * @default true
11263
11268
  */
11264
11269
  allowLaunchIntoPlatform?: boolean;
11265
11270
  };
@@ -11948,22 +11953,22 @@ declare type PopupOptions = {
11948
11953
  url?: string;
11949
11954
  /**
11950
11955
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11951
- * @defaultValue 300
11956
+ * @default 300
11952
11957
  */
11953
11958
  height?: number;
11954
11959
  /**
11955
11960
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11956
- * @defaultValue 300
11961
+ * @default 300
11957
11962
  */
11958
11963
  width?: number;
11959
11964
  /**
11960
11965
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11961
- * @defaultValue 0
11966
+ * @default 0
11962
11967
  */
11963
11968
  x?: number;
11964
11969
  /**
11965
11970
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11966
- * @defaultValue 0
11971
+ * @default 0
11967
11972
  */
11968
11973
  y?: number;
11969
11974
  /**
@@ -11971,7 +11976,7 @@ declare type PopupOptions = {
11971
11976
  * * 'modal' restricts resizing and positioning in the caller.
11972
11977
  * * 'hide' hides the popup window on blur.
11973
11978
  * * 'close' closes the popup window on blur.
11974
- * @defaultValue 'close'
11979
+ * @default 'close'
11975
11980
  */
11976
11981
  blurBehavior?: PopupBlurBehavior;
11977
11982
  /**
@@ -11979,19 +11984,19 @@ declare type PopupOptions = {
11979
11984
  * * 'none' will do nothing.
11980
11985
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11981
11986
  * * 'close' closes the popup window on `dispatchPopupResult`.
11982
- * @defaultValue 'close'
11987
+ * @default 'close'
11983
11988
  */
11984
11989
  resultDispatchBehavior?: PopupResultBehavior;
11985
11990
  /**
11986
11991
  * Hide the popup window instead of closing when `close` is called on it.
11987
11992
  *
11988
11993
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11989
- * @defaultValue false
11994
+ * @default false
11990
11995
  */
11991
11996
  hideOnClose?: boolean;
11992
11997
  /**
11993
11998
  * Determines if the popup window should or should not be focused when it is shown.
11994
- * @defaultValue true
11999
+ * @default true
11995
12000
  */
11996
12001
  focus?: boolean;
11997
12002
  /**
@@ -12085,9 +12090,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12085
12090
  */
12086
12091
  declare type PreloadScript = {
12087
12092
  /**
12088
- * @defaultValue false
12089
- *
12090
12093
  * Fail to load the window if this preload script fails
12094
+ *
12095
+ * @default false
12091
12096
  */
12092
12097
  mandatory?: boolean;
12093
12098
  /**
@@ -12183,15 +12188,15 @@ declare type PrinterInfo = {
12183
12188
  declare type PrintOptions = {
12184
12189
  content?: 'self';
12185
12190
  /**
12186
- * @defaultValue false
12187
- *
12188
12191
  * Disables prompting the user for print settings.
12192
+ *
12193
+ * @default false
12189
12194
  */
12190
12195
  silent?: boolean;
12191
12196
  /**
12192
- * @defaultValue false
12193
- *
12194
12197
  * Includes the webpage background color and image when printing.
12198
+ *
12199
+ * @default false
12195
12200
  */
12196
12201
  printBackground?: boolean;
12197
12202
  /**
@@ -12199,9 +12204,9 @@ declare type PrintOptions = {
12199
12204
  */
12200
12205
  deviceName?: string;
12201
12206
  /**
12202
- * @defaultValue true
12203
- *
12204
12207
  * Prints in full color (greyscale otherwise).
12208
+ *
12209
+ * @default true
12205
12210
  */
12206
12211
  color?: boolean;
12207
12212
  /**
@@ -12209,9 +12214,9 @@ declare type PrintOptions = {
12209
12214
  */
12210
12215
  margins?: Margins;
12211
12216
  /**
12212
- * @defaultValue true
12213
- *
12214
12217
  * Prints in landscape mode (portrait otherwise).
12218
+ *
12219
+ * @default true
12215
12220
  */
12216
12221
  landscape?: boolean;
12217
12222
  /**
@@ -13382,15 +13387,15 @@ declare type ReplaceViewPayload = {
13382
13387
  */
13383
13388
  declare type ResizeRegion = {
13384
13389
  /**
13385
- * @defaultValue 7
13386
- *
13387
13390
  * The size of the resize region in pixels.
13391
+ *
13392
+ * @default 7
13388
13393
  */
13389
13394
  size?: number;
13390
13395
  /**
13391
- * @defaultValue 9
13392
- *
13393
13396
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13397
+ *
13398
+ * @default 9
13394
13399
  */
13395
13400
  bottomRightCorner?: number;
13396
13401
  /**
@@ -13398,27 +13403,27 @@ declare type ResizeRegion = {
13398
13403
  */
13399
13404
  sides?: {
13400
13405
  /**
13401
- * @defaultValue true
13402
- *
13403
13406
  * Enables resizing from the top of the window.
13407
+ *
13408
+ * @default true
13404
13409
  */
13405
13410
  top?: boolean;
13406
13411
  /**
13407
- * @defaultValue true
13408
- *
13409
13412
  * Enables resizing from the bottom of the window.
13413
+ *
13414
+ * @default true
13410
13415
  */
13411
13416
  bottom?: boolean;
13412
13417
  /**
13413
- * @defaultValue true
13414
- *
13415
13418
  * Enables resizing from the left side of the window.
13419
+ *
13420
+ * @default true
13416
13421
  */
13417
13422
  left?: boolean;
13418
13423
  /**
13419
- * @defaultValue true
13420
- *
13421
13424
  * Enables resizing from the right side of the window.
13425
+ *
13426
+ * @default true
13422
13427
  */
13423
13428
  right?: boolean;
13424
13429
  };
@@ -13962,9 +13967,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13962
13967
  */
13963
13968
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13964
13969
  /**
13965
- * @defaultValue 0
13966
- *
13967
13970
  * Number of milliseconds to wait between view repaints.
13971
+ *
13972
+ * @default 0
13968
13973
  */
13969
13974
  paintIntervalMs?: number;
13970
13975
  };
@@ -16015,9 +16020,9 @@ declare type TransitionBase = {
16015
16020
  */
16016
16021
  duration: number;
16017
16022
  /**
16018
- * @defaultValue false
16019
- *
16020
16023
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16024
+ *
16025
+ * @default false
16021
16026
  */
16022
16027
  relative?: boolean;
16023
16028
  };
@@ -16033,9 +16038,9 @@ declare type TransitionOptions = {
16033
16038
  */
16034
16039
  interrupt: boolean;
16035
16040
  /**
16036
- * @defaultValue false
16037
- *
16038
16041
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16042
+ *
16043
+ * @default false
16039
16044
  */
16040
16045
  relative?: boolean;
16041
16046
  tween?: tween;
@@ -16994,9 +16999,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
16994
16999
  */
16995
17000
  declare type ViewVisibilityOption = {
16996
17001
  /**
16997
- * @defaultValue false
16998
- *
16999
17002
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17003
+ *
17004
+ * @default false
17000
17005
  */
17001
17006
  enabled?: boolean;
17002
17007
  };