Documentation
On this page

@sharpts/gui

Desktop Services

Dialogs, notifications, clipboard, display, platform, and shell integration.

@sharpts/gui 0.0.0-local · SharpTS 7c6010104a43

Symbols

InterfaceDesktopDisplayBounds

Rectangle in physical desktop pixel coordinates.

InterfaceDesktopDisplayInfo

Native desktop display information.

InterfaceDesktopDisplaySize

Display size expressed in device-independent pixels.

InterfaceDesktopNotificationOptions

Options for showNotification.

InterfaceDesktopPlatformInfo

Operating-system and well-known directory information.

InterfaceDesktopTrayIcon

Live native tray icon owned by a DesktopApplication.

InterfaceDrawingDocument

Logical drawing document rendered by renderDrawingToPng.

Type aliasDrawingEffect

A validated effect applied in order while rasterizing a drawing document.

InterfaceDrawingFloodFillOptions

Options for a contiguous flood-fill operation.

Type aliasDrawingFloodFillResult

Result of a flood-fill operation.

InterfaceDrawingImage

A bounded PNG image produced by the desktop drawing renderer.

InterfaceDrawingLayer

One composited layer rendered by renderDrawingToPng.

InterfaceDrawingPixel

One pixel sampled from a rendered drawing document.

InterfaceFileFilter

Named file-extension pattern group used by native file dialogs.

FunctionfloodFillDrawing

Applies a contiguous, four-connected flood fill and returns a rasterized document image.

InterfaceFolderDialogOptions

Options for showFolderDialog.

FunctiongetDesktopDisplays

Returns information about connected desktop displays.

FunctiongetDesktopPlatformInfo

Returns operating-system, runtime, and well-known directory information.

FunctiongetImageDimensions

Reads pixel dimensions from a packaged asset, local file, or PNG data URI.

FunctiongetLaunchArguments

Returns command-line arguments supplied when the desktop application launched.

InterfaceImageDimensions

Dimensions reported for a supported image source.

InterfaceMessageDialogOptions

Options for showMessageDialog.

Type aliasMessageDialogResult

Button selected when a native message dialog closes.

FunctionopenExternal

Opens a URI or file with the operating system's default application.

InterfaceOpenFileDialogOptions

Options for showOpenFileDialog.

FunctionprintFile

Sends a local file to the operating system's print workflow.

FunctionreadClipboardText

Reads plain text from the desktop clipboard.

FunctionrenderDrawingToImage

Renders a validated drawing document to a bounded PNG data URI, optionally applying effects.

InterfaceRenderDrawingToImageOptions

Options for renderDrawingToImage.

FunctionrenderDrawingToPng

Renders a validated drawing document to a transparency-preserving PNG file.

FunctionsampleDrawingPixel

Samples one pixel from the fully composited drawing document.

InterfaceSaveFileDialogOptions

Options for showSaveFileDialog.

FunctionshowFolderDialog

Displays a native folder-selection dialog.

FunctionshowItemInFolder

Reveals a file or folder in the native file manager.

FunctionshowMessageDialog

Displays a native message dialog.

FunctionshowNotification

Displays a native desktop notification.

FunctionshowOpenFileDialog

Displays a native open-file dialog.

FunctionshowSaveFileDialog

Displays a native save-file dialog.

InterfaceTrayIconOptions

Options used to create or update a native tray icon.

InterfaceTrayMenuItem

Native tray menu entry.

FunctionwriteClipboardText

Writes plain text to the desktop clipboard.