Skip to content

组件 Props / Events(自动生成)

此文件由 packages/tui/scripts/generate-component-api-docs.ts 自动生成,请勿手改。

目录

TAnchor

源码:src/vue/components/TAnchor.ts

Props

名称类型默认值必填说明
leftnumberundefined
topnumberundefined
rightnumberundefined
bottomnumberundefined
wnumberundefined
hnumberundefined
zIndexnumber0
focusablebooleanfalse
selectablebooleanundefined

Events

名称Payload说明
clickCapture
click
dblclickCapture
dblclick
pointerdownCapture
pointerdown
pointerupCapture
pointerup
pointermoveCapture
pointermove
wheelCapture
wheel
keydownCapture
keydown
keyupCapture
keyup
focusCapture
focus
blurCapture
blur

TBox

源码:src/vue/components/TBox.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
borderbooleantrue
titlestring""
paddingnumber0
scrollXnumber0
scrollYnumber0
styleStyleundefined
titleStyleStyleundefined
clearbooleantrue

Events

名称Payload说明
pointerenterCapture
pointerenter
pointerleaveCapture
pointerleave

TDebugOverlay

源码:src/vue/components/TDebugOverlay.ts

Props

名称类型默认值必填说明
mode"focus" | "all""focus"
panelbooleantrue
maxRectsnumber40
zIndexnumber90

Events

TDialog

源码:src/vue/components/TDialog.ts

Props

名称类型默认值必填说明
modelValueboolean
wnumber
hnumber
titlestring""
paddingnumber1
zIndexnumber1000
styleStyleundefined
titleStyleStyleundefined
contentStyleStyleundefined
backdropStyleStyleundefined
placementPlacement"center"
offsetXnumber0
offsetYnumber0
backdropbooleantrue
closeOnBackdropbooleantrue
closeOnEscbooleantrue
closeOnBlurbooleanfalse
teleportbooleanfalse
tabMode"cycle" | "wrapFromButtons""cycle"
buttonsDialogButton[]() => []
closeOnConfirmbooleantrue

Events

名称Payload说明
update:modelValue
close
focus
blur
keydown
confirm

TerminalProvider

源码:src/vue/components/TerminalProvider.ts

Props

名称类型默认值必填说明
colsnumber
rowsnumber
defaultStyleStyle() => ({})
autoResizebooleanfalse
minColsnumber1
minRowsnumber1
recordEvents((e: TerminalEventRecord) => void) | undefinedundefined
inputPluginsreadonly TInputPlugin[]() => [defaultTInputHostPlugin]
pathPickerProviderPathPickerProviderundefined
debugImebooleanfalse
debugTracebooleanfalse
domRendererOptionsDomRendererOptionsundefined

Events

TFlow

源码:src/vue/components/TFlow.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
itemsunknown[]
directionDirection"vertical"
gapnumber0
itemSizenumber1
zIndexnumber0

Events

TInput

源码:src/vue/components/TInput.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber1
zIndexnumber0
modelValuestring
cursorToEndOnExternalUpdatebooleanfalse
cursorToEndOnFirstFocusbooleanfalse
placeholderstring""
placeholderWhenFocusedbooleanfalse
styleStyleundefined
autoFocusbooleanfalse
cursorBlinkbooleantrue
cursorShape"block" | "underline" | "bar""block"
blinkIntervalnumber500
promptSuggestionsreadonly PromptSuggestion[]() => []
promptTriggerstring"/"
promptTriggersreadonly string[]undefined
promptMaxItemsnumber6
promptAlign"input" | "center""input"
promptSelectedStyleStyleundefined
promptPopupStyleStyleundefined
promptPopupBorderStyleStyleundefined
promptPopupMatchStyleStyleundefined
skillTriggerstring""
skillSuggestionsreadonly PromptSuggestion[]undefined
skillHighlightStyleStyleundefined
mentionTriggerstring"@"
mentionWorkspacestring""
mentionModePathPickMode"file"
mentionShowHiddenbooleanfalse
mentionSuggestionsreadonly PromptSuggestion[]() => []
mentionMaxItemsnumber8
mentionChipStyleStyleundefined
multilineChipStyleStyleundefined
dedupeMentionsbooleantrue
collectMentionsbooleanfalse
mentionsreadonly string[]() => []
collapseMultilinebooleanfalse
multilineTextsreadonly string[]() => []
secretbooleanfalse
maskCharstring"•"
submitOnEnterbooleantrue
clearOnEscapebooleanfalse
pluginsreadonly TInputPlugin[]() => []
pasteImageHandler() => Promise<string | null> | string | nullundefined
filePasteHandler(absPath: string) => Promise<string | null> | string | nullundefined

Events

名称Payload说明
update:modelValue
input
change
keydown
focus
blur
pointerenter
pointerleave
update:mentions
mentionClick
update:multilineTexts
multilineClick
validationError

TInputBox

源码:src/vue/components/TInputBox.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
titlestring""
paddingnumber0
modelValuestring
placeholderstring""
styleStyleundefined
autoFocusbooleanfalse
pluginsreadonly TInputPlugin[]() => []
cursorBlinkbooleantrue
cursorShape"block" | "underline" | "bar""block"
blinkIntervalnumber500

Events

名称Payload说明
update:modelValue
input
change
keydown
focus
blur

TJsonEditor

源码:src/vue/components/TJsonEditor.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber8
zIndexnumber0
modelValuestring
placeholderstring""
styleStyleundefined
showIndentGuidesbooleantrue
indentSizenumber2
guideColorsreadonly AnsiColorName[]() => [...DEFAULT_GUIDE_COLORS]
autoFocusbooleanfalse
cursorToEndOnFirstFocusbooleantrue
cursorToEndOnExternalUpdatebooleantrue
submitOnEnterbooleanfalse

Events

名称Payload说明
update:modelValue
keydown
focus
blur
undo
redo
lintChange
validationError

TList

源码:src/vue/components/TList.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
itemsstring[]
itemVersionnumber0
modelValuenumber0
styleStyleundefined
autoFocusbooleanfalse
closeOnBlurbooleanfalse

Events

名称Payload说明
update:modelValue
change
scroll
close
focus
blur
keydown

TLogLinksPanel

源码:src/vue/components/TLogLinksPanel.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
linksreadonly TLogLinkPanelItem[]() => []
activeIndexnumber-1
styleStyleundefined
activeStyleStyle() => ({ inverse: true })
currentStyleStyle() => ({ bold: true })
hrefStyleStyle() => ({ underline: true })
disabledStyleStyle() => ({ dim: true })
showLineNumbersbooleantrue
showHrefbooleantrue
focusablebooleantrue

Events

名称Payload说明
select
activate
activeChange
focus
blur
keydown

TLogMinimap

源码:src/vue/components/TLogMinimap.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
metricsTLogMinimapMetrics | nullnull
markersreadonly TLogMinimapMarker[]() => []
densityreadonly TLogMinimapDensityBucket[]() => []
styleStyleundefined
densityStyleStyleundefined
markerStyleStyleundefined
currentMarkerStyleStyleundefined
viewportStyleStyleundefined
estimatedStyleStyleundefined
showMarkersbooleantrue
showDensitybooleantrue
showViewportbooleantrue

Events

名称Payload说明
scrollTo
markerClick

TLogScrollbar

源码:src/vue/components/TLogScrollbar.ts

Props

名称类型默认值必填说明
xnumber
ynumber
hnumber
zIndexnumber0
metricsTLogScrollbarMetrics | nullnull
styleStyleundefined
thumbStyleStyleundefined
trackStyleStyleundefined
measuringStyleStyleundefined
markersreadonly TLogScrollbarMarker[]() => []
markerStyleStyle() => ({ fg: "yellowBright" })
currentMarkerStyleStyle() => ({ fg: "redBright", bold: true })
showMarkersbooleantrue
showArrowsbooleanfalse

Events

名称Payload说明
scrollTo
scrollBy
markerClick

TLogSearchBar

源码:src/vue/components/TLogSearchBar.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
zIndexnumber0
stateTLogSearchBarState
placeholderstring"Search…"
styleStyleundefined
inputStyleStyleundefined
activeStyleStyle() => ({ inverse: true })
errorStyleStyle() => ({ fg: "redBright", bold: true })
disabledStyleStyle() => ({ dim: true })
toggleStyleStyleundefined
focusablebooleantrue
showModeTogglebooleantrue
showCaseTogglebooleantrue
showWholeWordTogglebooleantrue
showCountbooleantrue
showNavigationbooleantrue

Events

名称Payload说明
update
update:query
update:mode
update:caseSensitive
update:wholeWord
previous
next
clear
focus
blur
keydown

TLogSearchPager

源码:src/vue/components/TLogSearchPager.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
zIndexnumber0
stateTLogSearchPagerState | nullnull
styleStyleundefined
activeStyleStyleundefined
disabledStyleStyle() => ({ dim: true })
errorStyleStyle() => ({ fg: "redBright", bold: true })
showCountbooleantrue

Events

名称Payload说明
previousPage
nextPage
pageChange

TLogSearchResults

源码:src/vue/components/TLogSearchResults.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
resultsreadonly TLogSearchResultItem[]() => []
activeIndexnumber-1
styleStyleundefined
activeStyleStyle() => ({ inverse: true })
matchStyleStyle() => ({ underline: true })
currentStyleStyle() => ({ bold: true })
showLineNumbersbooleantrue
focusablebooleantrue

Events

名称Payload说明
select
activeChange
keydown
focus
blur

TLogView

源码:src/vue/components/TLogView.ts

Experimental import: @simon_he/vue-tui/experimental

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
sourceTLogDataSource
versionnumber
scrollTopnumberundefined
defaultScrollTopnumberundefined
styleStyleundefined
autoFocusbooleanfalse
autoStickToBottombooleantrue
overscannumber2
wrapbooleanfalse
visualIndexMode"estimated" | "exact""estimated"
visualIndexOptionsTLogViewVisualIndexOptionsundefined
ansibooleanfalse
linksbooleanfalse
linkStyleStyle() => ({ underline: true })
keyboardLinksbooleanfalse
linkFocusStyleStyle() => ({ inverse: true })
searchQuerystring""
searchOptionsTLogViewSearchOptionsundefined
highlightMatchesbooleantrue
matchStyleStyle() => ({ inverse: true })
currentMatchStyleStyle() => ({ inverse: true, bold: true })
rowScrollModeRowScrollMode"off"

Events

名称Payload说明
scroll
update:scrollTop
update:searchQuery
search
searchMatch
searchMarkers
linkClick
linkFocus
linkActivate
visualIndex
focus
blur
keydown

TLogVirtualLinksPanel

源码:src/vue/components/TLogVirtualLinksPanel.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
linksreadonly TLogLinkPanelItem[]() => []
modelValuenumber-1
styleStyleundefined
activeStyleStyleundefined
showLineNumbersbooleantrue
rowScrollModeRowScrollMode"off"

Events

名称Payload说明
update:modelValue
activeChange
select
activate
focus
blur
keydown
scroll

TLogVirtualSearchResults

源码:src/vue/components/TLogVirtualSearchResults.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
itemCountnumber
itemVersionnumber
getItem(index: number) => TLogSearchResultItem | null
modelValuenumber-1
styleStyleundefined
activeStyleStyleundefined
showLineNumbersbooleantrue
rowScrollModeRowScrollMode"off"

Events

名称Payload说明
update:modelValue
activeChange
select
focus
blur
keydown
scroll

TMultilineModal

源码:src/vue/components/TMultilineModal.ts

Props

名称类型默认值必填说明
visibleboolean
contentstring
titlestring"Multiline Text"
styleStyleundefined
zIndexnumber1000

Events

名称Payload说明
close

TPathPicker

源码:src/vue/components/TPathPicker.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
workspacestring
modePathPickMode"any"
modelValuestring
placeholderstring""
styleStyleundefined
inputStyleStyleundefined
activeStyleStyleundefined
matchStyleStyleundefined
autoFocusbooleanfalse
showHiddenbooleanfalse
maxSuggestionsnumber50
providerPathPickerProviderundefined

Events

名称Payload说明
update:modelValue
select
invalid
keydown
focus
blur

TRenderLayer

源码:src/vue/components/TRenderLayer.ts

Props

名称类型默认值必填说明
zIndexnumber0

Events

TRenderPlane

源码:src/vue/components/TRenderPlane.ts

Props

名称类型默认值必填说明
planeTerminalRenderPlane"default"

Events

TRouterView

源码:src/vue/router/RouterView.ts

Props

名称类型默认值必填说明
routesTerminalRouteRecord[]
forceRemountbooleantrue

Events

TSelect

源码:src/vue/components/TSelect.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
optionsSelectOption[]
modelValuenumber | number[]0
multiplebooleanfalse
multipleEmitTSelectMultipleEmitMode"value"
styleStyleundefined
highlightStyleStyleundefined
matchStyleStyleundefined
highlightMatchStyleStyleundefined
autoFocusbooleanfalse
closeOnBlurbooleanfalse

Events

名称Payload说明
update:modelValue
change
confirm
close
focus
blur
keydown

TText

源码:src/vue/components/TText.ts

Props

名称类型默认值必填说明
xnumber
ynumber
zIndexnumber0
valuestring
wnumberundefined
hnumberundefined
styleStyleundefined
clearbooleantrue
wrapbooleanfalse
depsKeyunknownundefinedOptional key that participates in render-node dependency tracking.
Useful for forcing a repaint when the rendered output might change
even if value, style, and geometry are unchanged (e.g. external
terminal writes or higher-level virtualized row reuse).

Events

TTransition

源码:src/vue/components/TTransition.ts

Props

名称类型默认值必填说明
showboolean
durationnumber200
beforeEnterTransitionHookundefined
enterTransitionHookundefined
afterEnterTransitionHookundefined
beforeLeaveTransitionHookundefined
leaveTransitionHookundefined
afterLeaveTransitionHookundefined

Events

TView

源码:src/vue/components/TView.ts

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
scrollXnumber0
scrollYnumber0
focusablebooleanfalse
selectablebooleanundefined
autoFocusbooleanfalse

Events

名称Payload说明
clickCapture
click
dblclickCapture
dblclick
pointerdownCapture
pointerdown
pointerupCapture
pointerup
pointermoveCapture
pointermove
pointerenterCapture
pointerenter
pointerleaveCapture
pointerleave
wheelCapture
wheel
keydownCapture
keydown
keyupCapture
keyup
focusCapture
focus
blurCapture
blur

TVirtualList

源码:src/vue/components/TVirtualList.ts

Experimental import: @simon_he/vue-tui/experimental

Props

名称类型默认值必填说明
xnumber
ynumber
wnumber
hnumber
zIndexnumber0
itemCountnumber
itemVersionnumber
getItem(index: number) => unknown
renderItem(item: unknown, index: number) => unknownundefined
modelValuenumber0
scrollTopnumberundefined
styleStyleundefined
activeStyleStyleundefined
autoFocusbooleanfalse
rowScrollModeRowScrollMode"off"

Events

名称Payload说明
update:modelValue
update:scrollTop
change
itemClick
scroll
focus
blur
keydown

Bug reports, feature requests, and documentation issues are tracked on GitHub Issues.