@openfin/fdc3-api 40.105.4 → 40.105.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
  /**
@@ -3052,6 +3052,10 @@ declare type ChromiumPolicies = {
3052
3052
  * Disable AutofillAddressEnabled policy for a Window or View.
3053
3053
  */
3054
3054
  AutofillAddressEnabled?: PolicyOptions;
3055
+ /**
3056
+ * Disable AutofillCreditCardEnabled policy for a Window or View.
3057
+ */
3058
+ AutofillCreditCardEnabled?: PolicyOptions;
3055
3059
  };
3056
3060
 
3057
3061
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
@@ -3417,9 +3421,9 @@ declare interface CloseWindowPayload {
3417
3421
  windowId: Identity_4;
3418
3422
  options: {
3419
3423
  /**
3420
- * @defaultValue false
3421
- *
3422
3424
  * When set to true skips any before handler set on views that are part of the window
3425
+ *
3426
+ * @default false
3423
3427
  */
3424
3428
  skipBeforeUnload?: boolean;
3425
3429
  };
@@ -3527,9 +3531,9 @@ declare type ConstViewOptions = {
3527
3531
  */
3528
3532
  name: string;
3529
3533
  /**
3530
- * @defaultValue "about:blank"
3531
- *
3532
3534
  * The URL of the window
3535
+ *
3536
+ * @default "about:blank"
3533
3537
  */
3534
3538
  url: string;
3535
3539
  /**
@@ -3587,9 +3591,9 @@ declare type ConstViewOptions = {
3587
3591
  experimental: any;
3588
3592
  fdc3InteropApi?: string;
3589
3593
  /**
3590
- * @defaultValue false
3591
- *
3592
3594
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3595
+ *
3596
+ * @default false
3593
3597
  */
3594
3598
  enableBeforeUnload: boolean;
3595
3599
  /**
@@ -3670,13 +3674,12 @@ declare type ConstWindowOptions = {
3670
3674
  */
3671
3675
  backgroundColor: string;
3672
3676
  /**
3673
- * @defaultValue false
3674
- *
3675
3677
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3676
3678
  * This also affects the Page Visibility API.
3677
3679
  *
3678
3680
  * When `true`, the page is throttled whether it is hidden or not.
3679
3681
  *
3682
+ * @default false
3680
3683
  */
3681
3684
  backgroundThrottling: boolean;
3682
3685
  /**
@@ -3700,21 +3703,21 @@ declare type ConstWindowOptions = {
3700
3703
  */
3701
3704
  customRequestHeaders: CustomRequestHeaders[];
3702
3705
  /**
3703
- * @defaultValue true
3704
- *
3705
3706
  * Setting this to false would keep the Window alive even if all its Views were closed.
3706
3707
  * This is meant for advanced users and should be used with caution.
3707
3708
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3708
3709
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3709
3710
  * **NOTE:** - This option is ignored in non-Platforms apps.
3711
+ *
3712
+ * @default true
3710
3713
  */
3711
3714
  closeOnLastViewRemoved: boolean;
3712
3715
  /**
3713
- * @defaultValue 'all'
3714
- *
3715
3716
  * 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'.
3717
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3717
3718
  * **NOTE:** - This option is ignored in non-Platforms apps.
3719
+ *
3720
+ * @default 'all'
3718
3721
  */
3719
3722
  viewsPreventingClose: 'all' | 'layout';
3720
3723
  /**
@@ -3725,31 +3728,31 @@ declare type ConstWindowOptions = {
3725
3728
  */
3726
3729
  defaultCentered: boolean;
3727
3730
  /**
3728
- * @defaultValue 500
3729
- *
3730
3731
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3731
3732
  * in favor of the cached value.
3733
+ *
3734
+ * @default 500
3732
3735
  */
3733
3736
  defaultHeight: number;
3734
3737
  /**
3735
- * @defaultValue 100
3736
- *
3737
3738
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3738
3739
  * launches in favor of the cached value.
3740
+ *
3741
+ * @default 100
3739
3742
  */
3740
3743
  defaultLeft: number;
3741
3744
  /**
3742
- * @defaultValue 100
3743
- *
3744
3745
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3745
3746
  * launches in favor of the cached value.
3747
+ *
3748
+ * @default 100
3746
3749
  */
3747
3750
  defaultTop: number;
3748
3751
  /**
3749
- * @defaultValue 800
3750
- *
3751
3752
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3752
3753
  * launches in favor of the cached value.
3754
+ *
3755
+ * @default 800
3753
3756
  */
3754
3757
  defaultWidth: number;
3755
3758
  /**
@@ -3795,19 +3798,19 @@ declare type ConstWindowOptions = {
3795
3798
  */
3796
3799
  processAffinity: string;
3797
3800
  /**
3798
- * @defaultValue false
3799
- *
3800
3801
  * Displays a shadow on frameless windows.
3801
3802
  * `shadow` and `cornerRounding` are mutually exclusive.
3802
3803
  * On Windows 7, Aero theme is required.
3804
+ *
3805
+ * @default false
3803
3806
  */
3804
3807
  shadow: boolean;
3805
3808
  /**
3806
- * @defaultValue true
3807
- *
3808
3809
  * Caches the location of the window.
3809
3810
  *
3810
3811
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3812
+ *
3813
+ * @default true
3811
3814
  */
3812
3815
  saveWindowState: boolean;
3813
3816
  /**
@@ -3816,22 +3819,22 @@ declare type ConstWindowOptions = {
3816
3819
  */
3817
3820
  ignoreSavedWindowState: boolean;
3818
3821
  /**
3819
- * @defaultValue false
3820
- *
3821
3822
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3822
3823
  *
3823
3824
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3824
3825
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3826
+ *
3827
+ * @default false
3825
3828
  */
3826
3829
  smallWindow: boolean;
3827
3830
  /**
3828
- * @defaultValue "normal"
3829
- *
3830
3831
  * The visible state of the window on creation.
3831
3832
  * One of:
3832
3833
  * * `"maximized"`
3833
3834
  * * `"minimized"`
3834
3835
  * * `"normal"`
3836
+ *
3837
+ * @default "normal"
3835
3838
  */
3836
3839
  state: WindowState;
3837
3840
  /**
@@ -3845,20 +3848,20 @@ declare type ConstWindowOptions = {
3845
3848
  */
3846
3849
  url: string;
3847
3850
  /**
3848
- * @defaultValue <application UUID>
3849
- *
3850
3851
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3851
3852
  * If omitted, defaults to the `uuid` of the application spawning the window.
3852
3853
  * If given, must match the `uuid` of the application spawning the window.
3853
3854
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3854
3855
  * really no need to provide it.
3856
+ *
3857
+ * @default <application UUID>
3855
3858
  */
3856
3859
  uuid: string;
3857
3860
  /**
3858
- * @defaultValue false
3859
- *
3860
3861
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3861
3862
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3863
+ *
3864
+ * @default false
3862
3865
  */
3863
3866
  waitForPageLoad: boolean;
3864
3867
  width: number;
@@ -4130,13 +4133,13 @@ declare type CopyBlockedEventReason = 'disabled';
4130
4133
  */
4131
4134
  declare type CopyPermissions = {
4132
4135
  /**
4133
- * @defaultValue 'allowed'
4134
- *
4135
4136
  * Controls the behavior for copy operations for a matched URL.
4136
4137
  *
4137
4138
  * allow: Enables all copy operations.
4138
4139
  * block: Disables all copy operations.
4139
4140
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4141
+ *
4142
+ * @default 'allowed'
4140
4143
  */
4141
4144
  behavior: 'allow' | 'block' | 'protect';
4142
4145
  /**
@@ -4144,9 +4147,9 @@ declare type CopyPermissions = {
4144
4147
  */
4145
4148
  options?: {
4146
4149
  /**
4147
- * @defaultValue ''
4148
- *
4149
4150
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4151
+ *
4152
+ * @default ''
4150
4153
  */
4151
4154
  replacementText: string;
4152
4155
  };
@@ -4160,15 +4163,15 @@ declare type CopyPermissions = {
4160
4163
  */
4161
4164
  declare type CornerRounding = {
4162
4165
  /**
4163
- * @defaultValue 0
4164
- *
4165
4166
  * The height in pixels.
4167
+ *
4168
+ * @default 0
4166
4169
  */
4167
4170
  height: number;
4168
4171
  /**
4169
- * @defaultValue 0
4170
- *
4171
4172
  * The width in pixels.
4173
+ *
4174
+ * @default 0
4172
4175
  */
4173
4176
  width: number;
4174
4177
  };
@@ -4258,8 +4261,6 @@ declare type CreateLayoutOptions = {
4258
4261
  layoutName: string;
4259
4262
  layout: LayoutOptions;
4260
4263
  /**
4261
- * @defaultValue 'default'
4262
- *
4263
4264
  * Controls the View behavior for the given `layout` property. Note
4264
4265
  * that the selected behavior only applies to unnamed Views or
4265
4266
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4281,6 +4282,8 @@ declare type CreateLayoutOptions = {
4281
4282
  * override. Note that during applyLayoutSnapshot, Views are created and
4282
4283
  * attached to the Provider while the Window is being created, so it's
4283
4284
  * important to not 'duplicate' Views in this workflow.
4285
+ *
4286
+ * @default 'default'
4284
4287
  */
4285
4288
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4286
4289
  };
@@ -4540,7 +4543,7 @@ declare type DomainApiSettings = {
4540
4543
  * * 'none': The `fin` API will be not available.
4541
4544
  * * 'global': The entire `fin` API will be available.
4542
4545
  *
4543
- * @defaultValue 'global'
4546
+ * @default 'global'
4544
4547
  */
4545
4548
  fin?: InjectionType;
4546
4549
  /**
@@ -5132,9 +5135,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
5132
5135
  */
5133
5136
  declare type ExcludeOptions = {
5134
5137
  /**
5135
- * @defaultValue false
5136
- *
5137
5138
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5139
+ *
5140
+ * @default false
5138
5141
  */
5139
5142
  preloadScripts: boolean;
5140
5143
  };
@@ -5965,34 +5968,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
5965
5968
  */
5966
5969
  declare type FindInPageOptions = {
5967
5970
  /**
5968
- * @defaultValue true
5969
- *
5970
5971
  * Searches in the forward direction (backward otherwise)
5972
+ *
5973
+ * @default true
5971
5974
  */
5972
5975
  forward?: boolean;
5973
5976
  /**
5974
- * @defaultValue false
5975
- *
5976
5977
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5978
+ *
5979
+ * @default false
5977
5980
  */
5978
5981
  findNext?: boolean;
5979
5982
  /**
5980
- * @defaultValue false
5981
- *
5982
5983
  * Enables case-sensitive searching.
5984
+ *
5985
+ * @default false
5983
5986
  */
5984
5987
  matchCase?: boolean;
5985
5988
  /**
5986
- * @defaultValue false
5987
- *
5988
5989
  * Only searches from the start of words.
5990
+ *
5991
+ * @default false
5989
5992
  */
5990
5993
  wordStart?: boolean;
5991
5994
  /**
5992
- * @defaultValue false
5993
- *
5994
5995
  * 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
5996
  * lowercase or non-letter. Accepts several other intra-word matches.
5997
+ *
5998
+ * @default false
5996
5999
  */
5997
6000
  medialCapitalAsWordStart?: boolean;
5998
6001
  };
@@ -6506,9 +6509,9 @@ declare type Hotkey = {
6506
6509
  */
6507
6510
  keys: string;
6508
6511
  /**
6509
- * @defaultValue false
6510
- *
6511
6512
  * Prevent default key handling before emitting the event.
6513
+ *
6514
+ * @default false
6512
6515
  */
6513
6516
  preventDefault?: boolean;
6514
6517
  };
@@ -9049,77 +9052,79 @@ declare type LayoutOptions = {
9049
9052
  */
9050
9053
  settings?: {
9051
9054
  /**
9052
- * @defaultValue false
9053
- *
9054
9055
  * When true the splitters will not be draggable and the layout will not resize.
9056
+ *
9057
+ * @default false
9055
9058
  */
9056
9059
  preventSplitterResize?: boolean;
9057
9060
  /**
9058
- * @defaultValue false
9059
- *
9060
9061
  * Whether the popout button will only act on the entire stack,
9061
9062
  * as opposed to only the active tab.
9063
+ *
9064
+ * @default false
9062
9065
  */
9063
9066
  popoutWholeStack?: boolean;
9064
9067
  /**
9065
- * @defaultValue false
9066
- *
9067
9068
  * Limits the area to which tabs can be dragged.
9068
9069
  * If true, the layout container is the only area where tabs can be dropped.
9070
+ *
9071
+ * @default false
9069
9072
  */
9070
9073
  constrainDragToContainer?: boolean;
9071
9074
  /**
9072
- * @defaultValue false
9073
- *
9074
9075
  * Whether to show the popout button on stack header.
9075
9076
  * The button will create a new window with current tab as its content.
9076
9077
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
9078
+ *
9079
+ * @default false
9077
9080
  */
9078
9081
  showPopoutIcon?: boolean;
9079
9082
  /**
9080
- * @defaultValue false
9081
- *
9082
9083
  * Whether to show the maximize button on stack header.
9083
9084
  * The button will maximize the current tab to fill the entire window.
9085
+ *
9086
+ * @default false
9084
9087
  */
9085
9088
  showMaximiseIcon?: boolean;
9086
9089
  /**
9087
- * @defaultValue false
9088
- *
9089
9090
  * Whether to show the close button on stack header
9090
9091
  * (not to be confused with close button on every tab).
9092
+ *
9093
+ * @default false
9091
9094
  */
9092
9095
  showCloseIcon?: boolean;
9093
9096
  /**
9094
- * @defaultValue false
9095
- *
9096
9097
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
9098
+ *
9099
+ * @default false
9097
9100
  */
9098
9101
  constrainDragToHeaders?: boolean;
9099
9102
  /**
9100
- * @defaultValue true
9101
- *
9102
9103
  * Turns tab headers on or off.
9103
9104
  * If false, the layout will be displayed with splitters only.
9105
+ *
9106
+ * @default true
9104
9107
  */
9105
9108
  hasHeaders?: boolean;
9106
9109
  /**
9107
- * @defaultValue true
9108
- *
9109
9110
  * If true, the user can re-arrange the layout by
9110
9111
  * dragging items by their tabs to the desired location.
9112
+ *
9113
+ * @default true
9111
9114
  */
9112
9115
  reorderEnabled?: boolean;
9113
9116
  /**
9114
- * @defaultValue false
9115
- *
9116
9117
  * If true, tabs can't be dragged out of the window.
9118
+ *
9119
+ * @default false
9117
9120
  */
9118
9121
  preventDragOut?: boolean;
9119
9122
  /**
9120
9123
  * @defaultValue=false
9121
9124
  *
9122
9125
  * If true, tabs can't be dragged into the window.
9126
+ *
9127
+ * @default false
9123
9128
  */
9124
9129
  preventDragIn?: boolean;
9125
9130
  };
@@ -9562,10 +9567,10 @@ declare type MutableViewOptions = {
9562
9567
  /**
9563
9568
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9564
9569
  *
9565
- * @defaultValue true
9566
- *
9567
9570
  * Show the context menu when right-clicking on the view.
9568
9571
  * Gives access to the devtools for the view.
9572
+ *
9573
+ * @default true
9569
9574
  */
9570
9575
  contextMenu: boolean;
9571
9576
  /**
@@ -9612,24 +9617,25 @@ declare type MutableViewOptions = {
9612
9617
  contentNavigation: ContentNavigation;
9613
9618
  contentRedirect: ContentRedirect;
9614
9619
  /**
9615
- * @defaultValue false
9616
9620
  * @deprecated
9617
9621
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9618
9622
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9623
+ *
9624
+ * @default false
9619
9625
  */
9620
9626
  detachOnClose: boolean;
9621
9627
  /**
9622
- * @defaultValue true
9623
- *
9624
9628
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9625
9629
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9626
9630
  * if the view isn't part of the new layout when running `Layout.replace`.
9631
+ *
9632
+ * @default true
9627
9633
  */
9628
9634
  isClosable: boolean;
9629
9635
  /**
9630
- * @defaultValue false
9631
- *
9632
9636
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9637
+ *
9638
+ * @default false
9633
9639
  */
9634
9640
  preventDragOut: boolean;
9635
9641
  interop?: InteropConfig;
@@ -9641,7 +9647,7 @@ declare type MutableViewOptions = {
9641
9647
  /**
9642
9648
  * {@inheritDoc ViewThrottling}
9643
9649
  *
9644
- * @defaultValue 'enabled'
9650
+ * @default 'enabled'
9645
9651
  */
9646
9652
  throttling: ViewThrottling;
9647
9653
  /**
@@ -9660,7 +9666,7 @@ declare type MutableWindowOptions = {
9660
9666
  * Turns anything of matching RGB value transparent.
9661
9667
  *
9662
9668
  * Caveats:
9663
- * * runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
9669
+ * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
9664
9670
  * * User cannot click-through transparent regions
9665
9671
  * * Not supported on Mac
9666
9672
  * * Windows Aero must be enabled
@@ -9669,25 +9675,25 @@ declare type MutableWindowOptions = {
9669
9675
  */
9670
9676
  alphaMask: RGB;
9671
9677
  /**
9672
- * @defaultValue false
9673
- *
9674
9678
  * Always position the window at the top of the window stack.
9679
+ *
9680
+ * @default false
9675
9681
  */
9676
9682
  alwaysOnTop: boolean;
9677
9683
  /**
9678
- * @defaultValue 0
9679
- *
9680
9684
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9681
9685
  * an aspect ratio will not be enforced.
9686
+ *
9687
+ * @default 0
9682
9688
  */
9683
9689
  aspectRatio: number;
9684
9690
  /**
9685
9691
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9686
9692
  *
9687
- * @defaultValue true
9688
- *
9689
9693
  * Show the context menu when right-clicking on the window.
9690
9694
  * Gives access to the devtools for the window.
9695
+ *
9696
+ * @default true
9691
9697
  */
9692
9698
  contextMenu: boolean;
9693
9699
  /**
@@ -9757,12 +9763,14 @@ declare type MutableWindowOptions = {
9757
9763
  * @defaultValue true
9758
9764
  *
9759
9765
  * Show the window's frame.
9766
+ *
9767
+ * @default true
9760
9768
  */
9761
9769
  frame: boolean;
9762
9770
  /**
9763
- * @defaultValue false
9764
- *
9765
9771
  * Hides the window instead of closing it when the close button is pressed.
9772
+ *
9773
+ * @default false
9766
9774
  */
9767
9775
  hideOnClose: boolean;
9768
9776
  /**
@@ -9815,60 +9823,61 @@ declare type MutableWindowOptions = {
9815
9823
  */
9816
9824
  icon: string;
9817
9825
  /**
9818
- * @defaultValue true
9819
- *
9820
9826
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9821
9827
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9828
+ *
9829
+ * @default true
9822
9830
  */
9823
9831
  includeInSnapshots: boolean;
9824
9832
  /**
9825
- * @defaultValue -1
9826
- *
9827
9833
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9834
+ *
9835
+ * @default -1
9828
9836
  */
9829
9837
  maxHeight: number;
9830
9838
  /**
9831
- * @defaultValue true
9832
- *
9833
9839
  * Allows the window to be maximized.
9840
+ *
9841
+ * @default true
9834
9842
  */
9835
9843
  maximizable: boolean;
9836
9844
  /**
9837
- * @defaultValue -1
9838
- *
9839
9845
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9846
+ *
9847
+ * @default -1
9840
9848
  */
9841
9849
  maxWidth: number;
9842
9850
  /**
9843
- * @defaultValue 0
9844
- *
9845
9851
  * The minimum height of the window.
9852
+ *
9853
+ * @default 0
9846
9854
  */
9847
9855
  minHeight: number;
9848
9856
  /**
9849
- * @defaultValue true
9850
- *
9851
9857
  * Allows the window to be minimized.
9858
+ *
9859
+ * @default true
9852
9860
  */
9853
9861
  minimizable: boolean;
9854
9862
  /**
9855
- * @defaultValue true
9856
- *
9857
9863
  * The minimum width of the window.
9864
+ *
9865
+ * @default true
9858
9866
  */
9859
9867
  minWidth: number;
9860
9868
  /**
9861
- * @defaultValue 1
9862
- *
9863
9869
  * A flag that specifies how transparent the window will be.
9864
9870
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9865
9871
  * This value is clamped between `0.0` and `1.0`.
9872
+ * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
9873
+ *
9874
+ * @default 1
9866
9875
  */
9867
9876
  opacity: number;
9868
9877
  /**
9869
- * @defaultValue true
9870
- *
9871
9878
  * A flag to allow the user to resize the window.
9879
+ *
9880
+ * @default true
9872
9881
  */
9873
9882
  resizable: boolean;
9874
9883
  /**
@@ -9876,16 +9885,16 @@ declare type MutableWindowOptions = {
9876
9885
  */
9877
9886
  resizeRegion: ResizeRegion;
9878
9887
  /**
9879
- * @defaultValue false
9880
- *
9881
9888
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9882
9889
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9890
+ *
9891
+ * @default false
9883
9892
  */
9884
9893
  showBackgroundImages: boolean;
9885
9894
  /**
9886
- * @defaultValue true
9887
- *
9888
9895
  * Shows the window's icon in the taskbar.
9896
+ *
9897
+ * @default true
9889
9898
  */
9890
9899
  showTaskbarIcon: boolean;
9891
9900
  /**
@@ -9908,7 +9917,7 @@ declare type MutableWindowOptions = {
9908
9917
  /**
9909
9918
  * {@inheritDoc WindowThrottling}
9910
9919
  *
9911
- * @defaultValue 'enabled'
9920
+ * @default 'enabled'
9912
9921
  *
9913
9922
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9914
9923
  */
@@ -10525,12 +10534,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10525
10534
  */
10526
10535
  declare type PastePermissions = {
10527
10536
  /**
10528
- * @defaultValue 'non-protected-content'
10529
- *
10530
10537
  * Controls the behavior for paste operations for a matched URL.
10531
10538
  *
10532
10539
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10533
10540
  * 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.
10541
+ *
10542
+ * @default 'non-protected-content'
10534
10543
  */
10535
10544
  behavior: 'non-protected-content' | 'all-content';
10536
10545
  };
@@ -11595,11 +11604,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11595
11604
  */
11596
11605
  providerUrl?: string;
11597
11606
  /**
11598
- * @defaultValue true
11599
- *
11600
11607
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11601
11608
  *
11602
11609
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11610
+ *
11611
+ * @default true
11603
11612
  */
11604
11613
  allowLaunchIntoPlatform?: boolean;
11605
11614
  };
@@ -12288,22 +12297,22 @@ declare type PopupOptions = {
12288
12297
  url?: string;
12289
12298
  /**
12290
12299
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
12291
- * @defaultValue 300
12300
+ * @default 300
12292
12301
  */
12293
12302
  height?: number;
12294
12303
  /**
12295
12304
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
12296
- * @defaultValue 300
12305
+ * @default 300
12297
12306
  */
12298
12307
  width?: number;
12299
12308
  /**
12300
12309
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12301
- * @defaultValue 0
12310
+ * @default 0
12302
12311
  */
12303
12312
  x?: number;
12304
12313
  /**
12305
12314
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
12306
- * @defaultValue 0
12315
+ * @default 0
12307
12316
  */
12308
12317
  y?: number;
12309
12318
  /**
@@ -12311,7 +12320,7 @@ declare type PopupOptions = {
12311
12320
  * * 'modal' restricts resizing and positioning in the caller.
12312
12321
  * * 'hide' hides the popup window on blur.
12313
12322
  * * 'close' closes the popup window on blur.
12314
- * @defaultValue 'close'
12323
+ * @default 'close'
12315
12324
  */
12316
12325
  blurBehavior?: PopupBlurBehavior;
12317
12326
  /**
@@ -12319,19 +12328,19 @@ declare type PopupOptions = {
12319
12328
  * * 'none' will do nothing.
12320
12329
  * * 'hide' hides the popup window on `dispatchPopupResult`.
12321
12330
  * * 'close' closes the popup window on `dispatchPopupResult`.
12322
- * @defaultValue 'close'
12331
+ * @default 'close'
12323
12332
  */
12324
12333
  resultDispatchBehavior?: PopupResultBehavior;
12325
12334
  /**
12326
12335
  * Hide the popup window instead of closing when `close` is called on it.
12327
12336
  *
12328
12337
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
12329
- * @defaultValue false
12338
+ * @default false
12330
12339
  */
12331
12340
  hideOnClose?: boolean;
12332
12341
  /**
12333
12342
  * Determines if the popup window should or should not be focused when it is shown.
12334
- * @defaultValue true
12343
+ * @default true
12335
12344
  */
12336
12345
  focus?: boolean;
12337
12346
  /**
@@ -12425,9 +12434,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
12425
12434
  */
12426
12435
  declare type PreloadScript = {
12427
12436
  /**
12428
- * @defaultValue false
12429
- *
12430
12437
  * Fail to load the window if this preload script fails
12438
+ *
12439
+ * @default false
12431
12440
  */
12432
12441
  mandatory?: boolean;
12433
12442
  /**
@@ -12523,15 +12532,15 @@ declare type PrinterInfo = {
12523
12532
  declare type PrintOptions = {
12524
12533
  content?: 'self';
12525
12534
  /**
12526
- * @defaultValue false
12527
- *
12528
12535
  * Disables prompting the user for print settings.
12536
+ *
12537
+ * @default false
12529
12538
  */
12530
12539
  silent?: boolean;
12531
12540
  /**
12532
- * @defaultValue false
12533
- *
12534
12541
  * Includes the webpage background color and image when printing.
12542
+ *
12543
+ * @default false
12535
12544
  */
12536
12545
  printBackground?: boolean;
12537
12546
  /**
@@ -12539,9 +12548,9 @@ declare type PrintOptions = {
12539
12548
  */
12540
12549
  deviceName?: string;
12541
12550
  /**
12542
- * @defaultValue true
12543
- *
12544
12551
  * Prints in full color (greyscale otherwise).
12552
+ *
12553
+ * @default true
12545
12554
  */
12546
12555
  color?: boolean;
12547
12556
  /**
@@ -12549,9 +12558,9 @@ declare type PrintOptions = {
12549
12558
  */
12550
12559
  margins?: Margins;
12551
12560
  /**
12552
- * @defaultValue true
12553
- *
12554
12561
  * Prints in landscape mode (portrait otherwise).
12562
+ *
12563
+ * @default true
12555
12564
  */
12556
12565
  landscape?: boolean;
12557
12566
  /**
@@ -13722,15 +13731,15 @@ declare type ReplaceViewPayload = {
13722
13731
  */
13723
13732
  declare type ResizeRegion = {
13724
13733
  /**
13725
- * @defaultValue 7
13726
- *
13727
13734
  * The size of the resize region in pixels.
13735
+ *
13736
+ * @default 7
13728
13737
  */
13729
13738
  size?: number;
13730
13739
  /**
13731
- * @defaultValue 9
13732
- *
13733
13740
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13741
+ *
13742
+ * @default 9
13734
13743
  */
13735
13744
  bottomRightCorner?: number;
13736
13745
  /**
@@ -13738,27 +13747,27 @@ declare type ResizeRegion = {
13738
13747
  */
13739
13748
  sides?: {
13740
13749
  /**
13741
- * @defaultValue true
13742
- *
13743
13750
  * Enables resizing from the top of the window.
13751
+ *
13752
+ * @default true
13744
13753
  */
13745
13754
  top?: boolean;
13746
13755
  /**
13747
- * @defaultValue true
13748
- *
13749
13756
  * Enables resizing from the bottom of the window.
13757
+ *
13758
+ * @default true
13750
13759
  */
13751
13760
  bottom?: boolean;
13752
13761
  /**
13753
- * @defaultValue true
13754
- *
13755
13762
  * Enables resizing from the left side of the window.
13763
+ *
13764
+ * @default true
13756
13765
  */
13757
13766
  left?: boolean;
13758
13767
  /**
13759
- * @defaultValue true
13760
- *
13761
13768
  * Enables resizing from the right side of the window.
13769
+ *
13770
+ * @default true
13762
13771
  */
13763
13772
  right?: boolean;
13764
13773
  };
@@ -14302,9 +14311,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
14302
14311
  */
14303
14312
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
14304
14313
  /**
14305
- * @defaultValue 0
14306
- *
14307
14314
  * Number of milliseconds to wait between view repaints.
14315
+ *
14316
+ * @default 0
14308
14317
  */
14309
14318
  paintIntervalMs?: number;
14310
14319
  };
@@ -16355,9 +16364,9 @@ declare type TransitionBase = {
16355
16364
  */
16356
16365
  duration: number;
16357
16366
  /**
16358
- * @defaultValue false
16359
- *
16360
16367
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16368
+ *
16369
+ * @default false
16361
16370
  */
16362
16371
  relative?: boolean;
16363
16372
  };
@@ -16373,9 +16382,9 @@ declare type TransitionOptions = {
16373
16382
  */
16374
16383
  interrupt: boolean;
16375
16384
  /**
16376
- * @defaultValue false
16377
- *
16378
16385
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16386
+ *
16387
+ * @default false
16379
16388
  */
16380
16389
  relative?: boolean;
16381
16390
  tween?: tween;
@@ -17440,9 +17449,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
17440
17449
  */
17441
17450
  declare type ViewVisibilityOption = {
17442
17451
  /**
17443
- * @defaultValue false
17444
- *
17445
17452
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
17453
+ *
17454
+ * @default false
17446
17455
  */
17447
17456
  enabled?: boolean;
17448
17457
  };