|
| 1 | +--- |
| 2 | +title: "Class: WindowManager" |
| 3 | +sidebar_label: "WindowManager" |
| 4 | +custom_edit_url: null |
| 5 | +hide_title: true |
| 6 | +--- |
| 7 | + |
| 8 | +# Class: WindowManager |
| 9 | + |
| 10 | +[window](../modules/window.md).WindowManager |
| 11 | + |
| 12 | +## Constructors |
| 13 | + |
| 14 | +### constructor |
| 15 | + |
| 16 | +\+ **new WindowManager**(): [*WindowManager*](window.windowmanager.md) |
| 17 | + |
| 18 | +**Returns:** [*WindowManager*](window.windowmanager.md) |
| 19 | + |
| 20 | +## Methods |
| 21 | + |
| 22 | +### close |
| 23 | + |
| 24 | +▸ **close**(): *Promise*<void\> |
| 25 | + |
| 26 | +Closes the window. |
| 27 | + |
| 28 | +**Returns:** *Promise*<void\> |
| 29 | + |
| 30 | +Defined in: [window.ts:267](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L267) |
| 31 | + |
| 32 | +___ |
| 33 | + |
| 34 | +### hide |
| 35 | + |
| 36 | +▸ **hide**(): *Promise*<void\> |
| 37 | + |
| 38 | +Sets the window visibility to false. |
| 39 | + |
| 40 | +**Returns:** *Promise*<void\> |
| 41 | + |
| 42 | +Defined in: [window.ts:253](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L253) |
| 43 | + |
| 44 | +___ |
| 45 | + |
| 46 | +### maximize |
| 47 | + |
| 48 | +▸ **maximize**(): *Promise*<void\> |
| 49 | + |
| 50 | +Maximizes the window. |
| 51 | + |
| 52 | +**Returns:** *Promise*<void\> |
| 53 | + |
| 54 | +Defined in: [window.ts:183](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L183) |
| 55 | + |
| 56 | +___ |
| 57 | + |
| 58 | +### minimize |
| 59 | + |
| 60 | +▸ **minimize**(): *Promise*<void\> |
| 61 | + |
| 62 | +Minimizes the window. |
| 63 | + |
| 64 | +**Returns:** *Promise*<void\> |
| 65 | + |
| 66 | +Defined in: [window.ts:211](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L211) |
| 67 | + |
| 68 | +___ |
| 69 | + |
| 70 | +### resize |
| 71 | + |
| 72 | +▸ **resize**(`width`: *number*, `height`: *number*): *Promise*<void\> |
| 73 | + |
| 74 | +Resizes the window. |
| 75 | + |
| 76 | +#### Parameters: |
| 77 | + |
| 78 | +Name | Type | Description | |
| 79 | +:------ | :------ | :------ | |
| 80 | +`width` | *number* | The new window width | |
| 81 | +`height` | *number* | The new window height | |
| 82 | + |
| 83 | +**Returns:** *Promise*<void\> |
| 84 | + |
| 85 | +Defined in: [window.ts:347](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L347) |
| 86 | + |
| 87 | +___ |
| 88 | + |
| 89 | +### setAlwaysOnTop |
| 90 | + |
| 91 | +▸ **setAlwaysOnTop**(`alwaysOnTop`: *boolean*): *Promise*<void\> |
| 92 | + |
| 93 | +Whether the window should always be on top of other windows. |
| 94 | + |
| 95 | +#### Parameters: |
| 96 | + |
| 97 | +Name | Type | Description | |
| 98 | +:------ | :------ | :------ | |
| 99 | +`alwaysOnTop` | *boolean* | Whether the window should always be on top of other windows or not | |
| 100 | + |
| 101 | +**Returns:** *Promise*<void\> |
| 102 | + |
| 103 | +Defined in: [window.ts:298](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L298) |
| 104 | + |
| 105 | +___ |
| 106 | + |
| 107 | +### setDecorations |
| 108 | + |
| 109 | +▸ **setDecorations**(`decorations`: *boolean*): *Promise*<void\> |
| 110 | + |
| 111 | +Whether the window should have borders and bars. |
| 112 | + |
| 113 | +#### Parameters: |
| 114 | + |
| 115 | +Name | Type | Description | |
| 116 | +:------ | :------ | :------ | |
| 117 | +`decorations` | *boolean* | Whether the window should have borders and bars | |
| 118 | + |
| 119 | +**Returns:** *Promise*<void\> |
| 120 | + |
| 121 | +Defined in: [window.ts:282](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L282) |
| 122 | + |
| 123 | +___ |
| 124 | + |
| 125 | +### setFullscreen |
| 126 | + |
| 127 | +▸ **setFullscreen**(`fullscreen`: *boolean*): *Promise*<void\> |
| 128 | + |
| 129 | +Sets the window fullscreen state. |
| 130 | + |
| 131 | +#### Parameters: |
| 132 | + |
| 133 | +Name | Type | Description | |
| 134 | +:------ | :------ | :------ | |
| 135 | +`fullscreen` | *boolean* | Whether the window should go to fullscreen or not | |
| 136 | + |
| 137 | +**Returns:** *Promise*<void\> |
| 138 | + |
| 139 | +Defined in: [window.ts:450](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L450) |
| 140 | + |
| 141 | +___ |
| 142 | + |
| 143 | +### setHeight |
| 144 | + |
| 145 | +▸ **setHeight**(`height`: *number*): *Promise*<void\> |
| 146 | + |
| 147 | +Sets the window height. |
| 148 | + |
| 149 | +#### Parameters: |
| 150 | + |
| 151 | +Name | Type | Description | |
| 152 | +:------ | :------ | :------ | |
| 153 | +`height` | *number* | The new window height | |
| 154 | + |
| 155 | +**Returns:** *Promise*<void\> |
| 156 | + |
| 157 | +Defined in: [window.ts:330](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L330) |
| 158 | + |
| 159 | +___ |
| 160 | + |
| 161 | +### setIcon |
| 162 | + |
| 163 | +▸ **setIcon**(`icon`: *string* \| *number*[]): *Promise*<void\> |
| 164 | + |
| 165 | +Sets the window icon. |
| 166 | + |
| 167 | +#### Parameters: |
| 168 | + |
| 169 | +Name | Type | Description | |
| 170 | +:------ | :------ | :------ | |
| 171 | +`icon` | *string* \| *number*[] | Icon bytes or path to the icon file | |
| 172 | + |
| 173 | +**Returns:** *Promise*<void\> |
| 174 | + |
| 175 | +Defined in: [window.ts:466](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L466) |
| 176 | + |
| 177 | +___ |
| 178 | + |
| 179 | +### setMaxSize |
| 180 | + |
| 181 | +▸ **setMaxSize**(`maxWidth`: *number*, `maxHeight`: *number*): *Promise*<void\> |
| 182 | + |
| 183 | +Sets the window max size. |
| 184 | + |
| 185 | +#### Parameters: |
| 186 | + |
| 187 | +Name | Type | Description | |
| 188 | +:------ | :------ | :------ | |
| 189 | +`maxWidth` | *number* | The new window max width | |
| 190 | +`maxHeight` | *number* | The new window max height | |
| 191 | + |
| 192 | +**Returns:** *Promise*<void\> |
| 193 | + |
| 194 | +Defined in: [window.ts:383](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L383) |
| 195 | + |
| 196 | +___ |
| 197 | + |
| 198 | +### setMinSize |
| 199 | + |
| 200 | +▸ **setMinSize**(`minWidth`: *number*, `minHeight`: *number*): *Promise*<void\> |
| 201 | + |
| 202 | +Sets the window min size. |
| 203 | + |
| 204 | +#### Parameters: |
| 205 | + |
| 206 | +Name | Type | Description | |
| 207 | +:------ | :------ | :------ | |
| 208 | +`minWidth` | *number* | The new window min width | |
| 209 | +`minHeight` | *number* | The new window min height | |
| 210 | + |
| 211 | +**Returns:** *Promise*<void\> |
| 212 | + |
| 213 | +Defined in: [window.ts:365](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L365) |
| 214 | + |
| 215 | +___ |
| 216 | + |
| 217 | +### setPosition |
| 218 | + |
| 219 | +▸ **setPosition**(`x`: *number*, `y`: *number*): *Promise*<void\> |
| 220 | + |
| 221 | +Sets the window position. |
| 222 | + |
| 223 | +#### Parameters: |
| 224 | + |
| 225 | +Name | Type | Description | |
| 226 | +:------ | :------ | :------ | |
| 227 | +`x` | *number* | The new window x position | |
| 228 | +`y` | *number* | The new window y position | |
| 229 | + |
| 230 | +**Returns:** *Promise*<void\> |
| 231 | + |
| 232 | +Defined in: [window.ts:433](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L433) |
| 233 | + |
| 234 | +___ |
| 235 | + |
| 236 | +### setResizable |
| 237 | + |
| 238 | +▸ **setResizable**(`resizable`: *boolean*): *Promise*<void\> |
| 239 | + |
| 240 | +Updates the window resizable flag. |
| 241 | + |
| 242 | +#### Parameters: |
| 243 | + |
| 244 | +Name | Type | |
| 245 | +:------ | :------ | |
| 246 | +`resizable` | *boolean* | |
| 247 | + |
| 248 | +**Returns:** *Promise*<void\> |
| 249 | + |
| 250 | +Defined in: [window.ts:152](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L152) |
| 251 | + |
| 252 | +___ |
| 253 | + |
| 254 | +### setTitle |
| 255 | + |
| 256 | +▸ **setTitle**(`title`: *string*): *Promise*<void\> |
| 257 | + |
| 258 | +Sets the window title. |
| 259 | + |
| 260 | +#### Parameters: |
| 261 | + |
| 262 | +Name | Type | Description | |
| 263 | +:------ | :------ | :------ | |
| 264 | +`title` | *string* | The new title | |
| 265 | + |
| 266 | +**Returns:** *Promise*<void\> |
| 267 | + |
| 268 | +Defined in: [window.ts:168](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L168) |
| 269 | + |
| 270 | +___ |
| 271 | + |
| 272 | +### setWidth |
| 273 | + |
| 274 | +▸ **setWidth**(`width`: *number*): *Promise*<void\> |
| 275 | + |
| 276 | +Sets the window width. |
| 277 | + |
| 278 | +#### Parameters: |
| 279 | + |
| 280 | +Name | Type | Description | |
| 281 | +:------ | :------ | :------ | |
| 282 | +`width` | *number* | The new window width | |
| 283 | + |
| 284 | +**Returns:** *Promise*<void\> |
| 285 | + |
| 286 | +Defined in: [window.ts:314](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L314) |
| 287 | + |
| 288 | +___ |
| 289 | + |
| 290 | +### setX |
| 291 | + |
| 292 | +▸ **setX**(`x`: *number*): *Promise*<void\> |
| 293 | + |
| 294 | +Sets the window x position. |
| 295 | + |
| 296 | +#### Parameters: |
| 297 | + |
| 298 | +Name | Type | Description | |
| 299 | +:------ | :------ | :------ | |
| 300 | +`x` | *number* | The new window x position | |
| 301 | + |
| 302 | +**Returns:** *Promise*<void\> |
| 303 | + |
| 304 | +Defined in: [window.ts:400](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L400) |
| 305 | + |
| 306 | +___ |
| 307 | + |
| 308 | +### setY |
| 309 | + |
| 310 | +▸ **setY**(`y`: *number*): *Promise*<void\> |
| 311 | + |
| 312 | +Sets the window y position. |
| 313 | + |
| 314 | +#### Parameters: |
| 315 | + |
| 316 | +Name | Type | Description | |
| 317 | +:------ | :------ | :------ | |
| 318 | +`y` | *number* | The new window y position | |
| 319 | + |
| 320 | +**Returns:** *Promise*<void\> |
| 321 | + |
| 322 | +Defined in: [window.ts:416](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L416) |
| 323 | + |
| 324 | +___ |
| 325 | + |
| 326 | +### show |
| 327 | + |
| 328 | +▸ **show**(): *Promise*<void\> |
| 329 | + |
| 330 | +Sets the window visibility to true. |
| 331 | + |
| 332 | +**Returns:** *Promise*<void\> |
| 333 | + |
| 334 | +Defined in: [window.ts:239](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L239) |
| 335 | + |
| 336 | +___ |
| 337 | + |
| 338 | +### unmaximize |
| 339 | + |
| 340 | +▸ **unmaximize**(): *Promise*<void\> |
| 341 | + |
| 342 | +Unmaximizes the window. |
| 343 | + |
| 344 | +**Returns:** *Promise*<void\> |
| 345 | + |
| 346 | +Defined in: [window.ts:197](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L197) |
| 347 | + |
| 348 | +___ |
| 349 | + |
| 350 | +### unminimize |
| 351 | + |
| 352 | +▸ **unminimize**(): *Promise*<void\> |
| 353 | + |
| 354 | +Unminimizes the window. |
| 355 | + |
| 356 | +**Returns:** *Promise*<void\> |
| 357 | + |
| 358 | +Defined in: [window.ts:225](https://github.com/tauri-apps/tauri/blob/850a99a5/tooling/api/src/window.ts#L225) |
0 commit comments