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