Skip to content

Commit 5c07d25

Browse files
authored
Update Docs (#2944)
Co-authored-by: tauri-bot <[email protected]>
1 parent 3689ffd commit 5c07d25

File tree

15 files changed

+225
-222
lines changed

15 files changed

+225
-222
lines changed

docs/api/config.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ The configuration is composed of the following objects:
2929
- [`build`](#buildconfig): The build configuration
3030
- [`plugins`](#pluginconfig): The plugins config
3131

32-
```json title="Example tauri.config.json file"
32+
Example tauri.config.json file:
33+
34+
```json
3335
{
3436
"build": {
3537
"beforeBuildCommand": "",
@@ -204,7 +206,7 @@ Can be any **ONE** of the following types:
204206
- "Overlay": Shows the title bar as a transparent overlay over the window's content.
205207

206208
Keep in mind:
207-
- The height of the title bar is different on different OS versions, which can lead to window the controls and title not being where you don't expect.
209+
- The height of the title bar is different on different OS versions, which can lead to the window controls and title not being where you expect them to be.
208210
- You need to define a custom drag region to make your window draggable, however due to a limitation you can't drag the window when it's not in focus <https://github.com/tauri-apps/tauri/issues/4316>.
209211
- The color of the window title depends on the system theme.
210212

@@ -267,7 +269,7 @@ Type: `object`
267269
| ---- | ---- | ------- | ----------- |
268270
| <div className="anchor-with-padding" id="bundleconfig.active">`active`<a class="hash-link" href="#bundleconfig.active"></a></div> | boolean | `false` | Whether Tauri should bundle your application or just output the executable. |
269271
| <div className="anchor-with-padding" id="bundleconfig.targets">`targets`<a class="hash-link" href="#bundleconfig.targets"></a></div> | [`BundleTarget`](#bundletarget) | [view](#bundletarget) | The bundle targets, currently supports ["deb", "rpm", "appimage", "nsis", "msi", "app", "dmg", "updater"] or "all". |
270-
| <div className="anchor-with-padding" id="bundleconfig.identifier">`identifier`<a class="hash-link" href="#bundleconfig.identifier"></a></div> | string (required) | | The application identifier in reverse domain name notation (e.g. `com.tauri.example`). This string must be unique across applications since it is used in system configurations like the bundle ID and path to the webview data directory. This string must contain only alphanumeric characters (AZ, az, and 09), hyphens (-), and periods (.). |
272+
| <div className="anchor-with-padding" id="bundleconfig.identifier">`identifier`<a class="hash-link" href="#bundleconfig.identifier"></a></div> | string (required) | | The application identifier in reverse domain name notation (e.g. `com.tauri.example`). This string must be unique across applications since it is used in system configurations like the bundle ID and path to the webview data directory. This string must contain only alphanumeric characters (A-Z, a-z, and 0-9), hyphens (-), and periods (.). |
271273
| <div className="anchor-with-padding" id="bundleconfig.publisher">`publisher`<a class="hash-link" href="#bundleconfig.publisher"></a></div> | string? | _null_ | The application's publisher. Defaults to the second element in the identifier string. Currently maps to the Manufacturer property of the Windows Installer. |
272274
| <div className="anchor-with-padding" id="bundleconfig.icon">`icon`<a class="hash-link" href="#bundleconfig.icon"></a></div> | string[] | [] | The app's icons |
273275
| <div className="anchor-with-padding" id="bundleconfig.resources">`resources`<a class="hash-link" href="#bundleconfig.resources"></a></div> | [`BundleResources`](#bundleresources)? | [view](#bundleresources) | App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported. |
@@ -361,7 +363,7 @@ Type: `object`
361363
| <div className="anchor-with-padding" id="rpmconfig.depends">`depends`<a class="hash-link" href="#rpmconfig.depends"></a></div> | array? | _null_ | The list of RPM dependencies your application relies on. |
362364
| <div className="anchor-with-padding" id="rpmconfig.provides">`provides`<a class="hash-link" href="#rpmconfig.provides"></a></div> | array? | _null_ | The list of RPM dependencies your application provides. |
363365
| <div className="anchor-with-padding" id="rpmconfig.conflicts">`conflicts`<a class="hash-link" href="#rpmconfig.conflicts"></a></div> | array? | _null_ | The list of RPM dependencies your application conflicts with. They must not be present in order for the package to be installed. |
364-
| <div className="anchor-with-padding" id="rpmconfig.obsoletes">`obsoletes`<a class="hash-link" href="#rpmconfig.obsoletes"></a></div> | array? | _null_ | The list of RPM dependencies your application supersedes<br />- if this package is installed, packages listed as obsoletes will be automatically removed (if they are present). |
366+
| <div className="anchor-with-padding" id="rpmconfig.obsoletes">`obsoletes`<a class="hash-link" href="#rpmconfig.obsoletes"></a></div> | array? | _null_ | The list of RPM dependencies your application supersedes<br />- if this package is installed, packages listed as "obsoletes" will be automatically removed (if they are present). |
365367
| <div className="anchor-with-padding" id="rpmconfig.release">`release`<a class="hash-link" href="#rpmconfig.release"></a></div> | string | _null_ | The RPM release tag. |
366368
| <div className="anchor-with-padding" id="rpmconfig.epoch">`epoch`<a class="hash-link" href="#rpmconfig.epoch"></a></div> | integer _(format: `uint32`)_ | `0` | The RPM epoch. |
367369
| <div className="anchor-with-padding" id="rpmconfig.files">`files`<a class="hash-link" href="#rpmconfig.files"></a></div> | object | _null_ | The files to include on the package. |
@@ -420,6 +422,7 @@ Type: `object`
420422
| <div className="anchor-with-padding" id="macconfig.exceptiondomain">`exceptionDomain`<a class="hash-link" href="#macconfig.exceptiondomain"></a></div> | string? | _null_ | Allows your application to communicate with the outside world. It should be a lowercase, without port and protocol domain name. |
421423
| <div className="anchor-with-padding" id="macconfig.license">`license`<a class="hash-link" href="#macconfig.license"></a></div> | string? | _null_ | The path to the license file to add to the DMG bundle. |
422424
| <div className="anchor-with-padding" id="macconfig.signingidentity">`signingIdentity`<a class="hash-link" href="#macconfig.signingidentity"></a></div> | string? | _null_ | Identity to use for code signing. |
425+
| <div className="anchor-with-padding" id="macconfig.hardenedruntime">`hardenedRuntime`<a class="hash-link" href="#macconfig.hardenedruntime"></a></div> | boolean | `true` | Whether the codesign should enable [hardened runtime](https://developer.apple.com/documentation/security/hardened_runtime) (for executables) or not. |
423426
| <div className="anchor-with-padding" id="macconfig.providershortname">`providerShortName`<a class="hash-link" href="#macconfig.providershortname"></a></div> | string? | _null_ | Provider short name for notarization. |
424427
| <div className="anchor-with-padding" id="macconfig.entitlements">`entitlements`<a class="hash-link" href="#macconfig.entitlements"></a></div> | string? | _null_ | Path to the entitlements file. |
425428

docs/api/js/cli.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This package is also accessible with `window.__TAURI__.cli` when [`build.withGlo
1818
1919
Number of occurrences
2020

21-
**Defined in:** [cli.ts:27](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L27)
21+
**Defined in:** [cli.ts:27](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L27)
2222

2323
##### `value`
2424

@@ -28,7 +28,7 @@ string if takes value
2828
boolean if flag
2929
string[] or null if takes multiple values
3030

31-
**Defined in:** [cli.ts:23](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L23)
31+
**Defined in:** [cli.ts:23](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L23)
3232

3333
### `CliMatches`
3434

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

4141
> **args**: [`Record`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type )<`string`, [`ArgMatch`](cli.md#argmatch)\>
4242
43-
**Defined in:** [cli.ts:42](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L42)
43+
**Defined in:** [cli.ts:42](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L42)
4444

4545
##### `subcommand`
4646

4747
> **subcommand**: `null` \| [`SubcommandMatch`](cli.md#subcommandmatch)
4848
49-
**Defined in:** [cli.ts:43](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L43)
49+
**Defined in:** [cli.ts:43](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L43)
5050

5151
### `SubcommandMatch`
5252

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

5959
> **matches**: [`CliMatches`](cli.md#climatches)
6060
61-
**Defined in:** [cli.ts:35](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L35)
61+
**Defined in:** [cli.ts:35](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L35)
6262

6363
##### `name`
6464

6565
> **name**: `string`
6666
67-
**Defined in:** [cli.ts:34](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/cli.ts#L34)
67+
**Defined in:** [cli.ts:34](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/cli.ts#L34)
6868

6969
## Functions
7070

docs/api/js/dialog.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -35,31 +35,31 @@ It is recommended to allowlist only the APIs you use for optimal bundle size and
3535
3636
The label of the cancel button.
3737

38-
**Defined in:** [dialog.ts:112](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L112)
38+
**Defined in:** [dialog.ts:112](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L112)
3939

4040
##### `okLabel`
4141

4242
> `Optional` **okLabel**: `string`
4343
4444
The label of the confirm button.
4545

46-
**Defined in:** [dialog.ts:110](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L110)
46+
**Defined in:** [dialog.ts:110](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L110)
4747

4848
##### `title`
4949

5050
> `Optional` **title**: `string`
5151
5252
The title of the dialog. Defaults to the app name.
5353

54-
**Defined in:** [dialog.ts:106](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L106)
54+
**Defined in:** [dialog.ts:106](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L106)
5555

5656
##### `type`
5757

5858
> `Optional` **type**: `"info"` \| `"warning"` \| `"error"`
5959
6060
The type of the dialog. Defaults to `info`.
6161

62-
**Defined in:** [dialog.ts:108](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L108)
62+
**Defined in:** [dialog.ts:108](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L108)
6363

6464
### `DialogFilter`
6565

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

84-
**Defined in:** [dialog.ts:48](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L48)
84+
**Defined in:** [dialog.ts:48](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L48)
8585

8686
##### `name`
8787

8888
> **name**: `string`
8989
9090
Filter name.
9191

92-
**Defined in:** [dialog.ts:40](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L40)
92+
**Defined in:** [dialog.ts:40](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L40)
9393

9494
### `MessageDialogOptions`
9595

@@ -103,23 +103,23 @@ Filter name.
103103
104104
The label of the confirm button.
105105

106-
**Defined in:** [dialog.ts:101](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L101)
106+
**Defined in:** [dialog.ts:101](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L101)
107107

108108
##### `title`
109109

110110
> `Optional` **title**: `string`
111111
112112
The title of the dialog. Defaults to the app name.
113113

114-
**Defined in:** [dialog.ts:97](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L97)
114+
**Defined in:** [dialog.ts:97](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L97)
115115

116116
##### `type`
117117

118118
> `Optional` **type**: `"info"` \| `"warning"` \| `"error"`
119119
120120
The type of the dialog. Defaults to `info`.
121121

122-
**Defined in:** [dialog.ts:99](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L99)
122+
**Defined in:** [dialog.ts:99](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L99)
123123

124124
### `OpenDialogOptions`
125125

@@ -135,31 +135,31 @@ Options for the open dialog.
135135
136136
Initial directory or file path.
137137

138-
**Defined in:** [dialog.ts:62](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L62)
138+
**Defined in:** [dialog.ts:62](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L62)
139139

140140
##### `directory`
141141

142142
> `Optional` **directory**: `boolean`
143143
144144
Whether the dialog is a directory selection or not.
145145

146-
**Defined in:** [dialog.ts:66](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L66)
146+
**Defined in:** [dialog.ts:66](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L66)
147147

148148
##### `filters`
149149

150150
> `Optional` **filters**: [`DialogFilter`](dialog.md#dialogfilter)[]
151151
152152
The filters of the dialog.
153153

154-
**Defined in:** [dialog.ts:60](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L60)
154+
**Defined in:** [dialog.ts:60](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L60)
155155

156156
##### `multiple`
157157

158158
> `Optional` **multiple**: `boolean`
159159
160160
Whether the dialog allows multiple selection or not.
161161

162-
**Defined in:** [dialog.ts:64](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L64)
162+
**Defined in:** [dialog.ts:64](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L64)
163163

164164
##### `recursive`
165165

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

171-
**Defined in:** [dialog.ts:71](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L71)
171+
**Defined in:** [dialog.ts:71](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L71)
172172

173173
##### `title`
174174

175175
> `Optional` **title**: `string`
176176
177177
The title of the dialog window.
178178

179-
**Defined in:** [dialog.ts:58](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L58)
179+
**Defined in:** [dialog.ts:58](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L58)
180180

181181
### `SaveDialogOptions`
182182

@@ -194,23 +194,23 @@ Initial directory or file path.
194194
If it's a directory path, the dialog interface will change to that folder.
195195
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.
196196

197-
**Defined in:** [dialog.ts:89](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L89)
197+
**Defined in:** [dialog.ts:89](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L89)
198198

199199
##### `filters`
200200

201201
> `Optional` **filters**: [`DialogFilter`](dialog.md#dialogfilter)[]
202202
203203
The filters of the dialog.
204204

205-
**Defined in:** [dialog.ts:83](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L83)
205+
**Defined in:** [dialog.ts:83](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L83)
206206

207207
##### `title`
208208

209209
> `Optional` **title**: `string`
210210
211211
The title of the dialog window.
212212

213-
**Defined in:** [dialog.ts:81](https://github.com/tauri-apps/tauri/blob/0a00375/tooling/api/src/dialog.ts#L81)
213+
**Defined in:** [dialog.ts:81](https://github.com/tauri-apps/tauri/blob/7c16d0f/tooling/api/src/dialog.ts#L81)
214214

215215
## Functions
216216

0 commit comments

Comments
 (0)