Documentation
On this page

@sharpts/gui

Core and Composition

Elements, composition primitives, refs, events, and shared GUI types.

@sharpts/gui 0.0.0-local · SharpTS 7c6010104a43

Symbols

Type aliasBorderHandle

Opaque handle type for Border controls.

Type aliasButtonHandle

Opaque handle type for Button controls.

InterfaceCommonProps

Props shared by all built-in controls.

Type aliasComponent

Function component that returns GUI content.

Type aliasCustomControlComponent

Typed TSX tag for a packaged custom-control descriptor.

FunctiondefineCustomControl

Creates a typed TSX tag for a statically packaged managed custom-control descriptor.

Type aliasDesktopControlKind

Built-in native control kind that can be targeted by application styles.

InterfaceDesktopResourceReference

Reference to a named application resource.

Type aliasDesktopResourceValue

Literal value stored in an application resource dictionary.

InterfaceDesktopStyle

One application-level style rule.

InterfaceDesktopStyleSelector

Selects controls by native kind and optional style classes.

InterfaceDesktopStyleSetters

Values assigned when a DesktopStyle selector matches a control.

Type aliasDesktopStyleValue

Literal or resource-backed value assigned by a desktop style.

Type aliasDock

Edge used to place a child inside a DockPanel.

Type aliasDrawingCommand

Retained drawing command rendered by DrawingCanvas.

Type aliasDrawingCompositeMode

Supported drawing compositing operations.

Type aliasDrawingLineCap

Supported stroke end-cap shapes.

Type aliasDrawingLineJoin

Supported stroke join shapes.

InterfaceDrawingPoint

A logical point used by polyline drawing commands.

Type aliasDropEffect

Native drag-and-drop operation selected by a handler.

InterfaceDropEvent

Normalized native drag-and-drop event.

FunctionErrorBoundary

Restores the previous native tree and renders fallback content after a descendant fails.

InterfaceErrorBoundaryProps

Props accepted by ErrorBoundary.

ConstantFragment

Groups adjacent GUI children without creating a native control.

Type aliasGridHandle

Opaque handle type for Grid controls.

Type aliasGuiChild

Content accepted by component and control children.

InterfaceGuiElement

Immutable virtual element produced by TSX and consumed by the GUI renderer.

Type aliasHorizontalAlignment

Horizontal placement within a layout slot.

InterfaceKeyEvent

Normalized native keyboard event.

Type aliasOrientation

Direction in which a panel arranges its children.

Type aliasPointerButton

Button whose state changed for a pointer event.

InterfacePointerEvent

Normalized native pointer event in local device-independent coordinates.

Type aliasPointerType

Pointer device category reported by native desktop input.

InterfaceRichTextRun

An independently formatted run rendered by RichTextBlock.

Type aliasScrollBarVisibility

Policy controlling when a scroll bar is displayed.

Type aliasSelectionMode

Single- or multiple-item selection behavior.

Type aliasStackPanelHandle

Opaque handle type for StackPanel controls.

Type aliasStretch

Image scaling behavior within the available layout slot.

Type aliasTextBlockHandle

Opaque handle type for TextBlock controls.

Type aliasTextBoxHandle

Opaque handle type for TextBox controls.

Type aliasTextualChild

Text-compatible content accepted by controls such as TextBlock and Button.

InterfaceTextualChildArray

A nested array of textual control children.

Type aliasTheme

Window color theme.

Type aliasThickness

One, two, or four device-independent values describing edge thickness.

Type aliasVerticalAlignment

Vertical placement within a layout slot.

Type aliasWindowHandle

Opaque handle type for Window controls.

InterfaceWindowMetricsEvent

Coalesced post-layout metrics for the containing desktop window.

Type aliasWindowState

Native desktop window presentation state.