tauri-apps/tauri
1
1
Fork 0
mirror of https://github.com/tauri-apps/tauri.git synced 2024-11-28 20:48:52 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): clarify setSize, setMinSize, setMaxSize and setLocation, closes #2660

Browse Source
This commit is contained in:
Lucas Nogueira 2021-09-29 18:00:59 -03:00
parent 35ae9c8a2e
commit a21f6b212c
No known key found for this signature in database
GPG Key ID: 2714B66BCFB01F7F
2 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/tauri/scripts/bundle.js
View File

File diff suppressed because one or more lines are too long

38
tooling/api/src/window.ts
View File

@ -795,14 +795,14 @@ class WindowManager extends WebviewWindowHandle {
}
/**
* Resizes the window.
* Resizes the window with a new inner size.
* @example
* ```typescript
* import { appWindow, LogicalSize } from '@tauri-apps/api/window'
* await appWindow.setSize(new LogicalSize(600, 500))
* ```
*
* @param size The logical or physical size.
* @param size The logical or physical inner size.
* @returns A promise indicating the success or failure of the operation.
*/
async setSize(size: LogicalSize | PhysicalSize): Promise<void> {
@ -833,18 +833,18 @@ class WindowManager extends WebviewWindowHandle {
}
/**
* Sets the window min size. If the `size` argument is not provided, the min size is unset.
* Sets the window minimum inner size. If the `size` argument is not provided, the constraint is unset.
* @example
* ```typescript
* import { appWindow, PhysicalSize } from '@tauri-apps/api/window'
* await appWindow.setMinSize(new PhysicalSize(600, 500))
* ```
*
* @param size The logical or physical size.
* @param size The logical or physical inner size, or `null` to unset the constraint.
* @returns A promise indicating the success or failure of the operation.
*/
async setMinSize(
size: LogicalSize | PhysicalSize | undefined
size: LogicalSize | PhysicalSize | null | undefined
): Promise<void> {
if (size && size.type !== 'Logical' && size.type !== 'Physical') {
throw new Error(
@ -861,12 +861,12 @@ class WindowManager extends WebviewWindowHandle {
type: 'setMinSize',
payload: size
? {
type: size.type,
data: {
width: size.width,
height: size.height
}
type: size.type,
data: {
width: size.width,
height: size.height
}
}
: null
}
}
@ -875,18 +875,18 @@ class WindowManager extends WebviewWindowHandle {
}
/**
* Sets the window max size. If the `size` argument is undefined, the max size is unset.
* Sets the window maximum inner size. If the `size` argument is undefined, the constraint is unset.
* @example
* ```typescript
* import { appWindow, LogicalSize } from '@tauri-apps/api/window'
* await appWindow.setMaxSize(new LogicalSize(600, 500))
* ```
*
* @param size The logical or physical size.
* @param size The logical or physical inner size, or `null` to unset the constraint.
* @returns A promise indicating the success or failure of the operation.
*/
async setMaxSize(
size: LogicalSize | PhysicalSize | undefined
size: LogicalSize | PhysicalSize | null | undefined
): Promise<void> {
if (size && size.type !== 'Logical' && size.type !== 'Physical') {
throw new Error(
@ -903,12 +903,12 @@ class WindowManager extends WebviewWindowHandle {
type: 'setMaxSize',
payload: size
? {
type: size.type,
data: {
width: size.width,
height: size.height
}
type: size.type,
data: {
width: size.width,
height: size.height
}
}
: null
}
}
@ -917,7 +917,7 @@ class WindowManager extends WebviewWindowHandle {
}
/**
* Sets the window position.
* Sets the window outer position.
* @example
* ```typescript
* import { appWindow, LogicalPosition } from '@tauri-apps/api/window'