@openfin/fdc3-api 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/fdc3-api.d.ts CHANGED
@@ -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
  /**
@@ -1177,19 +1177,19 @@ declare class ApplicationModule extends Base {
1177
1177
  */
1178
1178
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1179
1179
  /**
1180
- * @defaultValue false
1181
- *
1182
1180
  * Disables IAB secure logging for the app.
1181
+ *
1182
+ * @default false
1183
1183
  */
1184
1184
  disableIabSecureLogging: boolean;
1185
1185
  /**
1186
- * @defaultValue 'There was an error loading the application.'
1187
- *
1188
1186
  * An error message to display when the application (launched via manifest) fails to load.
1189
1187
  * A dialog box will be launched with the error message just before the runtime exits.
1190
1188
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1191
1189
  * will trigger this dialog.
1192
1190
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1191
+ *
1192
+ * @default 'There was an error loading the application.'
1193
1193
  */
1194
1194
  loadErrorMessage: string;
1195
1195
  /**
@@ -1208,28 +1208,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1208
1208
  */
1209
1209
  name: string;
1210
1210
  /**
1211
- * @defaultValue false
1212
- *
1213
1211
  * A flag to configure the application as non-persistent.
1214
1212
  * Runtime exits when there are no persistent apps running.
1213
+ *
1214
+ * @default false
1215
1215
  */
1216
1216
  nonPersistent: boolean;
1217
1217
  /**
1218
- * @defaultValue false
1219
- *
1220
1218
  * Enable Flash at the application level.
1219
+ *
1220
+ * @default false
1221
1221
  */
1222
1222
  plugins: boolean;
1223
1223
  /**
1224
- * @defaultValue false
1225
- *
1226
1224
  * Enable spell check at the application level.
1225
+ *
1226
+ * @default false
1227
1227
  */
1228
1228
  spellCheck: boolean;
1229
1229
  /**
1230
- * @defaultValue 'about:blank'
1231
- *
1232
1230
  * The url to the application (specifically the application's main window).
1231
+ *
1232
+ * @default 'about:blank'
1233
1233
  */
1234
1234
  url: string;
1235
1235
  /**
@@ -1238,9 +1238,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1238
1238
  */
1239
1239
  uuid: string;
1240
1240
  /**
1241
- * @defaultValue true
1242
- *
1243
1241
  * When set to `false` it will disable the same-origin policy for the app.
1242
+ *
1243
+ * @default true
1244
1244
  */
1245
1245
  webSecurity: boolean;
1246
1246
  /**
@@ -1250,10 +1250,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1250
1250
  commands: ShortcutOverride[];
1251
1251
  isPlatformController: boolean;
1252
1252
  /**
1253
- * @defaultValue 1000
1254
- *
1255
1253
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1256
1254
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1255
+ *
1256
+ * @default 1000
1257
1257
  */
1258
1258
  maxViewPoolSize: number;
1259
1259
  /**
@@ -1269,12 +1269,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1269
1269
  */
1270
1270
  snapshot: Snapshot;
1271
1271
  /**
1272
- * @defaultValue false
1273
- *
1274
1272
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1275
1273
  *
1276
1274
  * Note: if the Platform Provider is showing, it won't close automatically.
1277
1275
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1276
+ *
1277
+ * @default false
1278
1278
  */
1279
1279
  preventQuitOnLastWindowClosed: boolean;
1280
1280
  /**
@@ -1282,9 +1282,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1282
1282
  */
1283
1283
  interopBrokerConfiguration: InteropBrokerOptions;
1284
1284
  /**
1285
- * @defaultValue true
1286
- *
1287
1285
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1286
+ *
1287
+ * @default true
1288
1288
  */
1289
1289
  apiDiagnostics: boolean;
1290
1290
  /**
@@ -1300,16 +1300,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1300
1300
  */
1301
1301
  permissions?: Partial<Permissions_2>;
1302
1302
  /**
1303
- * @defaultValue false
1304
- *
1305
1303
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1306
1304
  * Only relevant in Windows.
1305
+ *
1306
+ * @default false
1307
1307
  */
1308
1308
  enableJumpList: boolean;
1309
1309
  /**
1310
- * @defaultValue false
1311
- *
1312
1310
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1311
+ *
1312
+ * @default false
1313
1313
  */
1314
1314
  enableBeforeUnload: boolean;
1315
1315
  /**
@@ -1390,25 +1390,25 @@ declare type ApplicationWindowInfo = {
1390
1390
  */
1391
1391
  declare type ApplySnapshotOptions = {
1392
1392
  /**
1393
- * @defaultValue false
1394
- *
1395
1393
  * When true, applySnapshot will close existing windows,
1396
1394
  * replacing current Platform state with the given snapshot.
1395
+ *
1396
+ * @default false
1397
1397
  */
1398
1398
  closeExistingWindows?: boolean;
1399
1399
  /**
1400
- * @defaultValue false
1401
- *
1402
1400
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1403
1401
  * replacing current Platform state with the given snapshot.
1402
+ *
1403
+ * @default false
1404
1404
  */
1405
1405
  closeSnapshotWindows?: boolean;
1406
1406
  /**
1407
- * @defaultValue false
1408
- *
1409
1407
  * When true, applySnapshot will not check whether any windows in a
1410
1408
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1411
1409
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1410
+ *
1411
+ * @default false
1412
1412
  */
1413
1413
  skipOutOfBoundsCheck?: boolean;
1414
1414
  };
@@ -2091,15 +2091,15 @@ declare type CapturePageOptions = {
2091
2091
  */
2092
2092
  area?: Rectangle;
2093
2093
  /**
2094
- * @defaultValue 'png'
2095
- *
2096
2094
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2095
+ *
2096
+ * @default 'png'
2097
2097
  */
2098
2098
  format?: 'bmp' | 'jpg' | 'png';
2099
2099
  /**
2100
- * @defaultValue 100
2101
- *
2102
2100
  * Quality of JPEG image. Between 0 - 100.
2101
+ *
2102
+ * @default 100
2103
2103
  */
2104
2104
  quality?: number;
2105
2105
  };
@@ -2753,9 +2753,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2753
2753
  */
2754
2754
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2755
2755
  /**
2756
- * @defaultValue true
2757
- *
2758
2756
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2757
+ *
2758
+ * @default true
2759
2759
  */
2760
2760
  wait?: boolean;
2761
2761
  /**
@@ -3417,9 +3417,9 @@ declare interface CloseWindowPayload {
3417
3417
  windowId: Identity_4;
3418
3418
  options: {
3419
3419
  /**
3420
- * @defaultValue false
3421
- *
3422
3420
  * When set to true skips any before handler set on views that are part of the window
3421
+ *
3422
+ * @default false
3423
3423
  */
3424
3424
  skipBeforeUnload?: boolean;
3425
3425
  };
@@ -3527,9 +3527,9 @@ declare type ConstViewOptions = {
3527
3527
  */
3528
3528
  name: string;
3529
3529
  /**
3530
- * @defaultValue "about:blank"
3531
- *
3532
3530
  * The URL of the window
3531
+ *
3532
+ * @default "about:blank"
3533
3533
  */
3534
3534
  url: string;
3535
3535
  /**
@@ -3587,9 +3587,9 @@ declare type ConstViewOptions = {
3587
3587
  experimental: any;
3588
3588
  fdc3InteropApi?: string;
3589
3589
  /**
3590
- * @defaultValue false
3591
- *
3592
3590
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3591
+ *
3592
+ * @default false
3593
3593
  */
3594
3594
  enableBeforeUnload: boolean;
3595
3595
  /**
@@ -3670,13 +3670,12 @@ declare type ConstWindowOptions = {
3670
3670
  */
3671
3671
  backgroundColor: string;
3672
3672
  /**
3673
- * @defaultValue false
3674
- *
3675
3673
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3676
3674
  * This also affects the Page Visibility API.
3677
3675
  *
3678
3676
  * When `true`, the page is throttled whether it is hidden or not.
3679
3677
  *
3678
+ * @default false
3680
3679
  */
3681
3680
  backgroundThrottling: boolean;
3682
3681
  /**
@@ -3700,21 +3699,21 @@ declare type ConstWindowOptions = {
3700
3699
  */
3701
3700
  customRequestHeaders: CustomRequestHeaders[];
3702
3701
  /**
3703
- * @defaultValue true
3704
- *
3705
3702
  * Setting this to false would keep the Window alive even if all its Views were closed.
3706
3703
  * This is meant for advanced users and should be used with caution.
3707
3704
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3708
3705
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3709
3706
  * **NOTE:** - This option is ignored in non-Platforms apps.
3707
+ *
3708
+ * @default true
3710
3709
  */
3711
3710
  closeOnLastViewRemoved: boolean;
3712
3711
  /**
3713
- * @defaultValue 'all'
3714
- *
3715
3712
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3716
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3713
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3717
3714
  * **NOTE:** - This option is ignored in non-Platforms apps.
3715
+ *
3716
+ * @default 'all'
3718
3717
  */
3719
3718
  viewsPreventingClose: 'all' | 'layout';
3720
3719
  /**
@@ -3725,31 +3724,31 @@ declare type ConstWindowOptions = {
3725
3724
  */
3726
3725
  defaultCentered: boolean;
3727
3726
  /**
3728
- * @defaultValue 500
3729
- *
3730
3727
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3731
3728
  * in favor of the cached value.
3729
+ *
3730
+ * @default 500
3732
3731
  */
3733
3732
  defaultHeight: number;
3734
3733
  /**
3735
- * @defaultValue 100
3736
- *
3737
3734
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3738
3735
  * launches in favor of the cached value.
3736
+ *
3737
+ * @default 100
3739
3738
  */
3740
3739
  defaultLeft: number;
3741
3740
  /**
3742
- * @defaultValue 100
3743
- *
3744
3741
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3745
3742
  * launches in favor of the cached value.
3743
+ *
3744
+ * @default 100
3746
3745
  */
3747
3746
  defaultTop: number;
3748
3747
  /**
3749
- * @defaultValue 800
3750
- *
3751
3748
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3752
3749
  * launches in favor of the cached value.
3750
+ *
3751
+ * @default 800
3753
3752
  */
3754
3753
  defaultWidth: number;
3755
3754
  /**
@@ -3795,19 +3794,19 @@ declare type ConstWindowOptions = {
3795
3794
  */
3796
3795
  processAffinity: string;
3797
3796
  /**
3798
- * @defaultValue false
3799
- *
3800
3797
  * Displays a shadow on frameless windows.
3801
3798
  * `shadow` and `cornerRounding` are mutually exclusive.
3802
3799
  * On Windows 7, Aero theme is required.
3800
+ *
3801
+ * @default false
3803
3802
  */
3804
3803
  shadow: boolean;
3805
3804
  /**
3806
- * @defaultValue true
3807
- *
3808
3805
  * Caches the location of the window.
3809
3806
  *
3810
3807
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3808
+ *
3809
+ * @default true
3811
3810
  */
3812
3811
  saveWindowState: boolean;
3813
3812
  /**
@@ -3816,22 +3815,22 @@ declare type ConstWindowOptions = {
3816
3815
  */
3817
3816
  ignoreSavedWindowState: boolean;
3818
3817
  /**
3819
- * @defaultValue false
3820
- *
3821
3818
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3822
3819
  *
3823
3820
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3824
3821
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3822
+ *
3823
+ * @default false
3825
3824
  */
3826
3825
  smallWindow: boolean;
3827
3826
  /**
3828
- * @defaultValue "normal"
3829
- *
3830
3827
  * The visible state of the window on creation.
3831
3828
  * One of:
3832
3829
  * * `"maximized"`
3833
3830
  * * `"minimized"`
3834
3831
  * * `"normal"`
3832
+ *
3833
+ * @default "normal"
3835
3834
  */
3836
3835
  state: WindowState;
3837
3836
  /**
@@ -3845,20 +3844,20 @@ declare type ConstWindowOptions = {
3845
3844
  */
3846
3845
  url: string;
3847
3846
  /**
3848
- * @defaultValue <application UUID>
3849
- *
3850
3847
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3851
3848
  * If omitted, defaults to the `uuid` of the application spawning the window.
3852
3849
  * If given, must match the `uuid` of the application spawning the window.
3853
3850
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3854
3851
  * really no need to provide it.
3852
+ *
3853
+ * @default <application UUID>
3855
3854
  */
3856
3855
  uuid: string;
3857
3856
  /**
3858
- * @defaultValue false
3859
- *
3860
3857
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3861
3858
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3859
+ *
3860
+ * @default false
3862
3861
  */
3863
3862
  waitForPageLoad: boolean;
3864
3863
  width: number;
@@ -4130,13 +4129,13 @@ declare type CopyBlockedEventReason = 'disabled';
4130
4129
  */
4131
4130
  declare type CopyPermissions = {
4132
4131
  /**
4133
- * @defaultValue 'allowed'
4134
- *
4135
4132
  * Controls the behavior for copy operations for a matched URL.
4136
4133
  *
4137
4134
  * allow: Enables all copy operations.
4138
4135
  * block: Disables all copy operations.
4139
4136
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4137
+ *
4138
+ * @default 'allowed'
4140
4139
  */
4141
4140
  behavior: 'allow' | 'block' | 'protect';
4142
4141
  /**
@@ -4144,9 +4143,9 @@ declare type CopyPermissions = {
4144
4143
  */
4145
4144
  options?: {
4146
4145
  /**
4147
- * @defaultValue ''
4148
- *
4149
4146
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4147
+ *
4148
+ * @default ''
4150
4149
  */
4151
4150
  replacementText: string;
4152
4151
  };
@@ -4160,15 +4159,15 @@ declare type CopyPermissions = {
4160
4159
  */
4161
4160
  declare type CornerRounding = {
4162
4161
  /**
4163
- * @defaultValue 0
4164
- *
4165
4162
  * The height in pixels.
4163
+ *
4164
+ * @default 0
4166
4165
  */
4167
4166
  height: number;
4168
4167
  /**
4169
- * @defaultValue 0
4170
- *
4171
4168
  * The width in pixels.
4169
+ *
4170
+ * @default 0
4172
4171
  */
4173
4172
  width: number;
4174
4173
  };
@@ -4258,8 +4257,6 @@ declare type CreateLayoutOptions = {
4258
4257
  layoutName: string;
4259
4258
  layout: LayoutOptions;
4260
4259
  /**
4261
- * @defaultValue 'default'
4262
- *
4263
4260
  * Controls the View behavior for the given `layout` property. Note
4264
4261
  * that the selected behavior only applies to unnamed Views or
4265
4262
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4281,6 +4278,8 @@ declare type CreateLayoutOptions = {
4281
4278
  * override. Note that during applyLayoutSnapshot, Views are created and
4282
4279
  * attached to the Provider while the Window is being created, so it's
4283
4280
  * important to not 'duplicate' Views in this workflow.
4281
+ *
4282
+ * @default 'default'
4284
4283
  */
4285
4284
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4286
4285
  };
@@ -4540,7 +4539,7 @@ declare type DomainApiSettings = {
4540
4539
  * * 'none': The `fin` API will be not available.
4541
4540
  * * 'global': The entire `fin` API will be available.
4542
4541
  *
4543
- * @defaultValue 'global'
4542
+ * @default 'global'
4544
4543
  */
4545
4544
  fin?: InjectionType;
4546
4545
  /**
@@ -5132,9 +5131,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5132
5131
  */
5133
5132
  declare type ExcludeOptions = {
5134
5133
  /**
5135
- * @defaultValue false
5136
- *
5137
5134
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5135
+ *
5136
+ * @default false
5138
5137
  */
5139
5138
  preloadScripts: boolean;
5140
5139
  };
@@ -5965,34 +5964,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
5965
5964
  */
5966
5965
  declare type FindInPageOptions = {
5967
5966
  /**
5968
- * @defaultValue true
5969
- *
5970
5967
  * Searches in the forward direction (backward otherwise)
5968
+ *
5969
+ * @default true
5971
5970
  */
5972
5971
  forward?: boolean;
5973
5972
  /**
5974
- * @defaultValue false
5975
- *
5976
5973
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5974
+ *
5975
+ * @default false
5977
5976
  */
5978
5977
  findNext?: boolean;
5979
5978
  /**
5980
- * @defaultValue false
5981
- *
5982
5979
  * Enables case-sensitive searching.
5980
+ *
5981
+ * @default false
5983
5982
  */
5984
5983
  matchCase?: boolean;
5985
5984
  /**
5986
- * @defaultValue false
5987
- *
5988
5985
  * Only searches from the start of words.
5986
+ *
5987
+ * @default false
5989
5988
  */
5990
5989
  wordStart?: boolean;
5991
5990
  /**
5992
- * @defaultValue false
5993
- *
5994
5991
  * 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>
5995
5992
  * lowercase or non-letter. Accepts several other intra-word matches.
5993
+ *
5994
+ * @default false
5996
5995
  */
5997
5996
  medialCapitalAsWordStart?: boolean;
5998
5997
  };
@@ -6506,9 +6505,9 @@ declare type Hotkey = {
6506
6505
  */
6507
6506
  keys: string;
6508
6507
  /**
6509
- * @defaultValue false
6510
- *
6511
6508
  * Prevent default key handling before emitting the event.
6509
+ *
6510
+ * @default false
6512
6511
  */
6513
6512
  preventDefault?: boolean;
6514
6513
  };
@@ -9049,77 +9048,79 @@ declare type LayoutOptions = {
9049
9048
  */
9050
9049
  settings?: {
9051
9050
  /**
9052
- * @defaultValue false
9053
- *
9054
9051
  * When true the splitters will not be draggable and the layout will not resize.
9052
+ *
9053
+ * @default false
9055
9054
  */
9056
9055
  preventSplitterResize?: boolean;
9057
9056
  /**
9058
- * @defaultValue false
9059
- *
9060
9057
  * Whether the popout button will only act on the entire stack,
9061
9058
  * as opposed to only the active tab.
9059
+ *
9060
+ * @default false
9062
9061
  */
9063
9062
  popoutWholeStack?: boolean;
9064
9063
  /**
9065
- * @defaultValue false
9066
- *
9067
9064
  * Limits the area to which tabs can be dragged.
9068
9065
  * If true, the layout container is the only area where tabs can be dropped.
9066
+ *
9067
+ * @default false
9069
9068
  */
9070
9069
  constrainDragToContainer?: boolean;
9071
9070
  /**
9072
- * @defaultValue false
9073
- *
9074
9071
  * Whether to show the popout button on stack header.
9075
9072
  * The button will create a new window with current tab as its content.
9076
9073
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
9074
+ *
9075
+ * @default false
9077
9076
  */
9078
9077
  showPopoutIcon?: boolean;
9079
9078
  /**
9080
- * @defaultValue false
9081
- *
9082
9079
  * Whether to show the maximize button on stack header.
9083
9080
  * The button will maximize the current tab to fill the entire window.
9081
+ *
9082
+ * @default false
9084
9083
  */
9085
9084
  showMaximiseIcon?: boolean;
9086
9085
  /**
9087
- * @defaultValue false
9088
- *
9089
9086
  * Whether to show the close button on stack header
9090
9087
  * (not to be confused with close button on every tab).
9088
+ *
9089
+ * @default false
9091
9090
  */
9092
9091
  showCloseIcon?: boolean;
9093
9092
  /**
9094
- * @defaultValue false
9095
- *
9096
9093
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
9094
+ *
9095
+ * @default false
9097
9096
  */
9098
9097
  constrainDragToHeaders?: boolean;
9099
9098
  /**
9100
- * @defaultValue true
9101
- *
9102
9099
  * Turns tab headers on or off.
9103
9100
  * If false, the layout will be displayed with splitters only.
9101
+ *
9102
+ * @default true
9104
9103
  */
9105
9104
  hasHeaders?: boolean;
9106
9105
  /**
9107
- * @defaultValue true
9108
- *
9109
9106
  * If true, the user can re-arrange the layout by
9110
9107
  * dragging items by their tabs to the desired location.
9108
+ *
9109
+ * @default true
9111
9110
  */
9112
9111
  reorderEnabled?: boolean;
9113
9112
  /**
9114
- * @defaultValue false
9115
- *
9116
9113
  * If true, tabs can't be dragged out of the window.
9114
+ *
9115
+ * @default false
9117
9116
  */
9118
9117
  preventDragOut?: boolean;
9119
9118
  /**
9120
9119
  * @defaultValue=false
9121
9120
  *
9122
9121
  * If true, tabs can't be dragged into the window.
9122
+ *
9123
+ * @default false
9123
9124
  */
9124
9125
  preventDragIn?: boolean;
9125
9126
  };
@@ -9562,10 +9563,10 @@ declare type MutableViewOptions = {
9562
9563
  /**
9563
9564
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9564
9565
  *
9565
- * @defaultValue true
9566
- *
9567
9566
  * Show the context menu when right-clicking on the view.
9568
9567
  * Gives access to the devtools for the view.
9568
+ *
9569
+ * @default true
9569
9570
  */
9570
9571
  contextMenu: boolean;
9571
9572
  /**
@@ -9612,24 +9613,25 @@ declare type MutableViewOptions = {
9612
9613
  contentNavigation: ContentNavigation;
9613
9614
  contentRedirect: ContentRedirect;
9614
9615
  /**
9615
- * @defaultValue false
9616
9616
  * @deprecated
9617
9617
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9618
9618
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9619
+ *
9620
+ * @default false
9619
9621
  */
9620
9622
  detachOnClose: boolean;
9621
9623
  /**
9622
- * @defaultValue true
9623
- *
9624
9624
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9625
9625
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9626
9626
  * if the view isn't part of the new layout when running `Layout.replace`.
9627
+ *
9628
+ * @default true
9627
9629
  */
9628
9630
  isClosable: boolean;
9629
9631
  /**
9630
- * @defaultValue false
9631
- *
9632
9632
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9633
+ *
9634
+ * @default false
9633
9635
  */
9634
9636
  preventDragOut: boolean;
9635
9637
  interop?: InteropConfig;
@@ -9641,7 +9643,7 @@ declare type MutableViewOptions = {
9641
9643
  /**
9642
9644
  * {@inheritDoc ViewThrottling}
9643
9645
  *
9644
- * @defaultValue 'enabled'
9646
+ * @default 'enabled'
9645
9647
  */
9646
9648
  throttling: ViewThrottling;
9647
9649
  /**
@@ -9660,7 +9662,7 @@ declare type MutableWindowOptions = {
9660
9662
  * Turns anything of matching RGB value transparent.
9661
9663
  *
9662
9664
  * Caveats:
9663
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9665
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9664
9666
  * * User cannot click-through transparent regions
9665
9667
  * * Not supported on Mac
9666
9668
  * * Windows Aero must be enabled
@@ -9669,25 +9671,25 @@ declare type MutableWindowOptions = {
9669
9671
  */
9670
9672
  alphaMask: RGB;
9671
9673
  /**
9672
- * @defaultValue false
9673
- *
9674
9674
  * Always position the window at the top of the window stack.
9675
+ *
9676
+ * @default false
9675
9677
  */
9676
9678
  alwaysOnTop: boolean;
9677
9679
  /**
9678
- * @defaultValue 0
9679
- *
9680
9680
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9681
9681
  * an aspect ratio will not be enforced.
9682
+ *
9683
+ * @default 0
9682
9684
  */
9683
9685
  aspectRatio: number;
9684
9686
  /**
9685
9687
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9686
9688
  *
9687
- * @defaultValue true
9688
- *
9689
9689
  * Show the context menu when right-clicking on the window.
9690
9690
  * Gives access to the devtools for the window.
9691
+ *
9692
+ * @default true
9691
9693
  */
9692
9694
  contextMenu: boolean;
9693
9695
  /**
@@ -9757,12 +9759,14 @@ declare type MutableWindowOptions = {
9757
9759
  * @defaultValue true
9758
9760
  *
9759
9761
  * Show the window's frame.
9762
+ *
9763
+ * @default true
9760
9764
  */
9761
9765
  frame: boolean;
9762
9766
  /**
9763
- * @defaultValue false
9764
- *
9765
9767
  * Hides the window instead of closing it when the close button is pressed.
9768
+ *
9769
+ * @default false
9766
9770
  */
9767
9771
  hideOnClose: boolean;
9768
9772
  /**
@@ -9815,60 +9819,61 @@ declare type MutableWindowOptions = {
9815
9819
  */
9816
9820
  icon: string;
9817
9821
  /**
9818
- * @defaultValue true
9819
- *
9820
9822
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9821
9823
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9824
+ *
9825
+ * @default true
9822
9826
  */
9823
9827
  includeInSnapshots: boolean;
9824
9828
  /**
9825
- * @defaultValue -1
9826
- *
9827
9829
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9830
+ *
9831
+ * @default -1
9828
9832
  */
9829
9833
  maxHeight: number;
9830
9834
  /**
9831
- * @defaultValue true
9832
- *
9833
9835
  * Allows the window to be maximized.
9836
+ *
9837
+ * @default true
9834
9838
  */
9835
9839
  maximizable: boolean;
9836
9840
  /**
9837
- * @defaultValue -1
9838
- *
9839
9841
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9842
+ *
9843
+ * @default -1
9840
9844
  */
9841
9845
  maxWidth: number;
9842
9846
  /**
9843
- * @defaultValue 0
9844
- *
9845
9847
  * The minimum height of the window.
9848
+ *
9849
+ * @default 0
9846
9850
  */
9847
9851
  minHeight: number;
9848
9852
  /**
9849
- * @defaultValue true
9850
- *
9851
9853
  * Allows the window to be minimized.
9854
+ *
9855
+ * @default true
9852
9856
  */
9853
9857
  minimizable: boolean;
9854
9858
  /**
9855
- * @defaultValue true
9856
- *
9857
9859
  * The minimum width of the window.
9860
+ *
9861
+ * @default true
9858
9862
  */
9859
9863
  minWidth: number;
9860
9864
  /**
9861
- * @defaultValue 1
9862
- *
9863
9865
  * A flag that specifies how transparent the window will be.
9864
9866
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9865
9867
  * This value is clamped between `0.0` and `1.0`.
9868
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9869
+ *
9870
+ * @default 1
9866
9871
  */
9867
9872
  opacity: number;
9868
9873
  /**
9869
- * @defaultValue true
9870
- *
9871
9874
  * A flag to allow the user to resize the window.
9875
+ *
9876
+ * @default true
9872
9877
  */
9873
9878
  resizable: boolean;
9874
9879
  /**
@@ -9876,16 +9881,16 @@ declare type MutableWindowOptions = {
9876
9881
  */
9877
9882
  resizeRegion: ResizeRegion;
9878
9883
  /**
9879
- * @defaultValue false
9880
- *
9881
9884
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9882
9885
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9886
+ *
9887
+ * @default false
9883
9888
  */
9884
9889
  showBackgroundImages: boolean;
9885
9890
  /**
9886
- * @defaultValue true
9887
- *
9888
9891
  * Shows the window's icon in the taskbar.
9892
+ *
9893
+ * @default true
9889
9894
  */
9890
9895
  showTaskbarIcon: boolean;
9891
9896
  /**
@@ -9908,7 +9913,7 @@ declare type MutableWindowOptions = {
9908
9913
  /**
9909
9914
  * {@inheritDoc WindowThrottling}
9910
9915
  *
9911
- * @defaultValue 'enabled'
9916
+ * @default 'enabled'
9912
9917
  *
9913
9918
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9914
9919
  */
@@ -10525,12 +10530,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10525
10530
  */
10526
10531
  declare type PastePermissions = {
10527
10532
  /**
10528
- * @defaultValue 'non-protected-content'
10529
- *
10530
10533
  * Controls the behavior for paste operations for a matched URL.
10531
10534
  *
10532
10535
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10533
10536
  * 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.
10537
+ *
10538
+ * @default 'non-protected-content'
10534
10539
  */
10535
10540
  behavior: 'non-protected-content' | 'all-content';
10536
10541
  };
@@ -11595,11 +11600,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11595
11600
  */
11596
11601
  providerUrl?: string;
11597
11602
  /**
11598
- * @defaultValue true
11599
- *
11600
11603
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11601
11604
  *
11602
11605
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11606
+ *
11607
+ * @default true
11603
11608
  */
11604
11609
  allowLaunchIntoPlatform?: boolean;
11605
11610
  };
@@ -12288,22 +12293,22 @@ declare type PopupOptions = {
12288
12293
  url?: string;
12289
12294
  /**
12290
12295
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
12291
- * @defaultValue 300
12296
+ * @default 300
12292
12297
  */
12293
12298
  height?: number;
12294
12299
  /**
12295
12300
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
12296
- * @defaultValue 300
12301
+ * @default 300
12297
12302
  */
12298
12303
  width?: number;
12299
12304
  /**
12300
12305
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12301
- * @defaultValue 0
12306
+ * @default 0
12302
12307
  */
12303
12308
  x?: number;
12304
12309
  /**
12305
12310
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12306
- * @defaultValue 0
12311
+ * @default 0
12307
12312
  */
12308
12313
  y?: number;
12309
12314
  /**
@@ -12311,7 +12316,7 @@ declare type PopupOptions = {
12311
12316
  * * 'modal' restricts resizing and positioning in the caller.
12312
12317
  * * 'hide' hides the popup window on blur.
12313
12318
  * * 'close' closes the popup window on blur.
12314
- * @defaultValue 'close'
12319
+ * @default 'close'
12315
12320
  */
12316
12321
  blurBehavior?: PopupBlurBehavior;
12317
12322
  /**
@@ -12319,19 +12324,19 @@ declare type PopupOptions = {
12319
12324
  * * 'none' will do nothing.
12320
12325
  * * 'hide' hides the popup window on `dispatchPopupResult`.
12321
12326
  * * 'close' closes the popup window on `dispatchPopupResult`.
12322
- * @defaultValue 'close'
12327
+ * @default 'close'
12323
12328
  */
12324
12329
  resultDispatchBehavior?: PopupResultBehavior;
12325
12330
  /**
12326
12331
  * Hide the popup window instead of closing when `close` is called on it.
12327
12332
  *
12328
12333
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
12329
- * @defaultValue false
12334
+ * @default false
12330
12335
  */
12331
12336
  hideOnClose?: boolean;
12332
12337
  /**
12333
12338
  * Determines if the popup window should or should not be focused when it is shown.
12334
- * @defaultValue true
12339
+ * @default true
12335
12340
  */
12336
12341
  focus?: boolean;
12337
12342
  /**
@@ -12425,9 +12430,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12425
12430
  */
12426
12431
  declare type PreloadScript = {
12427
12432
  /**
12428
- * @defaultValue false
12429
- *
12430
12433
  * Fail to load the window if this preload script fails
12434
+ *
12435
+ * @default false
12431
12436
  */
12432
12437
  mandatory?: boolean;
12433
12438
  /**
@@ -12523,15 +12528,15 @@ declare type PrinterInfo = {
12523
12528
  declare type PrintOptions = {
12524
12529
  content?: 'self';
12525
12530
  /**
12526
- * @defaultValue false
12527
- *
12528
12531
  * Disables prompting the user for print settings.
12532
+ *
12533
+ * @default false
12529
12534
  */
12530
12535
  silent?: boolean;
12531
12536
  /**
12532
- * @defaultValue false
12533
- *
12534
12537
  * Includes the webpage background color and image when printing.
12538
+ *
12539
+ * @default false
12535
12540
  */
12536
12541
  printBackground?: boolean;
12537
12542
  /**
@@ -12539,9 +12544,9 @@ declare type PrintOptions = {
12539
12544
  */
12540
12545
  deviceName?: string;
12541
12546
  /**
12542
- * @defaultValue true
12543
- *
12544
12547
  * Prints in full color (greyscale otherwise).
12548
+ *
12549
+ * @default true
12545
12550
  */
12546
12551
  color?: boolean;
12547
12552
  /**
@@ -12549,9 +12554,9 @@ declare type PrintOptions = {
12549
12554
  */
12550
12555
  margins?: Margins;
12551
12556
  /**
12552
- * @defaultValue true
12553
- *
12554
12557
  * Prints in landscape mode (portrait otherwise).
12558
+ *
12559
+ * @default true
12555
12560
  */
12556
12561
  landscape?: boolean;
12557
12562
  /**
@@ -13722,15 +13727,15 @@ declare type ReplaceViewPayload = {
13722
13727
  */
13723
13728
  declare type ResizeRegion = {
13724
13729
  /**
13725
- * @defaultValue 7
13726
- *
13727
13730
  * The size of the resize region in pixels.
13731
+ *
13732
+ * @default 7
13728
13733
  */
13729
13734
  size?: number;
13730
13735
  /**
13731
- * @defaultValue 9
13732
- *
13733
13736
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13737
+ *
13738
+ * @default 9
13734
13739
  */
13735
13740
  bottomRightCorner?: number;
13736
13741
  /**
@@ -13738,27 +13743,27 @@ declare type ResizeRegion = {
13738
13743
  */
13739
13744
  sides?: {
13740
13745
  /**
13741
- * @defaultValue true
13742
- *
13743
13746
  * Enables resizing from the top of the window.
13747
+ *
13748
+ * @default true
13744
13749
  */
13745
13750
  top?: boolean;
13746
13751
  /**
13747
- * @defaultValue true
13748
- *
13749
13752
  * Enables resizing from the bottom of the window.
13753
+ *
13754
+ * @default true
13750
13755
  */
13751
13756
  bottom?: boolean;
13752
13757
  /**
13753
- * @defaultValue true
13754
- *
13755
13758
  * Enables resizing from the left side of the window.
13759
+ *
13760
+ * @default true
13756
13761
  */
13757
13762
  left?: boolean;
13758
13763
  /**
13759
- * @defaultValue true
13760
- *
13761
13764
  * Enables resizing from the right side of the window.
13765
+ *
13766
+ * @default true
13762
13767
  */
13763
13768
  right?: boolean;
13764
13769
  };
@@ -14302,9 +14307,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
14302
14307
  */
14303
14308
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
14304
14309
  /**
14305
- * @defaultValue 0
14306
- *
14307
14310
  * Number of milliseconds to wait between view repaints.
14311
+ *
14312
+ * @default 0
14308
14313
  */
14309
14314
  paintIntervalMs?: number;
14310
14315
  };
@@ -16355,9 +16360,9 @@ declare type TransitionBase = {
16355
16360
  */
16356
16361
  duration: number;
16357
16362
  /**
16358
- * @defaultValue false
16359
- *
16360
16363
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16364
+ *
16365
+ * @default false
16361
16366
  */
16362
16367
  relative?: boolean;
16363
16368
  };
@@ -16373,9 +16378,9 @@ declare type TransitionOptions = {
16373
16378
  */
16374
16379
  interrupt: boolean;
16375
16380
  /**
16376
- * @defaultValue false
16377
- *
16378
16381
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16382
+ *
16383
+ * @default false
16379
16384
  */
16380
16385
  relative?: boolean;
16381
16386
  tween?: tween;
@@ -17440,9 +17445,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
17440
17445
  */
17441
17446
  declare type ViewVisibilityOption = {
17442
17447
  /**
17443
- * @defaultValue false
17444
- *
17445
17448
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17449
+ *
17450
+ * @default false
17446
17451
  */
17447
17452
  enabled?: boolean;
17448
17453
  };