DirectSurface UIDirectSurface UI
开始使用
文档/API 参考

公共 API 索引

公共 API 由 ds-ui 包入口统一导出。业务项目应只从该入口导入：

import {  Application,  RenderButton,  RenderStackPanel,  RenderWindow,} from 'ds-ui' const row = new RenderStackPanel({ orientation: 'horizontal', spacing: 8 })row.addChild(new RenderButton({  label: '保存',  onClick: () => save(),})) const mainWindow = new RenderWindow({ title: '业务系统', chrome: 'none' })mainWindow.setChildren([row]) const host = Application.mount('#app').run(mainWindow)

其中 #app 必须指向已存在的 <canvas>。保存 .run() 返回的 AppHost，并在宿主卸载时调用 host.dispose()。

不要从 src/core/...、src/widgets/...、demo/src/... 或测试文件导入。未从包入口导出的对象都视为内部实现，可能随重构调整。

稳定性约定

范围 稳定性 说明
ds-ui 包入口导出的 class / function / type 公共 API 业务可以依赖。破坏性修改需要迁移说明。
当前版本正式文档中说明的 API 推荐 API 优先用于业务开发和长期维护。
demo 页面类、mock service、测试 helper 非公共 API 只用于演示和测试，不应被业务依赖。
未导出的内部 helper、私有字段、内部 render 对象 非公共 API 不承诺兼容。

公共 API 参考用于查边界；组件选型和详细用法见 Widgets API 参考 和 组件手册总览。

应用与宿主

API 类型 用途 参考
Application class 应用入口，组织 host、root render tree、服务和运行时生命周期。 快速开始
AppHost class Canvas 宿主和 runtime 绑定，提供当前 canvas 截图导出。 Runtime API
ApplicationRunOptions type 应用启动参数。 快速开始
AppOverlayService class 应用级 alert、confirm、prompt、modal、loading、宿主停靠窗口、性能浮层和诊断面板服务。 Popup 与 Overlay
RuntimeHost class 底层运行时宿主，管理 canvas、layer、事件、layout、paint、诊断和截图。 Runtime API
DirectSurfaceFontFamily enum/object 当前默认字体族常量。 主题与状态
loadDirectSurfaceFonts() function 等待当前字体集就绪并刷新文本测量缓存。 主题与状态

AppOverlayService 关联类型：

  • AppAlertDialogOptions
  • AppConfirmDialogOptions
  • AppLoadingHandle
  • AppLoadingOptions
  • AppLoadingTask
  • AppCanvasImageDownloadOptions
  • AppDockWindowController
  • AppDockWindowOptions
  • AppModalOptions
  • AppOverlayContextOptions
  • AppPerformanceOverlayController
  • AppOverlayServiceConsumer
  • AppPromptDialogOptions
  • AppRuntimeDebugController
  • RuntimeDockSide
  • RuntimeDockWindowOptions
  • RenderWindowHostDockHandlers
  • RenderWindowHostDockSide

运行时诊断

API 类型 用途 参考
RenderRuntimeDiagnosticsPanel class 运行时诊断面板，查看 render tree、layout、paint、性能、窗口和上下文。 运行时诊断面板
RenderRuntimeDiagnosticsSnapshotViewer class 离线诊断快照查看器。 运行时诊断面板
RuntimePerformanceMonitor class 采集帧性能、绘制请求、浮层统计。 绘制性能
LayoutInspectorService class 运行时布局检查服务。 运行时诊断面板
parseRuntimeDiagnosticsSnapshotJson() function 解析诊断快照 JSON。 运行时诊断面板
validateRuntimeDiagnosticsSnapshot() function 校验诊断快照结构。 运行时诊断面板
RuntimeDiagnosticsSnapshotValidationError class 诊断快照校验错误。 运行时诊断面板

常用诊断类型：

  • RuntimeDiagnosticsState
  • RuntimeDiagnosticsKindFilter
  • RuntimeDiagnosticsSourceFilter
  • RuntimeDiagnosticsViewMode
  • RuntimeDiagnosticsSnapshot
  • RuntimePaintRequestRecord
  • RuntimePaintRequestKind
  • RuntimePaintRequestSource
  • RuntimeFramePerformanceSample
  • RuntimePerformanceDebugState
  • RuntimePerformanceMonitorOptions
  • LayoutInspectorDebugState
  • LayoutInspectorTreeNode
  • RuntimeSize
  • RuntimeCaptureImageOptions
  • RuntimeCaptureRect

Core 基础设施

Render Object 和 Pipeline

API 类型 用途 参考
RenderObject class 所有 render object 的基础类。 RenderObject
PipelineOwner class 管理 layout、paint、dirty 队列和 app context。 渲染管线
PaintContext class 绘制上下文。 绘制与命中测试
constrainSize() function 根据约束收敛尺寸。 布局与约束
tightConstraints() function 创建紧约束。 布局与约束
looseConstraints() function 创建松约束。 布局与约束

常用类型：

  • BoxConstraints
  • LayoutContext
  • LayoutPassKind
  • Offset
  • Rect
  • Size
  • RenderLifecycleAware
  • RenderLoadedContext

焦点、输入和剪贴板

API 类型 用途 参考
FocusManager class 焦点管理器。 焦点与输入
FocusScope class 焦点作用域。 焦点与输入
FocusScopeType enum/object 焦点作用域类型。 焦点与输入
InputComposer class 文本输入、IME 和隐藏输入承接。 焦点与输入
ClipboardController class 统一复制控制。 选区和剪贴板
isCopyShortcut() function 判断复制快捷键。 选区和剪贴板
isCopyableSelection() function 判断是否为可复制选区。 选区和剪贴板

常用类型：

  • Focusable
  • InputSession
  • InputSessionToken
  • ClipboardTextWriter
  • CopyableSelection

App Context

API 类型 用途 参考
createAppContext() function 创建 app context。 App Context
createAppContextKey() function 创建强类型上下文 key。 App Context
AppContextKey class 上下文 key 类型。 App Context
AppContextRegistry class 上下文存储和父级查找。 App Context
APP_CONTEXT_PROVIDER symbol render object 提供上下文的协议 symbol。 App Context
isAppContextProvider() function 判断对象是否提供 app context。 App Context

常用类型：

  • AppContextInitialValues
  • AppContextLookupKey
  • AppContextProvider
  • AppContextSetOptions

Command

API 类型 用途 参考
CommandManager class 命令注册、求值、执行、权限、拦截器和订阅。 Commands API
CommandScope class 命令作用域。 Commands API
COMMAND_SCOPE_PROVIDER symbol render object 提供命令作用域的协议 symbol。 Commands API
commandManagerContextKey const 在 app context 中注入 CommandManager 的 key。 命令与权限
allowAllPermissionService const 默认全部放行的权限服务。 Commands API
isCommandScopeProvider() function 判断对象是否提供命令作用域。 Commands API
CommandShortcutController class 命令快捷键控制器。 Commands API
normalizeShortcut() function 标准化快捷键字符串。 Commands API
shortcutFromKeyboardEvent() function 从键盘事件生成快捷键字符串。 Commands API
commandShortcuts() function 读取命令快捷键数组。 Commands API

常用类型：

  • AppCommand
  • CommandState
  • CommandExecutionContext
  • CommandTrigger
  • CommandEvaluateOptions
  • CommandExecuteOptions
  • CommandInspection
  • CommandInterceptor
  • PermissionService
  • CommandShortcutControllerOptions
  • CommandShortcutSource

Store、Binding 和生命周期

API 类型 用途 参考
createStore() function 创建简单 store。 生命周期和销毁
Store class 响应式状态容器。 生命周期和销毁
BindingBag class 批量管理绑定和释放。 生命周期和销毁
bindSelector() function 绑定派生选择器。 生命周期和销毁
DisposableBag class 批量管理 disposer。 生命周期和销毁

常用类型：

  • Disposable
  • DisposeFn
  • ScheduleFn
  • ScheduleMode
API 类型 用途 参考
PopupManager class popup 打开、关闭、定位、重绘管理。 Popup 与 Overlay
OverlayInvalidator class overlay 重绘失效器。 Popup 与 Overlay
GET_POPUP_ANCHOR_RECT symbol 自定义 popup 锚点矩形协议。 Popup 与 Overlay
resolvePopupAnchorRect() function 解析 popup 锚点矩形。 Popup 与 Overlay
resolvePopupAnchorTarget() function 解析 popup 锚点目标。 Popup 与 Overlay
isScrollViewportClient() function 判断滚动视口客户端。 Popup 与 Overlay

常用类型：

  • Popup
  • PopupAnchorMode
  • PopupContext
  • PopupContextProvider
  • PopupOpenOptions
  • PopupViewport
  • PopupAnchor
  • PopupAnchorPlacement
  • PopupAnchorTarget
  • ScrollViewport
  • ScrollViewportClient

Layout 布局 API

API 类型 用途 参考
RenderBox class box render object 基础类。 布局与约束
RenderPanel class 原生支持 padding 的布局面板基类。 布局组件
RenderClip class 裁剪布局。 布局组件
RenderVisibility class 可见性包装。 布局组件
RenderAnchor class 锚点布局。 布局组件
RenderCanvas class 自定义绘制容器。 绘制与命中测试
RenderOverlayHost class 当前布局区域内的遮罩浮框宿主。 OverlayHost
RenderDockPanel class dock 布局。 布局组件
RenderGridPanel class 行列网格布局。 布局组件
RenderUniformGrid class 均匀网格。 布局组件
RenderStackPanel class 水平/垂直堆叠布局。 布局组件
RenderSpacer class flex 空白项。 布局组件
RenderWrapPanel class 自动换行布局。 布局组件
RenderMasonryPanel class 瀑布流布局。 布局组件
RenderAdaptiveGridPanel class 自适应网格布局。 布局组件
RenderAppContextScope class render tree 局部 app context。 App Context
RenderCommandScope class render tree 局部命令作用域。 命令与权限

布局 helper 和类型：

  • normalizeEdgeInsets()
  • gridAuto()、gridFr()、gridPx()、gridStar()
  • EdgeInsets、EdgeInsetsInput、EdgeInsetsInputObject
  • BoxAlignment、RenderBoxOptions、RenderPanelOptions
  • VisibilityMode
  • AnchorChildData
  • OverlayPanelOptions、RenderOverlayHostOptions
  • DockChildData、DockSide
  • GridPanelTrack、GridPanelChildData
  • Orientation、MainAxisAlignment、CrossAxisAlignment、StackPanelChildData
  • WrapAlignment、WrapCrossAlignment
  • MasonryHorizontalAlignment
  • AdaptiveGridPanelChildData
  • RenderAppContextScopeOptions
  • RenderCommandScopeOptions

主题、颜色和手势

主题

API 类型 用途 参考
rgba() function 创建颜色对象。 主题与状态
colorToCSS() function 颜色转 CSS 字符串。 主题与状态
lerpColor() function 颜色插值。 主题与状态
haveSameThemeMetrics() function 判断主题度量是否一致。 主题与状态
deriveWindowChromeStyle() function 计算窗口 chrome 样式 token。 主题与状态
mergeItemContainerStyle() function 合并 item 容器主题样式和实例级覆盖项。 ItemsControl
ImGuiLightTheme const 默认浅色主题。 主题与状态
ImGuiDarkTheme const 默认深色主题。 主题与状态
MedicalCompactLightTheme const 医疗编辑器紧凑浅色主题。 主题与状态
DefaultFontFamily const 默认字体。 主题与状态

常用类型：

  • Color
  • ThemeData
  • ThemeMetricKey
  • BadgeAppearance
  • BadgeStatus
  • BorderBackground
  • ButtonVariant
  • CardVariant
  • ItemContainerAppearance
  • ItemContainerStyleOverrides
  • StatusBarTextTone
  • WindowChromeStyleTokens

手势和事件

API 类型 用途 参考
HitTestResult class 命中测试结果。 事件路由
DispatchPhase enum/object 事件派发阶段。 事件路由
isPrimaryPointerButton() function 判断主按钮指针事件。 事件路由
EventDispatcher class 指针事件派发器。 事件路由

常用类型：

  • DispatchEvent
  • HitTestEntry
  • HitTestTarget
  • PointerEvent
  • WheelPointerEvent
  • InteractiveRenderObject
  • PointerDispatchDebugSnapshot

Widgets 组件

组件 API 很多，完整选型见 Widgets API 参考。本节只按公共导出边界列出主入口和关键类型。

基础和页面外壳

  • RenderScrollViewer、ScrollController
  • RenderBorder
  • RenderText、RenderParagraph
  • RenderButton、RenderCommandButton
  • RenderCard、RenderSection、RenderPage、RenderPageHeader
  • RenderWindow
  • RenderIcon、RenderIconButton、paintIconGlyph()
  • RenderBadge、measureBadgeLayout()、paintBadge()
  • RenderChip、measureChipLayout()、paintChip()
  • RenderDivider、RenderProgressBar、RenderEmpty、RenderGroupBox
  • RenderCollapsiblePanelGroup
  • RenderItemContainer
  • RenderItemsControl
  • RenderListView
  • RenderReviewSidebar

常用类型：

  • ScrollAxis、ScrollControllerOptions、ScrollDirection
  • RenderTextOptions、RenderTextOverflow、RenderTextRole
  • RenderCommandButtonOptions
  • RenderCardStyleOverrides
  • RenderPageOptions
  • RenderWindowOptions
  • IconName
  • BadgeLayoutMetrics
  • ChipLayoutMetrics
  • CollapsiblePanelSection
  • ItemTemplate
  • ItemContainerStyleOverrides
  • ItemsControlSelectionMode
  • ItemsControlVirtualizationOptions
  • ListViewItem
  • ReviewSidebarItem

输入、表单和选择器

  • RenderTextBox
  • RenderPasswordField
  • RenderSearchBox
  • RenderTextArea
  • RenderNumberInput
  • RenderDatePicker、DatePickerPopup
  • RenderCheckbox
  • RenderSwitch
  • RenderRadioGroup
  • RenderSlider
  • RenderSegmentedControl
  • RenderColorPicker、ColorPickerPopup
  • RenderFieldPresenter
  • RenderEntryGrid
  • RenderFormPanel
  • RenderComboBox、DropdownPopup
  • RenderMultiSelectDropdown、MultiSelectDropdownPopup
  • RenderLookupEdit
  • RenderDropTreeEdit
  • RenderDropCheckTreeEdit
  • RenderDropTreeGridEdit
  • RenderTreeView

常用类型和 helper：

  • FormFieldStatus
  • RadioOption
  • SegmentedControlOption
  • CalendarTime、CalendarTimePrecision、ISODate
  • LabeledFieldValidationDisplay
  • EntryGridTrack、EntryGridChildData
  • auto()、px()、fr()、fieldTrack()、labelTrack()、metaTrack()、unitTrack()、wideFieldTrack()
  • DropdownOption
  • LookupEditColumn、LookupEditQueryProcessor
  • DropTreeEditQueryProcessor、defaultDropTreeEditQueryProcessor()
  • DropCheckTreeEditQueryProcessor、DropCheckTreeEditSummaryBuilder
  • DropTreeGridEditQueryProcessor、defaultDropTreeGridEditQueryProcessor()
  • defaultLookupQueryProcessor()、defaultDropCheckTreeEditQueryProcessor()
  • TreeNode、TreeSelectionMode

数据组件

  • RenderDataGrid
  • RenderTreeGrid
  • RenderTable
  • RenderPagination

关键类型：

  • DataGridOptions
  • GridColumnDef
  • GridColumnText
  • GridColumnNumber
  • GridColumnCheckbox
  • GridColumnDate
  • GridColumnSelect
  • GridColumnSelectGrid
  • GridColumnCustom
  • GridColumnEditorDef
  • GridSelectionState
  • GridSelectionMode
  • GridSortState
  • GridFilterRule
  • GridSummaryDef
  • GridViewPreset
  • TreeGridNode
  • TreeGridOptions
  • TreeGridSelectionState
  • TableColumn
  • TableSortState

命令、工具栏和菜单

  • RenderToolbar
  • RenderCommandToolbar
  • createCommandContextMenu()
  • createCommandMenuBarItems()
  • executeCommandMenuSelection()
  • resolveCommandMenuEntries()

关键类型：

  • ToolbarGroup、ToolbarItem、ToolbarSlot
  • CommandToolbarGroup、CommandToolbarItem、RenderCommandToolbarOptions
  • CommandMenuItem、CommandMenuCommandItem、CommandMenuSubmenuItem
  • CommandMenuAdapterResult、CommandMenuBarAdapterResult

导航和工作区

  • RenderMenuBar
  • RenderNavigationMenu
  • RenderBreadcrumb
  • RenderTabs
  • RenderTabControl
  • RenderTabItem
  • RenderTabbedWorkspace
  • TabbedDocumentManager
  • RenderDockWorkspace
  • DockWindowManager
  • RenderSplitter
  • RenderStatusBar

关键类型：

  • MenuBarItem
  • NavigationMenuEntry
  • BreadcrumbItem
  • TabItem
  • RenderTabControlOptions
  • RenderTabItemOptions
  • TabbedDocumentDefinition
  • TabbedDocumentPatch
  • TabbedDocumentRecord
  • TabbedDocumentContext
  • TabbedDocumentContextAware
  • TabbedDocumentLifecycle
  • DockDropZone
  • DockDropScope
  • DockDropTarget
  • DockLayoutNode
  • DockTabGroupNode
  • DockSplitNode
  • DockOpenWindowOptions
  • DockWindowRecord
  • SplitDirection
  • StatusBarGroup

Overlay 和反馈

  • ContextMenuManager
  • NotificationManager
  • TooltipManager
  • TooltipService
  • TooltipTarget
  • RenderModal
  • RenderDrawer
  • RenderPopover
  • PopoverPopup
  • RenderLoadingHost
  • RenderLoadingModal
  • RenderPromptModal

关键类型：

  • ContextMenuEntry
  • ContextMenuItem
  • ContextMenuSeparator
  • NotificationType
  • TooltipContent
  • TooltipPresenter
  • ModalButton
  • DrawerSide
  • PopoverPlacement
  • RenderLoadingHostOptions
  • RenderLoadingModalOptions

可视化、文档和文本编辑

  • RenderLineChart
  • RenderBarChart
  • RenderDonutChart
  • RenderSparkline
  • RenderChartRangeSlider
  • paintFramePerformanceTimelineChart()
  • resolveFramePerformanceTimelineChartState()
  • RenderBarcode
  • barcodeToSvgVNode()
  • measureBarcode()
  • normalizeBarcodeType()
  • paintBarcode()
  • RenderImagePreview
  • parseMarkdown()
  • parseInlines()
  • markdownDocumentToPlainText()
  • markdownBlocksToPlainText()
  • markdownBlockToPlainText()
  • markdownInlinesToPlainText()
  • RenderMarkdownViewer
  • collectMarkdownDocumentHeadings()
  • createMarkdownHeadingSlug()
  • RenderPlainTextEditor
  • RenderCodeEditor
  • PlainTextEditorController
  • LineArrayTextDocument
  • FoldingModel
  • findJsonFoldRange()
  • plainTextTokenizer
  • jsonTextTokenizer
  • javascriptTextTokenizer
  • shellTextTokenizer
  • logTextTokenizer
  • tokenizerForLanguage()
  • RenderObjectInspector

关键类型：

  • ChartSeries
  • BarChartSeries
  • DonutChartSegment
  • ChartAxisOptions
  • ChartAxisType
  • ChartDataState
  • ChartDomain
  • ChartAnnotation
  • ChartLegendMode
  • ChartStackMode
  • ChartTooltipMode
  • ChartViewportChangeEvent
  • ChartWheelZoomModifier
  • BarChartOrientation
  • RenderLineChartOptions
  • RenderChartRangeSliderOptions
  • FramePerformanceTimelineChartOptions
  • BarcodeOptions
  • BarcodeType
  • ImagePreviewSource
  • ImagePreviewFit
  • ImagePreviewShape
  • ImagePreviewLoadState
  • ImagePreviewDebugState
  • MarkdownDocument
  • MarkdownBlock
  • MarkdownInline
  • RenderMarkdownViewerOptions
  • MarkdownViewerDebugState
  • RenderPlainTextEditorOptions
  • RenderCodeEditorOptions
  • CodeEditorLanguageAdapter
  • CodeEditorCodeAction
  • CodeEditorCodeActionKind
  • CodeEditorCompletionActivation
  • CodeEditorCompletionItem
  • CodeEditorCompletionKind
  • CodeEditorContextMenuRequest
  • CodeEditorDiagnostic
  • CodeEditorDiagnosticSeverity
  • CodeEditorHover
  • CodeEditorLocation
  • CodeEditorReference
  • CodeEditorSelectionRange
  • CodeEditorSemanticToken
  • CodeEditorTextEdit
  • MaybePromise
  • PlainTextEditorControllerOptions
  • TextDocumentModel
  • TextPosition
  • TextRange
  • TextToken
  • TextTokenizer
  • ObjectInspectorOptions

专业编辑器和病历绘制

API 类型 用途 参考
RenderMedicalRecordEditor class 电子病历编辑器 canvas 实时编辑实现。 病历编辑器集成
MedicalRecordEditorController class 病历编辑器外部控制器。 病历编辑器集成
DocumentCanvasPainter class 病历 canvas painter。 病历编辑器集成
CanvasPainterRegistry class 病历元素 painter 注册表。 病历编辑器集成
createDefaultCanvasPainterRegistry() function 创建默认 painter registry。 病历编辑器集成
defaultCanvasPainterRegistry const 默认 painter registry。 病历编辑器集成
SelectionRange class 病历选区范围类型。 病历编辑器集成

关键类型：

  • MedicalRecordDocument
  • RenderMedicalRecordEditorOptions
  • MedicalRecordEditorControllerOptions
  • MedicalRecordEditorDebugState
  • MedicalRecordToolbarState
  • MedicalRecordDocumentMode
  • MedicalRecordPageLayoutMode
  • MedicalRecordReviewFilter
  • MedicalRecordReviewStatusFilter
  • MedicalRecordReviewTypeFilter
  • CanvasElementPainter
  • CanvasPaintEvent
  • CanvasCompositionPreview
  • IRenderObject

病历编辑器内部模型较复杂。业务接入应通过 document、controller、options、命令入口和正式导出的 painter 扩展点，不建议操作未导出的医学编辑器内部类。

补充类型与 helper 索引

本节列出公共导出中较细的配置类型、事件类型、debug state 和 helper。它们通常在对应组件文档中展开，放在这里是为了让开发者能确认“这个名字是否属于公共 API”。

图表与可视化类型

  • BarChartCategoryLabelLayout
  • BarChartDebugState
  • BarcodeMetrics
  • ChartAnnotationAxis
  • ChartAnnotationBase
  • ChartAnnotationLabelPosition
  • ChartAnnotationLayout
  • ChartAnnotationLineStyle
  • ChartAnnotationType
  • ChartAxisLabelFormatter
  • ChartAxisLabelFormatterContext
  • ChartAxisRole
  • ChartBarLayout
  • ChartDecimationMode
  • ChartEventAnnotation
  • ChartLineAnnotation
  • ChartPadding
  • ChartPlotRect
  • ChartPoint
  • ChartPointLayout
  • ChartRangeAnnotation
  • ChartRangeSliderDebugState
  • ChartSegmentVisibilityChangeEvent
  • ChartSeriesVisibilityChangeEvent
  • ChartSeriesVisibilityChangeReason
  • ChartStateDebugState
  • ChartStateOptions
  • ChartTooltipDebugState
  • ChartTooltipItem
  • ChartViewportChangeReason
  • ChartX
  • DonutChartDebugState
  • DonutSegmentLayout
  • FramePerformanceTimelineChartDebugState
  • FramePerformanceTimelineRect
  • FramePerformanceTimelineSample
  • LineChartDebugState
  • SparklineDebugState
  • SparklineVariant

基础组件与主题类型

  • BorderAccentSide
  • CollapsiblePanelExpandedChange
  • CollapsiblePanelGroupDebugSection
  • CollapsiblePanelGroupResizeHandleDebugState
  • DividerAxis
  • ItemContainerState
  • ItemsControlItemMetrics
  • ItemsControlOrientation
  • ItemsControlScrollAlign
  • ItemsControlScrollMode
  • ItemsControlSelectionChange
  • MeasureBadgeOptions
  • MeasureChipOptions
  • PaintBadgeOptions
  • PaintChipOptions
  • PaintIconGlyphOptions
  • RenderCollapsiblePanelGroupOptions
  • RenderTextFit
  • RenderTextSize
  • RenderTextWeight
  • ReviewSidebarAction
  • ReviewSidebarItemType

命令与菜单类型

  • CommandExecutor
  • CommandInspectOptions
  • CommandMenuSeparatorItem
  • CommandPredicate
  • CommandReasonResolver
  • CommandScopeDiagnostic
  • CommandToolbarCommandItem
  • CommandToolbarSeparatorItem

表单、选择器与下拉类型

  • DropCheckTreeEditDebugState
  • DropCheckTreeEditExpandOnOpenContext
  • DropCheckTreeEditExpandedKeysResolver
  • DropCheckTreeEditQueryContext
  • DropCheckTreeEditQueryTextBuilder
  • DropCheckTreeEditSummaryContext
  • DropTreeEditDebugState
  • DropTreeEditExpandOnOpenContext
  • DropTreeEditExpandedKeysResolver
  • DropTreeEditQueryContext
  • DropTreeEditQueryTextBuilder
  • DropTreeGridEditDebugState
  • DropTreeGridEditExpandOnOpenContext
  • DropTreeGridEditExpandedKeysResolver
  • DropTreeGridEditQueryContext
  • DropTreeGridEditQueryTextBuilder
  • EntryGridEnterNavigation
  • EntryGridTrackOptions
  • EntryGridValidationPresentation
  • FormPanelChildData
  • LabeledFieldLabelOverflow
  • LabeledFieldMetaTone
  • LookupEditDebugState
  • LookupEditQueryContext
  • LookupEditQueryResult
  • defaultLookupQueryProcessor
  • defaultDropCheckTreeEditQueryProcessor

GridView 与 TreeGrid 类型

  • GridCellDisplayTextArgs
  • GridCellContext
  • GridCellEditPolicy
  • GridCellEditState
  • GridCellErrorState
  • GridCellStyleArgs
  • GridCellStyleOverride
  • GridCellTextOverflow
  • GridCellValidationArgs
  • GridCellValidationResult
  • GridColumnBase
  • GridColumnEditorCheckbox
  • GridColumnEditorDate
  • GridColumnEditorDropTree
  • GridColumnEditorDropTreeGrid
  • GridColumnEditorKind
  • GridColumnEditorLookup
  • GridColumnEditorNumber
  • GridColumnEditorSelect
  • GridColumnEditorText
  • GridColumnFilterState
  • GridColumnState
  • GridColumnWidthMode
  • GridDataState
  • GridDropTreeExpandedKeysResolver
  • GridDropTreeGridExpandedKeysResolver
  • GridDropTreeGridQueryContext
  • GridDropTreeGridQueryProcessor
  • GridDropTreeGridQueryTextBuilder
  • GridDropTreeQueryContext
  • GridDropTreeQueryProcessor
  • GridDropTreeQueryTextBuilder
  • GridFilterOperator
  • GridGroupDef
  • GridGroupDisplayTextArgs
  • GridLookupQueryContext
  • GridLookupQueryProcessor
  • GridLookupQueryResult
  • GridRangeSelectionInput
  • GridRowEvent
  • GridRowEventInput
  • GridRowId
  • GridRowKey
  • GridRowStyleArgs
  • GridRowStyleOverride
  • GridSelectionCell
  • GridSelectionChangeEvent
  • GridSelectionOptions
  • GridSelectionRange
  • GridSortDescriptor
  • GridSortOrder
  • GridSummaryAggregate
  • TreeCheckChange
  • TreeGridCell
  • TreeGridCellDisplayTextArgs
  • TreeGridCellStyleArgs
  • TreeGridCheckChange
  • TreeGridNodeInput
  • TreeGridRowStyleArgs
  • TreeGridSelectionMode
  • TreeLabelToken
  • TreeLabelTokenKind

Markdown 与纯文本编辑类型

  • MarkdownBlockquoteBlock
  • MarkdownCodeBlock
  • MarkdownDeleteInline
  • MarkdownDocumentHeadingItem
  • MarkdownEmphasisInline
  • MarkdownFlavor
  • MarkdownHardBreakInline
  • MarkdownHeadingBlock
  • MarkdownHeadingOutlineItem
  • MarkdownHtmlBlock
  • MarkdownHtmlInline
  • MarkdownImageInline
  • MarkdownLinkClickEvent
  • MarkdownLinkInline
  • MarkdownLinkReference
  • MarkdownListBlock
  • MarkdownListItem
  • MarkdownParagraphBlock
  • MarkdownParseOptions
  • MarkdownSearchResult
  • MarkdownSoftBreakInline
  • MarkdownStrongInline
  • MarkdownTableAlignment
  • MarkdownTableBlock
  • MarkdownTextInline
  • MarkdownThematicBreakBlock
  • MarkdownViewerCodeBlockDebugState
  • MarkdownViewerTableDebugState
  • MarkdownViewerViewportState
  • ObjectInspectorDebugNode
  • PlainTextEditorChange
  • PlainTextFindOptions
  • PlainTextSearchMatch
  • PlainTextSearchOptions
  • TextEditResult
  • clampPosition
  • comparePositions
  • lineIntersectsSelection
  • normalizeRange
  • positionEquals

Runtime、Popup、导航和工作区类型

  • LayoutInspectorAppContextEntry
  • LayoutInspectorListener
  • NavigationMenuGroup
  • NavigationMenuItem
  • NavigationMenuItemStatus
  • OverlayPaintInvalidator
  • PerformanceOverlayPosition
  • PopupPaintInvalidator
  • RenderWindowChrome
  • RenderWindowPresentation
  • RuntimeDiagnosticsAppContextEntry
  • RuntimeDiagnosticsEnvironmentSnapshot
  • RuntimeDiagnosticsHotspot
  • RuntimeDiagnosticsLayerSnapshot
  • RuntimeDiagnosticsLayoutInspectorSnapshot
  • RuntimeDiagnosticsPanelDebugState
  • RuntimeDiagnosticsPerformanceSnapshot
  • RuntimeDiagnosticsRenderTreeNode
  • RuntimeDiagnosticsRuntimeSnapshot
  • RuntimeDiagnosticsSnapshotSectionData
  • RuntimeDiagnosticsSnapshotViewerDebugState
  • RuntimeDiagnosticsWindowSnapshot
  • StatusBarAlign
  • StatusBarItem
  • TabContextMenuHandler
  • TabDragHandler

表格、病历和其他专业类型

  • MedicalRecordCellBorderCommand
  • MedicalRecordPaperOrientation
  • MedicalRecordParagraphNumberType
  • MedicalRecordTableCellDiagonal
  • SortOrder
  • TableSortOrder

导入建议

推荐：

import {  CommandManager,  RenderCommandToolbar,  RenderDataGrid,  RenderStackPanel,  type GridColumnDef,} from 'ds-ui'

不推荐：

import { RenderDataGrid } from './src/widgets/grid_view'

原因：

  • 内部文件路径可能调整。
  • 包入口会明确哪些类型是公共 API。
  • 正式文档和示例都以包入口为准。

版本升级边界

  • 业务代码始终从 ds-ui 包入口导入，避免内部文件调整影响升级。
  • 公共 API 被弃用、改名或移除时，以对应版本的迁移说明为准。
  • 未从包入口导出的类型属于内部实现，即使能在源码中找到，也不构成兼容性承诺。
  • 具体组件的参数、事件和行为边界继续查阅 Widgets API 参考与对应组件文档。