Skip to content

Update Docs #3115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Update Docs #3115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ Type: `object`
| <div className="anchor-with-padding" id="wixconfig.license">`license`<a class="hash-link" href="#wixconfig.license"></a></div> | string? | _null_ | The path to the license file to render on the installer.<br /><br />Must be an RTF file, so if a different extension is provided, we convert it to the RTF format. |
| <div className="anchor-with-padding" id="wixconfig.enableelevatedupdatetask">`enableElevatedUpdateTask`<a class="hash-link" href="#wixconfig.enableelevatedupdatetask"></a></div> | boolean | `false` | Create an elevated update task within Windows Task Scheduler. |
| <div className="anchor-with-padding" id="wixconfig.bannerpath">`bannerPath`<a class="hash-link" href="#wixconfig.bannerpath"></a></div> | string? | _null_ | Path to a bitmap file to use as the installation user interface banner. This bitmap will appear at the top of all but the first page of the installer.<br /><br />The required dimensions are 493px × 58px. |
| <div className="anchor-with-padding" id="wixconfig.dialogimagepath">`dialogImagePath`<a class="hash-link" href="#wixconfig.dialogimagepath"></a></div> | string? | _null_ | Path to a bitmap file to use on the installation user interface dialogs. It is used on the welcome and completion dialogs. The required dimensions are 493px × 312px. |
| <div className="anchor-with-padding" id="wixconfig.dialogimagepath">`dialogImagePath`<a class="hash-link" href="#wixconfig.dialogimagepath"></a></div> | string? | _null_ | Path to a bitmap file to use on the installation user interface dialogs. It is used on the welcome and completion dialogs.<br /><br />The required dimensions are 493px × 312px. |


###### WixLanguage
Expand Down
12 changes: 6 additions & 6 deletions docs/api/js/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This package is also accessible with `window.__TAURI__.cli` when [`build.withGlo

Number of occurrences

**Defined in:** [cli.ts:27](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L27)
**Defined in:** [cli.ts:27](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/cli.ts#L27)

##### `value`

Expand All @@ -28,7 +28,7 @@ string if takes value
boolean if flag
string[] or null if takes multiple values

**Defined in:** [cli.ts:23](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L23)
**Defined in:** [cli.ts:23](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/cli.ts#L23)

### `CliMatches`

Expand All @@ -40,13 +40,13 @@ string[] or null if takes multiple values

> **args**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )<`string`, [`ArgMatch`](cli.md#argmatch)\>

**Defined in:** [cli.ts:42](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L42)
**Defined in:** [cli.ts:42](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/cli.ts#L42)

##### `subcommand`

> **subcommand**: `null` \| [`SubcommandMatch`](cli.md#subcommandmatch)

**Defined in:** [cli.ts:43](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L43)
**Defined in:** [cli.ts:43](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/cli.ts#L43)

### `SubcommandMatch`

Expand All @@ -58,13 +58,13 @@ string[] or null if takes multiple values

> **matches**: [`CliMatches`](cli.md#climatches)

**Defined in:** [cli.ts:35](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L35)
**Defined in:** [cli.ts:35](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/cli.ts#L35)

##### `name`

> **name**: `string`

**Defined in:** [cli.ts:34](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L34)
**Defined in:** [cli.ts:34](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/cli.ts#L34)

## Functions

Expand Down
36 changes: 18 additions & 18 deletions docs/api/js/dialog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,31 +35,31 @@ It is recommended to allowlist only the APIs you use for optimal bundle size and

The label of the cancel button.

**Defined in:** [dialog.ts:112](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L112)
**Defined in:** [dialog.ts:112](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L112)

##### `okLabel`

> `Optional` **okLabel**: `string`

The label of the confirm button.

**Defined in:** [dialog.ts:110](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L110)
**Defined in:** [dialog.ts:110](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L110)

##### `title`

> `Optional` **title**: `string`

The title of the dialog. Defaults to the app name.

**Defined in:** [dialog.ts:106](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L106)
**Defined in:** [dialog.ts:106](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L106)

##### `type`

> `Optional` **type**: `"info"` \| `"warning"` \| `"error"`

The type of the dialog. Defaults to `info`.

**Defined in:** [dialog.ts:108](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L108)
**Defined in:** [dialog.ts:108](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L108)

### `DialogFilter`

Expand All @@ -81,15 +81,15 @@ Extensions to filter, without a `.` prefix.
extensions: ['svg', 'png']
```

**Defined in:** [dialog.ts:48](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L48)
**Defined in:** [dialog.ts:48](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L48)

##### `name`

> **name**: `string`

Filter name.

**Defined in:** [dialog.ts:40](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L40)
**Defined in:** [dialog.ts:40](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L40)

### `MessageDialogOptions`

Expand All @@ -103,23 +103,23 @@ Filter name.

The label of the confirm button.

**Defined in:** [dialog.ts:101](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L101)
**Defined in:** [dialog.ts:101](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L101)

##### `title`

> `Optional` **title**: `string`

The title of the dialog. Defaults to the app name.

**Defined in:** [dialog.ts:97](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L97)
**Defined in:** [dialog.ts:97](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L97)

##### `type`

> `Optional` **type**: `"info"` \| `"warning"` \| `"error"`

The type of the dialog. Defaults to `info`.

**Defined in:** [dialog.ts:99](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L99)
**Defined in:** [dialog.ts:99](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L99)

### `OpenDialogOptions`

Expand All @@ -135,31 +135,31 @@ Options for the open dialog.

Initial directory or file path.

**Defined in:** [dialog.ts:62](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L62)
**Defined in:** [dialog.ts:62](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L62)

##### `directory`

> `Optional` **directory**: `boolean`

Whether the dialog is a directory selection or not.

**Defined in:** [dialog.ts:66](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L66)
**Defined in:** [dialog.ts:66](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L66)

##### `filters`

> `Optional` **filters**: [`DialogFilter`](dialog.md#dialogfilter)[]

The filters of the dialog.

**Defined in:** [dialog.ts:60](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L60)
**Defined in:** [dialog.ts:60](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L60)

##### `multiple`

> `Optional` **multiple**: `boolean`

Whether the dialog allows multiple selection or not.

**Defined in:** [dialog.ts:64](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L64)
**Defined in:** [dialog.ts:64](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L64)

##### `recursive`

Expand All @@ -168,15 +168,15 @@ Whether the dialog allows multiple selection or not.
If `directory` is true, indicates that it will be read recursively later.
Defines whether subdirectories will be allowed on the scope or not.

**Defined in:** [dialog.ts:71](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L71)
**Defined in:** [dialog.ts:71](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L71)

##### `title`

> `Optional` **title**: `string`

The title of the dialog window.

**Defined in:** [dialog.ts:58](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L58)
**Defined in:** [dialog.ts:58](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L58)

### `SaveDialogOptions`

Expand All @@ -194,23 +194,23 @@ Initial directory or file path.
If it's a directory path, the dialog interface will change to that folder.
If it's not an existing directory, the file name will be set to the dialog's file name input and the dialog will be set to the parent folder.

**Defined in:** [dialog.ts:89](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L89)
**Defined in:** [dialog.ts:89](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L89)

##### `filters`

> `Optional` **filters**: [`DialogFilter`](dialog.md#dialogfilter)[]

The filters of the dialog.

**Defined in:** [dialog.ts:83](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L83)
**Defined in:** [dialog.ts:83](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L83)

##### `title`

> `Optional` **title**: `string`

The title of the dialog window.

**Defined in:** [dialog.ts:81](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L81)
**Defined in:** [dialog.ts:81](https://github.com/tauri-apps/tauri/blob/089939b/tooling/api/src/dialog.ts#L81)

## Functions

Expand Down
Loading
Loading