@openfin/core 43.100.47 → 43.100.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/out/stub.d.ts CHANGED
@@ -139,13 +139,13 @@ declare type ApiSettings = {
139
139
  /**
140
140
  * Inject OpenFin API into cross-origin iframes
141
141
  *
142
- * @defaultValue false
142
+ * @default false
143
143
  */
144
144
  crossOriginInjection?: boolean;
145
145
  /**
146
146
  * Inject OpenFin API into same-origin iframes
147
147
  *
148
- * @defaultValue true
148
+ * @default true
149
149
  */
150
150
  sameOriginInjection?: boolean;
151
151
  /**
@@ -1190,19 +1190,19 @@ declare class ApplicationModule extends Base {
1190
1190
  */
1191
1191
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1192
1192
  /**
1193
- * @defaultValue false
1194
- *
1195
1193
  * Disables IAB secure logging for the app.
1194
+ *
1195
+ * @default false
1196
1196
  */
1197
1197
  disableIabSecureLogging: boolean;
1198
1198
  /**
1199
- * @defaultValue 'There was an error loading the application.'
1200
- *
1201
1199
  * An error message to display when the application (launched via manifest) fails to load.
1202
1200
  * A dialog box will be launched with the error message just before the runtime exits.
1203
1201
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1204
1202
  * will trigger this dialog.
1205
1203
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1204
+ *
1205
+ * @default 'There was an error loading the application.'
1206
1206
  */
1207
1207
  loadErrorMessage: string;
1208
1208
  /**
@@ -1221,28 +1221,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1221
1221
  */
1222
1222
  name: string;
1223
1223
  /**
1224
- * @defaultValue false
1225
- *
1226
1224
  * A flag to configure the application as non-persistent.
1227
1225
  * Runtime exits when there are no persistent apps running.
1226
+ *
1227
+ * @default false
1228
1228
  */
1229
1229
  nonPersistent: boolean;
1230
1230
  /**
1231
- * @defaultValue false
1232
- *
1233
1231
  * Enable Flash at the application level.
1232
+ *
1233
+ * @default false
1234
1234
  */
1235
1235
  plugins: boolean;
1236
1236
  /**
1237
- * @defaultValue false
1238
- *
1239
1237
  * Enable spell check at the application level.
1238
+ *
1239
+ * @default false
1240
1240
  */
1241
1241
  spellCheck: boolean;
1242
1242
  /**
1243
- * @defaultValue 'about:blank'
1244
- *
1245
1243
  * The url to the application (specifically the application's main window).
1244
+ *
1245
+ * @default 'about:blank'
1246
1246
  */
1247
1247
  url: string;
1248
1248
  /**
@@ -1251,9 +1251,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1251
1251
  */
1252
1252
  uuid: string;
1253
1253
  /**
1254
- * @defaultValue true
1255
- *
1256
1254
  * When set to `false` it will disable the same-origin policy for the app.
1255
+ *
1256
+ * @default true
1257
1257
  */
1258
1258
  webSecurity: boolean;
1259
1259
  /**
@@ -1263,10 +1263,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1263
1263
  commands: ShortcutOverride[];
1264
1264
  isPlatformController: boolean;
1265
1265
  /**
1266
- * @defaultValue 1000
1267
- *
1268
1266
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1269
1267
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1268
+ *
1269
+ * @default 1000
1270
1270
  */
1271
1271
  maxViewPoolSize: number;
1272
1272
  /**
@@ -1282,12 +1282,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1282
1282
  */
1283
1283
  snapshot: Snapshot;
1284
1284
  /**
1285
- * @defaultValue false
1286
- *
1287
1285
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1288
1286
  *
1289
1287
  * Note: if the Platform Provider is showing, it won't close automatically.
1290
1288
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1289
+ *
1290
+ * @default false
1291
1291
  */
1292
1292
  preventQuitOnLastWindowClosed: boolean;
1293
1293
  /**
@@ -1295,9 +1295,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1295
1295
  */
1296
1296
  interopBrokerConfiguration: InteropBrokerOptions;
1297
1297
  /**
1298
- * @defaultValue true
1299
- *
1300
1298
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1299
+ *
1300
+ * @default true
1301
1301
  */
1302
1302
  apiDiagnostics: boolean;
1303
1303
  /**
@@ -1313,16 +1313,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1313
1313
  */
1314
1314
  permissions?: Partial<Permissions_2>;
1315
1315
  /**
1316
- * @defaultValue false
1317
- *
1318
1316
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1319
1317
  * Only relevant in Windows.
1318
+ *
1319
+ * @default false
1320
1320
  */
1321
1321
  enableJumpList: boolean;
1322
1322
  /**
1323
- * @defaultValue false
1324
- *
1325
1323
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1324
+ *
1325
+ * @default false
1326
1326
  */
1327
1327
  enableBeforeUnload: boolean;
1328
1328
  /**
@@ -1403,25 +1403,25 @@ declare type ApplicationWindowInfo = {
1403
1403
  */
1404
1404
  declare type ApplySnapshotOptions = {
1405
1405
  /**
1406
- * @defaultValue false
1407
- *
1408
1406
  * When true, applySnapshot will close existing windows,
1409
1407
  * replacing current Platform state with the given snapshot.
1408
+ *
1409
+ * @default false
1410
1410
  */
1411
1411
  closeExistingWindows?: boolean;
1412
1412
  /**
1413
- * @defaultValue false
1414
- *
1415
1413
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1416
1414
  * replacing current Platform state with the given snapshot.
1415
+ *
1416
+ * @default false
1417
1417
  */
1418
1418
  closeSnapshotWindows?: boolean;
1419
1419
  /**
1420
- * @defaultValue false
1421
- *
1422
1420
  * When true, applySnapshot will not check whether any windows in a
1423
1421
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1424
1422
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1423
+ *
1424
+ * @default false
1425
1425
  */
1426
1426
  skipOutOfBoundsCheck?: boolean;
1427
1427
  };
@@ -2104,15 +2104,15 @@ declare type CapturePageOptions = {
2104
2104
  */
2105
2105
  area?: Rectangle;
2106
2106
  /**
2107
- * @defaultValue 'png'
2108
- *
2109
2107
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2108
+ *
2109
+ * @default 'png'
2110
2110
  */
2111
2111
  format?: 'bmp' | 'jpg' | 'png';
2112
2112
  /**
2113
- * @defaultValue 100
2114
- *
2115
2113
  * Quality of JPEG image. Between 0 - 100.
2114
+ *
2115
+ * @default 100
2116
2116
  */
2117
2117
  quality?: number;
2118
2118
  };
@@ -2766,9 +2766,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2766
2766
  */
2767
2767
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2768
2768
  /**
2769
- * @defaultValue true
2770
- *
2771
2769
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2770
+ *
2771
+ * @default true
2772
2772
  */
2773
2773
  wait?: boolean;
2774
2774
  /**
@@ -3430,9 +3430,9 @@ declare interface CloseWindowPayload {
3430
3430
  windowId: Identity_4;
3431
3431
  options: {
3432
3432
  /**
3433
- * @defaultValue false
3434
- *
3435
3433
  * When set to true skips any before handler set on views that are part of the window
3434
+ *
3435
+ * @default false
3436
3436
  */
3437
3437
  skipBeforeUnload?: boolean;
3438
3438
  };
@@ -3540,9 +3540,9 @@ declare type ConstViewOptions = {
3540
3540
  */
3541
3541
  name: string;
3542
3542
  /**
3543
- * @defaultValue "about:blank"
3544
- *
3545
3543
  * The URL of the window
3544
+ *
3545
+ * @default "about:blank"
3546
3546
  */
3547
3547
  url: string;
3548
3548
  /**
@@ -3603,9 +3603,9 @@ declare type ConstViewOptions = {
3603
3603
  experimental: any;
3604
3604
  fdc3InteropApi?: string;
3605
3605
  /**
3606
- * @defaultValue false
3607
- *
3608
3606
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3607
+ *
3608
+ * @default false
3609
3609
  */
3610
3610
  enableBeforeUnload: boolean;
3611
3611
  /**
@@ -3686,13 +3686,12 @@ declare type ConstWindowOptions = {
3686
3686
  */
3687
3687
  backgroundColor: string;
3688
3688
  /**
3689
- * @defaultValue false
3690
- *
3691
3689
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3692
3690
  * This also affects the Page Visibility API.
3693
3691
  *
3694
3692
  * When `true`, the page is throttled whether it is hidden or not.
3695
3693
  *
3694
+ * @default false
3696
3695
  */
3697
3696
  backgroundThrottling: boolean;
3698
3697
  /**
@@ -3716,21 +3715,21 @@ declare type ConstWindowOptions = {
3716
3715
  */
3717
3716
  customRequestHeaders: CustomRequestHeaders[];
3718
3717
  /**
3719
- * @defaultValue true
3720
- *
3721
3718
  * Setting this to false would keep the Window alive even if all its Views were closed.
3722
3719
  * This is meant for advanced users and should be used with caution.
3723
3720
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3724
3721
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3725
3722
  * **NOTE:** - This option is ignored in non-Platforms apps.
3723
+ *
3724
+ * @default true
3726
3725
  */
3727
3726
  closeOnLastViewRemoved: boolean;
3728
3727
  /**
3729
- * @defaultValue 'all'
3730
- *
3731
3728
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3732
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3729
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3733
3730
  * **NOTE:** - This option is ignored in non-Platforms apps.
3731
+ *
3732
+ * @default 'all'
3734
3733
  */
3735
3734
  viewsPreventingClose: 'all' | 'layout';
3736
3735
  /**
@@ -3741,31 +3740,31 @@ declare type ConstWindowOptions = {
3741
3740
  */
3742
3741
  defaultCentered: boolean;
3743
3742
  /**
3744
- * @defaultValue 500
3745
- *
3746
3743
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3747
3744
  * in favor of the cached value.
3745
+ *
3746
+ * @default 500
3748
3747
  */
3749
3748
  defaultHeight: number;
3750
3749
  /**
3751
- * @defaultValue 100
3752
- *
3753
3750
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3754
3751
  * launches in favor of the cached value.
3752
+ *
3753
+ * @default 100
3755
3754
  */
3756
3755
  defaultLeft: number;
3757
3756
  /**
3758
- * @defaultValue 100
3759
- *
3760
3757
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3761
3758
  * launches in favor of the cached value.
3759
+ *
3760
+ * @default 100
3762
3761
  */
3763
3762
  defaultTop: number;
3764
3763
  /**
3765
- * @defaultValue 800
3766
- *
3767
3764
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3768
3765
  * launches in favor of the cached value.
3766
+ *
3767
+ * @default 800
3769
3768
  */
3770
3769
  defaultWidth: number;
3771
3770
  /**
@@ -3811,19 +3810,19 @@ declare type ConstWindowOptions = {
3811
3810
  */
3812
3811
  processAffinity: string;
3813
3812
  /**
3814
- * @defaultValue false
3815
- *
3816
3813
  * Displays a shadow on frameless windows.
3817
3814
  * `shadow` and `cornerRounding` are mutually exclusive.
3818
3815
  * On Windows 7, Aero theme is required.
3816
+ *
3817
+ * @default false
3819
3818
  */
3820
3819
  shadow: boolean;
3821
3820
  /**
3822
- * @defaultValue true
3823
- *
3824
3821
  * Caches the location of the window.
3825
3822
  *
3826
3823
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3824
+ *
3825
+ * @default true
3827
3826
  */
3828
3827
  saveWindowState: boolean;
3829
3828
  /**
@@ -3832,22 +3831,22 @@ declare type ConstWindowOptions = {
3832
3831
  */
3833
3832
  ignoreSavedWindowState: boolean;
3834
3833
  /**
3835
- * @defaultValue false
3836
- *
3837
3834
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3838
3835
  *
3839
3836
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3840
3837
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3838
+ *
3839
+ * @default false
3841
3840
  */
3842
3841
  smallWindow: boolean;
3843
3842
  /**
3844
- * @defaultValue "normal"
3845
- *
3846
3843
  * The visible state of the window on creation.
3847
3844
  * One of:
3848
3845
  * * `"maximized"`
3849
3846
  * * `"minimized"`
3850
3847
  * * `"normal"`
3848
+ *
3849
+ * @default "normal"
3851
3850
  */
3852
3851
  state: WindowState;
3853
3852
  /**
@@ -3862,26 +3861,26 @@ declare type ConstWindowOptions = {
3862
3861
  */
3863
3862
  taskbarIconGroup: string;
3864
3863
  /**
3865
- * @defaultValue "about:blank"
3866
- *
3867
3864
  * The URL of the window
3865
+ *
3866
+ * @default "about:blank"
3868
3867
  */
3869
3868
  url: string;
3870
3869
  /**
3871
- * @defaultValue <application UUID>
3872
- *
3873
3870
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3874
3871
  * If omitted, defaults to the `uuid` of the application spawning the window.
3875
3872
  * If given, must match the `uuid` of the application spawning the window.
3876
3873
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3877
3874
  * really no need to provide it.
3875
+ *
3876
+ * @default <application UUID>
3878
3877
  */
3879
3878
  uuid: string;
3880
3879
  /**
3881
- * @defaultValue false
3882
- *
3883
3880
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3884
3881
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3882
+ *
3883
+ * @default false
3885
3884
  */
3886
3885
  waitForPageLoad: boolean;
3887
3886
  width: number;
@@ -4163,13 +4162,13 @@ declare type CopyBlockedEventReason = 'disabled';
4163
4162
  */
4164
4163
  declare type CopyPermissions = {
4165
4164
  /**
4166
- * @defaultValue 'allowed'
4167
- *
4168
4165
  * Controls the behavior for copy operations for a matched URL.
4169
4166
  *
4170
4167
  * allow: Enables all copy operations.
4171
4168
  * block: Disables all copy operations.
4172
4169
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4170
+ *
4171
+ * @default 'allowed'
4173
4172
  */
4174
4173
  behavior: 'allow' | 'block' | 'protect';
4175
4174
  /**
@@ -4177,9 +4176,9 @@ declare type CopyPermissions = {
4177
4176
  */
4178
4177
  options?: {
4179
4178
  /**
4180
- * @defaultValue ''
4181
- *
4182
4179
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4180
+ *
4181
+ * @default ''
4183
4182
  */
4184
4183
  replacementText: string;
4185
4184
  };
@@ -4193,15 +4192,15 @@ declare type CopyPermissions = {
4193
4192
  */
4194
4193
  declare type CornerRounding = {
4195
4194
  /**
4196
- * @defaultValue 0
4197
- *
4198
4195
  * The height in pixels.
4196
+ *
4197
+ * @default 0
4199
4198
  */
4200
4199
  height: number;
4201
4200
  /**
4202
- * @defaultValue 0
4203
- *
4204
4201
  * The width in pixels.
4202
+ *
4203
+ * @default 0
4205
4204
  */
4206
4205
  width: number;
4207
4206
  };
@@ -4291,8 +4290,6 @@ declare type CreateLayoutOptions = {
4291
4290
  layoutName: string;
4292
4291
  layout: LayoutOptions;
4293
4292
  /**
4294
- * @defaultValue 'default'
4295
- *
4296
4293
  * Controls the View behavior for the given `layout` property. Note
4297
4294
  * that the selected behavior only applies to unnamed Views or
4298
4295
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4314,6 +4311,8 @@ declare type CreateLayoutOptions = {
4314
4311
  * override. Note that during applyLayoutSnapshot, Views are created and
4315
4312
  * attached to the Provider while the Window is being created, so it's
4316
4313
  * important to not 'duplicate' Views in this workflow.
4314
+ *
4315
+ * @default 'default'
4317
4316
  */
4318
4317
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4319
4318
  };
@@ -4572,7 +4571,7 @@ declare type DomainApiSettings = {
4572
4571
  * * 'none': The `fin` API will be not available.
4573
4572
  * * 'global': The entire `fin` API will be available.
4574
4573
  *
4575
- * @defaultValue 'global'
4574
+ * @default 'global'
4576
4575
  */
4577
4576
  fin?: InjectionType;
4578
4577
  /**
@@ -5171,9 +5170,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5171
5170
  */
5172
5171
  declare type ExcludeOptions = {
5173
5172
  /**
5174
- * @defaultValue false
5175
- *
5176
5173
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5174
+ *
5175
+ * @default false
5177
5176
  */
5178
5177
  preloadScripts: boolean;
5179
5178
  };
@@ -5673,34 +5672,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5673
5672
  */
5674
5673
  declare type FindInPageOptions = {
5675
5674
  /**
5676
- * @defaultValue true
5677
- *
5678
5675
  * Searches in the forward direction (backward otherwise)
5676
+ *
5677
+ * @default true
5679
5678
  */
5680
5679
  forward?: boolean;
5681
5680
  /**
5682
- * @defaultValue false
5683
- *
5684
5681
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5682
+ *
5683
+ * @default false
5685
5684
  */
5686
5685
  findNext?: boolean;
5687
5686
  /**
5688
- * @defaultValue false
5689
- *
5690
5687
  * Enables case-sensitive searching.
5688
+ *
5689
+ * @default false
5691
5690
  */
5692
5691
  matchCase?: boolean;
5693
5692
  /**
5694
- * @defaultValue false
5695
- *
5696
5693
  * Only searches from the start of words.
5694
+ *
5695
+ * @default false
5697
5696
  */
5698
5697
  wordStart?: boolean;
5699
5698
  /**
5700
- * @defaultValue false
5701
- *
5702
5699
  * When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
5703
5700
  * lowercase or non-letter. Accepts several other intra-word matches.
5701
+ *
5702
+ * @default false
5704
5703
  */
5705
5704
  medialCapitalAsWordStart?: boolean;
5706
5705
  };
@@ -6214,9 +6213,9 @@ declare type Hotkey = {
6214
6213
  */
6215
6214
  keys: string;
6216
6215
  /**
6217
- * @defaultValue false
6218
- *
6219
6216
  * Prevent default key handling before emitting the event.
6217
+ *
6218
+ * @default false
6220
6219
  */
6221
6220
  preventDefault?: boolean;
6222
6221
  };
@@ -8778,77 +8777,79 @@ declare type LayoutOptions = {
8778
8777
  */
8779
8778
  newTabButtonUrl?: string;
8780
8779
  /**
8781
- * @defaultValue false
8782
- *
8783
8780
  * When true the splitters will not be draggable and the layout will not resize.
8781
+ *
8782
+ * @default false
8784
8783
  */
8785
8784
  preventSplitterResize?: boolean;
8786
8785
  /**
8787
- * @defaultValue false
8788
- *
8789
8786
  * Whether the popout button will only act on the entire stack,
8790
8787
  * as opposed to only the active tab.
8788
+ *
8789
+ * @default false
8791
8790
  */
8792
8791
  popoutWholeStack?: boolean;
8793
8792
  /**
8794
- * @defaultValue false
8795
- *
8796
8793
  * Limits the area to which tabs can be dragged.
8797
8794
  * If true, the layout container is the only area where tabs can be dropped.
8795
+ *
8796
+ * @default false
8798
8797
  */
8799
8798
  constrainDragToContainer?: boolean;
8800
8799
  /**
8801
- * @defaultValue false
8802
- *
8803
8800
  * Whether to show the popout button on stack header.
8804
8801
  * The button will create a new window with current tab as its content.
8805
8802
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8803
+ *
8804
+ * @default false
8806
8805
  */
8807
8806
  showPopoutIcon?: boolean;
8808
8807
  /**
8809
- * @defaultValue false
8810
- *
8811
8808
  * Whether to show the maximize button on stack header.
8812
8809
  * The button will maximize the current tab to fill the entire window.
8810
+ *
8811
+ * @default false
8813
8812
  */
8814
8813
  showMaximiseIcon?: boolean;
8815
8814
  /**
8816
- * @defaultValue false
8817
- *
8818
8815
  * Whether to show the close button on stack header
8819
8816
  * (not to be confused with close button on every tab).
8817
+ *
8818
+ * @default false
8820
8819
  */
8821
8820
  showCloseIcon?: boolean;
8822
8821
  /**
8823
- * @defaultValue false
8824
- *
8825
8822
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8823
+ *
8824
+ * @default false
8826
8825
  */
8827
8826
  constrainDragToHeaders?: boolean;
8828
8827
  /**
8829
- * @defaultValue true
8830
- *
8831
8828
  * Turns tab headers on or off.
8832
8829
  * If false, the layout will be displayed with splitters only.
8830
+ *
8831
+ * @default true
8833
8832
  */
8834
8833
  hasHeaders?: boolean;
8835
8834
  /**
8836
- * @defaultValue true
8837
- *
8838
8835
  * If true, the user can re-arrange the layout by
8839
8836
  * dragging items by their tabs to the desired location.
8837
+ *
8838
+ * @default true
8840
8839
  */
8841
8840
  reorderEnabled?: boolean;
8842
8841
  /**
8843
- * @defaultValue false
8844
- *
8845
8842
  * If true, tabs can't be dragged out of the window.
8843
+ *
8844
+ * @default false
8846
8845
  */
8847
8846
  preventDragOut?: boolean;
8848
8847
  /**
8849
- * @defaultValue false
8848
+ * @defaultValue=false
8850
8849
  *
8851
8850
  * If true, tabs can't be dragged into the window.
8851
+ *
8852
+ * @default false
8852
8853
  */
8853
8854
  preventDragIn?: boolean;
8854
8855
  /**
@@ -9369,10 +9370,10 @@ declare type MutableViewOptions = {
9369
9370
  /**
9370
9371
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9371
9372
  *
9372
- * @defaultValue true
9373
- *
9374
9373
  * Show the context menu when right-clicking on the view.
9375
9374
  * Gives access to the devtools for the view.
9375
+ *
9376
+ * @default true
9376
9377
  */
9377
9378
  contextMenu: boolean;
9378
9379
  /**
@@ -9419,24 +9420,25 @@ declare type MutableViewOptions = {
9419
9420
  contentNavigation: ContentNavigation;
9420
9421
  contentRedirect: ContentRedirect;
9421
9422
  /**
9422
- * @defaultValue false
9423
9423
  * @deprecated
9424
9424
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9425
9425
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9426
+ *
9427
+ * @default false
9426
9428
  */
9427
9429
  detachOnClose: boolean;
9428
9430
  /**
9429
- * @defaultValue true
9430
- *
9431
9431
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9432
9432
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9433
9433
  * if the view isn't part of the new layout when running `Layout.replace`.
9434
+ *
9435
+ * @default true
9434
9436
  */
9435
9437
  isClosable: boolean;
9436
9438
  /**
9437
- * @defaultValue false
9438
- *
9439
9439
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9440
+ *
9441
+ * @default false
9440
9442
  */
9441
9443
  preventDragOut: boolean;
9442
9444
  interop?: InteropConfig;
@@ -9448,7 +9450,7 @@ declare type MutableViewOptions = {
9448
9450
  /**
9449
9451
  * {@inheritDoc ViewThrottling}
9450
9452
  *
9451
- * @defaultValue 'enabled'
9453
+ * @default 'enabled'
9452
9454
  */
9453
9455
  throttling: ViewThrottling;
9454
9456
  /**
@@ -9476,25 +9478,25 @@ declare type MutableWindowOptions = {
9476
9478
  */
9477
9479
  alphaMask: RGB;
9478
9480
  /**
9479
- * @defaultValue false
9480
- *
9481
9481
  * Always position the window at the top of the window stack.
9482
+ *
9483
+ * @default false
9482
9484
  */
9483
9485
  alwaysOnTop: boolean;
9484
9486
  /**
9485
- * @defaultValue 0
9486
- *
9487
9487
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9488
9488
  * an aspect ratio will not be enforced.
9489
+ *
9490
+ * @default 0
9489
9491
  */
9490
9492
  aspectRatio: number;
9491
9493
  /**
9492
9494
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9493
9495
  *
9494
- * @defaultValue true
9495
- *
9496
9496
  * Show the context menu when right-clicking on the window.
9497
9497
  * Gives access to the devtools for the window.
9498
+ *
9499
+ * @default true
9498
9500
  */
9499
9501
  contextMenu: boolean;
9500
9502
  /**
@@ -9561,16 +9563,17 @@ declare type MutableWindowOptions = {
9561
9563
  */
9562
9564
  customData: any;
9563
9565
  /**
9564
- * @defaultValue true
9565
9566
  * @deprecated Will be removed in runtime version 45
9566
9567
  *
9567
9568
  * Show the window's frame.
9569
+ *
9570
+ * @default true
9568
9571
  */
9569
9572
  frame: boolean;
9570
9573
  /**
9571
- * @defaultValue false
9572
- *
9573
9574
  * Hides the window instead of closing it when the close button is pressed.
9575
+ *
9576
+ * @default false
9574
9577
  */
9575
9578
  hideOnClose: boolean;
9576
9579
  /**
@@ -9623,60 +9626,60 @@ declare type MutableWindowOptions = {
9623
9626
  */
9624
9627
  icon: string;
9625
9628
  /**
9626
- * @defaultValue true
9627
- *
9628
9629
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9629
9630
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9631
+ *
9632
+ * @default true
9630
9633
  */
9631
9634
  includeInSnapshots: boolean;
9632
9635
  /**
9633
- * @defaultValue -1
9634
- *
9635
9636
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9637
+ *
9638
+ * @default -1
9636
9639
  */
9637
9640
  maxHeight: number;
9638
9641
  /**
9639
- * @defaultValue true
9640
- *
9641
9642
  * Allows the window to be maximized.
9643
+ *
9644
+ * @default true
9642
9645
  */
9643
9646
  maximizable: boolean;
9644
9647
  /**
9645
- * @defaultValue -1
9646
- *
9647
9648
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9649
+ *
9650
+ * @default -1
9648
9651
  */
9649
9652
  maxWidth: number;
9650
9653
  /**
9651
- * @defaultValue 0
9652
- *
9653
9654
  * The minimum height of the window.
9655
+ *
9656
+ * @default 0
9654
9657
  */
9655
9658
  minHeight: number;
9656
9659
  /**
9657
- * @defaultValue true
9658
- *
9659
9660
  * Allows the window to be minimized.
9661
+ *
9662
+ * @default true
9660
9663
  */
9661
9664
  minimizable: boolean;
9662
9665
  /**
9663
- * @defaultValue true
9664
- *
9665
9666
  * The minimum width of the window.
9667
+ *
9668
+ * @default true
9666
9669
  */
9667
9670
  minWidth: number;
9668
9671
  /**
9669
- * @defaultValue 1
9670
- *
9671
9672
  * A flag that specifies how transparent the window will be.
9672
9673
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9673
9674
  * This value is clamped between `0.0` and `1.0`.
9675
+ *
9676
+ * @default 1
9674
9677
  */
9675
9678
  opacity: number;
9676
9679
  /**
9677
- * @defaultValue true
9678
- *
9679
9680
  * A flag to allow the user to resize the window.
9681
+ *
9682
+ * @default true
9680
9683
  */
9681
9684
  resizable: boolean;
9682
9685
  /**
@@ -9684,16 +9687,16 @@ declare type MutableWindowOptions = {
9684
9687
  */
9685
9688
  resizeRegion: ResizeRegion;
9686
9689
  /**
9687
- * @defaultValue false
9688
- *
9689
9690
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9690
9691
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9692
+ *
9693
+ * @default false
9691
9694
  */
9692
9695
  showBackgroundImages: boolean;
9693
9696
  /**
9694
- * @defaultValue true
9695
- *
9696
9697
  * Shows the window's icon in the taskbar.
9698
+ *
9699
+ * @default true
9697
9700
  */
9698
9701
  showTaskbarIcon: boolean;
9699
9702
  /**
@@ -9720,7 +9723,7 @@ declare type MutableWindowOptions = {
9720
9723
  /**
9721
9724
  * {@inheritDoc WindowThrottling}
9722
9725
  *
9723
- * @defaultValue 'enabled'
9726
+ * @default 'enabled'
9724
9727
  *
9725
9728
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9726
9729
  */
@@ -10376,12 +10379,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10376
10379
  */
10377
10380
  declare type PastePermissions = {
10378
10381
  /**
10379
- * @defaultValue 'non-protected-content'
10380
- *
10381
10382
  * Controls the behavior for paste operations for a matched URL.
10382
10383
  *
10383
10384
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10384
10385
  * 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.
10386
+ *
10387
+ * @default 'non-protected-content'
10385
10388
  */
10386
10389
  behavior: 'non-protected-content' | 'all-content';
10387
10390
  };
@@ -11451,11 +11454,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11451
11454
  */
11452
11455
  providerUrl?: string;
11453
11456
  /**
11454
- * @defaultValue true
11455
- *
11456
11457
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11457
11458
  *
11458
11459
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11460
+ *
11461
+ * @default true
11459
11462
  */
11460
11463
  allowLaunchIntoPlatform?: boolean;
11461
11464
  };
@@ -12148,22 +12151,22 @@ declare type PopupOptions = {
12148
12151
  url?: string;
12149
12152
  /**
12150
12153
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
12151
- * @defaultValue 300
12154
+ * @default 300
12152
12155
  */
12153
12156
  height?: number;
12154
12157
  /**
12155
12158
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
12156
- * @defaultValue 300
12159
+ * @default 300
12157
12160
  */
12158
12161
  width?: number;
12159
12162
  /**
12160
12163
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12161
- * @defaultValue 0
12164
+ * @default 0
12162
12165
  */
12163
12166
  x?: number;
12164
12167
  /**
12165
12168
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12166
- * @defaultValue 0
12169
+ * @default 0
12167
12170
  */
12168
12171
  y?: number;
12169
12172
  /**
@@ -12171,7 +12174,7 @@ declare type PopupOptions = {
12171
12174
  * * 'modal' restricts resizing and positioning in the caller.
12172
12175
  * * 'hide' hides the popup window on blur.
12173
12176
  * * 'close' closes the popup window on blur.
12174
- * @defaultValue 'close'
12177
+ * @default 'close'
12175
12178
  */
12176
12179
  blurBehavior?: PopupBlurBehavior;
12177
12180
  /**
@@ -12179,19 +12182,19 @@ declare type PopupOptions = {
12179
12182
  * * 'none' will do nothing.
12180
12183
  * * 'hide' hides the popup window on `dispatchPopupResult`.
12181
12184
  * * 'close' closes the popup window on `dispatchPopupResult`.
12182
- * @defaultValue 'close'
12185
+ * @default 'close'
12183
12186
  */
12184
12187
  resultDispatchBehavior?: PopupResultBehavior;
12185
12188
  /**
12186
12189
  * Hide the popup window instead of closing when `close` is called on it.
12187
12190
  *
12188
12191
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
12189
- * @defaultValue false
12192
+ * @default false
12190
12193
  */
12191
12194
  hideOnClose?: boolean;
12192
12195
  /**
12193
12196
  * Determines if the popup window should or should not be focused when it is shown.
12194
- * @defaultValue true
12197
+ * @default true
12195
12198
  */
12196
12199
  focus?: boolean;
12197
12200
  /**
@@ -12285,9 +12288,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12285
12288
  */
12286
12289
  declare type PreloadScript = {
12287
12290
  /**
12288
- * @defaultValue false
12289
- *
12290
12291
  * Fail to load the window if this preload script fails
12292
+ *
12293
+ * @default false
12291
12294
  */
12292
12295
  mandatory?: boolean;
12293
12296
  /**
@@ -12379,15 +12382,15 @@ declare type PrinterInfo = {
12379
12382
  declare type PrintOptions = {
12380
12383
  content?: 'self';
12381
12384
  /**
12382
- * @defaultValue false
12383
- *
12384
12385
  * Disables prompting the user for print settings.
12386
+ *
12387
+ * @default false
12385
12388
  */
12386
12389
  silent?: boolean;
12387
12390
  /**
12388
- * @defaultValue false
12389
- *
12390
12391
  * Includes the webpage background color and image when printing.
12392
+ *
12393
+ * @default false
12391
12394
  */
12392
12395
  printBackground?: boolean;
12393
12396
  /**
@@ -12395,9 +12398,9 @@ declare type PrintOptions = {
12395
12398
  */
12396
12399
  deviceName?: string;
12397
12400
  /**
12398
- * @defaultValue true
12399
- *
12400
12401
  * Prints in full color (greyscale otherwise).
12402
+ *
12403
+ * @default true
12401
12404
  */
12402
12405
  color?: boolean;
12403
12406
  /**
@@ -12405,9 +12408,9 @@ declare type PrintOptions = {
12405
12408
  */
12406
12409
  margins?: Margins;
12407
12410
  /**
12408
- * @defaultValue true
12409
- *
12410
12411
  * Prints in landscape mode (portrait otherwise).
12412
+ *
12413
+ * @default true
12411
12414
  */
12412
12415
  landscape?: boolean;
12413
12416
  /**
@@ -13783,15 +13786,15 @@ declare type ReplaceViewPayload = {
13783
13786
  */
13784
13787
  declare type ResizeRegion = {
13785
13788
  /**
13786
- * @defaultValue 7
13787
- *
13788
13789
  * The size of the resize region in pixels.
13790
+ *
13791
+ * @default 7
13789
13792
  */
13790
13793
  size?: number;
13791
13794
  /**
13792
- * @defaultValue 9
13793
- *
13794
13795
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13796
+ *
13797
+ * @default 9
13795
13798
  */
13796
13799
  bottomRightCorner?: number;
13797
13800
  /**
@@ -13799,27 +13802,27 @@ declare type ResizeRegion = {
13799
13802
  */
13800
13803
  sides?: {
13801
13804
  /**
13802
- * @defaultValue true
13803
- *
13804
13805
  * Enables resizing from the top of the window.
13806
+ *
13807
+ * @default true
13805
13808
  */
13806
13809
  top?: boolean;
13807
13810
  /**
13808
- * @defaultValue true
13809
- *
13810
13811
  * Enables resizing from the bottom of the window.
13812
+ *
13813
+ * @default true
13811
13814
  */
13812
13815
  bottom?: boolean;
13813
13816
  /**
13814
- * @defaultValue true
13815
- *
13816
13817
  * Enables resizing from the left side of the window.
13818
+ *
13819
+ * @default true
13817
13820
  */
13818
13821
  left?: boolean;
13819
13822
  /**
13820
- * @defaultValue true
13821
- *
13822
13823
  * Enables resizing from the right side of the window.
13824
+ *
13825
+ * @default true
13823
13826
  */
13824
13827
  right?: boolean;
13825
13828
  };
@@ -14373,9 +14376,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
14373
14376
  */
14374
14377
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
14375
14378
  /**
14376
- * @defaultValue 0
14377
- *
14378
14379
  * Number of milliseconds to wait between view repaints.
14380
+ *
14381
+ * @default 0
14379
14382
  */
14380
14383
  paintIntervalMs?: number;
14381
14384
  };
@@ -16440,9 +16443,9 @@ declare type TransitionBase = {
16440
16443
  */
16441
16444
  duration: number;
16442
16445
  /**
16443
- * @defaultValue false
16444
- *
16445
16446
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16447
+ *
16448
+ * @default false
16446
16449
  */
16447
16450
  relative?: boolean;
16448
16451
  };
@@ -16458,9 +16461,9 @@ declare type TransitionOptions = {
16458
16461
  */
16459
16462
  interrupt: boolean;
16460
16463
  /**
16461
- * @defaultValue false
16462
- *
16463
16464
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16465
+ *
16466
+ * @default false
16464
16467
  */
16465
16468
  relative?: boolean;
16466
16469
  tween?: tween;
@@ -17425,9 +17428,9 @@ declare type ViewTitlePriority = 'document' | 'options';
17425
17428
  */
17426
17429
  declare type ViewVisibilityOption = {
17427
17430
  /**
17428
- * @defaultValue false
17429
- *
17430
17431
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17432
+ *
17433
+ * @default false
17431
17434
  */
17432
17435
  enabled?: boolean;
17433
17436
  };