组件 Props / Events(自动生成)
此文件由
packages/tui/scripts/generate-component-api-docs.ts自动生成,请勿手改。
目录
- TAnchor
- TBox
- TDebugOverlay
- TDialog
- TerminalProvider
- TFlow
- TInput
- TInputBox
- TJsonEditor
- TList
- TLogLinksPanel
- TLogMinimap
- TLogScrollbar
- TLogSearchBar
- TLogSearchPager
- TLogSearchResults
- TLogView
- TLogVirtualLinksPanel
- TLogVirtualSearchResults
- TMultilineModal
- TPathPicker
- TRenderLayer
- TRenderPlane
- TRouterView
- TSelect
- TText
- TTransition
- TView
- TVirtualList
TAnchor
源码:src/vue/components/TAnchor.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
left | number | undefined | 否 | — |
top | number | undefined | 否 | — |
right | number | undefined | 否 | — |
bottom | number | undefined | 否 | — |
w | number | undefined | 否 | — |
h | number | undefined | 否 | — |
zIndex | number | 0 | 否 | — |
focusable | boolean | false | 否 | — |
selectable | boolean | undefined | 否 | — |
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
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
border | boolean | true | 否 | — |
title | string | "" | 否 | — |
padding | number | 0 | 否 | — |
scrollX | number | 0 | 否 | — |
scrollY | number | 0 | 否 | — |
style | Style | undefined | 否 | — |
titleStyle | Style | undefined | 否 | — |
clear | boolean | true | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
pointerenterCapture | — | — |
pointerenter | — | — |
pointerleaveCapture | — | — |
pointerleave | — | — |
TDebugOverlay
源码:src/vue/components/TDebugOverlay.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
mode | "focus" | "all" | "focus" | 否 | — |
panel | boolean | true | 否 | — |
maxRects | number | 40 | 否 | — |
zIndex | number | 90 | 否 | — |
Events
—
TDialog
源码:src/vue/components/TDialog.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
modelValue | boolean | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
title | string | "" | 否 | — |
padding | number | 1 | 否 | — |
zIndex | number | 1000 | 否 | — |
style | Style | undefined | 否 | — |
titleStyle | Style | undefined | 否 | — |
contentStyle | Style | undefined | 否 | — |
backdropStyle | Style | undefined | 否 | — |
placement | Placement | "center" | 否 | — |
offsetX | number | 0 | 否 | — |
offsetY | number | 0 | 否 | — |
backdrop | boolean | true | 否 | — |
closeOnBackdrop | boolean | true | 否 | — |
closeOnEsc | boolean | true | 否 | — |
closeOnBlur | boolean | false | 否 | — |
teleport | boolean | false | 否 | — |
tabMode | "cycle" | "wrapFromButtons" | "cycle" | 否 | — |
buttons | DialogButton[] | () => [] | 否 | — |
closeOnConfirm | boolean | true | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update:modelValue | — | — |
close | — | — |
focus | — | — |
blur | — | — |
keydown | — | — |
confirm | — | — |
TerminalProvider
源码:src/vue/components/TerminalProvider.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
cols | number | — | 是 | — |
rows | number | — | 是 | — |
defaultStyle | Style | () => ({}) | 否 | — |
autoResize | boolean | false | 否 | — |
minCols | number | 1 | 否 | — |
minRows | number | 1 | 否 | — |
recordEvents | ((e: TerminalEventRecord) => void) | undefined | undefined | 否 | — |
inputPlugins | readonly TInputPlugin[] | () => [defaultTInputHostPlugin] | 否 | — |
pathPickerProvider | PathPickerProvider | undefined | 否 | — |
debugIme | boolean | false | 否 | — |
debugTrace | boolean | false | 否 | — |
domRendererOptions | DomRendererOptions | undefined | 否 | — |
Events
—
TFlow
源码:src/vue/components/TFlow.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
items | unknown[] | — | 是 | — |
direction | Direction | "vertical" | 否 | — |
gap | number | 0 | 否 | — |
itemSize | number | 1 | 否 | — |
zIndex | number | 0 | 否 | — |
Events
—
TInput
源码:src/vue/components/TInput.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | 1 | 否 | — |
zIndex | number | 0 | 否 | — |
modelValue | string | — | 是 | — |
cursorToEndOnExternalUpdate | boolean | false | 否 | — |
cursorToEndOnFirstFocus | boolean | false | 否 | — |
placeholder | string | "" | 否 | — |
placeholderWhenFocused | boolean | false | 否 | — |
style | Style | undefined | 否 | — |
autoFocus | boolean | false | 否 | — |
cursorBlink | boolean | true | 否 | — |
cursorShape | "block" | "underline" | "bar" | "block" | 否 | — |
blinkInterval | number | 500 | 否 | — |
promptSuggestions | readonly PromptSuggestion[] | () => [] | 否 | — |
promptTrigger | string | "/" | 否 | — |
promptTriggers | readonly string[] | undefined | 否 | — |
promptMaxItems | number | 6 | 否 | — |
promptAlign | "input" | "center" | "input" | 否 | — |
promptSelectedStyle | Style | undefined | 否 | — |
promptPopupStyle | Style | undefined | 否 | — |
promptPopupBorderStyle | Style | undefined | 否 | — |
promptPopupMatchStyle | Style | undefined | 否 | — |
skillTrigger | string | "" | 否 | — |
skillSuggestions | readonly PromptSuggestion[] | undefined | 否 | — |
skillHighlightStyle | Style | undefined | 否 | — |
mentionTrigger | string | "@" | 否 | — |
mentionWorkspace | string | "" | 否 | — |
mentionMode | PathPickMode | "file" | 否 | — |
mentionShowHidden | boolean | false | 否 | — |
mentionSuggestions | readonly PromptSuggestion[] | () => [] | 否 | — |
mentionMaxItems | number | 8 | 否 | — |
mentionChipStyle | Style | undefined | 否 | — |
multilineChipStyle | Style | undefined | 否 | — |
dedupeMentions | boolean | true | 否 | — |
collectMentions | boolean | false | 否 | — |
mentions | readonly string[] | () => [] | 否 | — |
collapseMultiline | boolean | false | 否 | — |
multilineTexts | readonly string[] | () => [] | 否 | — |
secret | boolean | false | 否 | — |
maskChar | string | "•" | 否 | — |
submitOnEnter | boolean | true | 否 | — |
clearOnEscape | boolean | false | 否 | — |
plugins | readonly TInputPlugin[] | () => [] | 否 | — |
pasteImageHandler | () => Promise<string | null> | string | null | undefined | 否 | — |
filePasteHandler | (absPath: string) => Promise<string | null> | string | null | undefined | 否 | — |
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
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
title | string | "" | 否 | — |
padding | number | 0 | 否 | — |
modelValue | string | — | 是 | — |
placeholder | string | "" | 否 | — |
style | Style | undefined | 否 | — |
autoFocus | boolean | false | 否 | — |
plugins | readonly TInputPlugin[] | () => [] | 否 | — |
cursorBlink | boolean | true | 否 | — |
cursorShape | "block" | "underline" | "bar" | "block" | 否 | — |
blinkInterval | number | 500 | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update:modelValue | — | — |
input | — | — |
change | — | — |
keydown | — | — |
focus | — | — |
blur | — | — |
TJsonEditor
源码:src/vue/components/TJsonEditor.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | 8 | 否 | — |
zIndex | number | 0 | 否 | — |
modelValue | string | — | 是 | — |
placeholder | string | "" | 否 | — |
style | Style | undefined | 否 | — |
showIndentGuides | boolean | true | 否 | — |
indentSize | number | 2 | 否 | — |
guideColors | readonly AnsiColorName[] | () => [...DEFAULT_GUIDE_COLORS] | 否 | — |
autoFocus | boolean | false | 否 | — |
cursorToEndOnFirstFocus | boolean | true | 否 | — |
cursorToEndOnExternalUpdate | boolean | true | 否 | — |
submitOnEnter | boolean | false | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update:modelValue | — | — |
keydown | — | — |
focus | — | — |
blur | — | — |
undo | — | — |
redo | — | — |
lintChange | — | — |
validationError | — | — |
TList
源码:src/vue/components/TList.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
items | string[] | — | 是 | — |
itemVersion | number | 0 | 否 | — |
modelValue | number | 0 | 否 | — |
style | Style | undefined | 否 | — |
autoFocus | boolean | false | 否 | — |
closeOnBlur | boolean | false | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update:modelValue | — | — |
change | — | — |
scroll | — | — |
close | — | — |
focus | — | — |
blur | — | — |
keydown | — | — |
TLogLinksPanel
源码:src/vue/components/TLogLinksPanel.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
links | readonly TLogLinkPanelItem[] | () => [] | 否 | — |
activeIndex | number | -1 | 否 | — |
style | Style | undefined | 否 | — |
activeStyle | Style | () => ({ inverse: true }) | 否 | — |
currentStyle | Style | () => ({ bold: true }) | 否 | — |
hrefStyle | Style | () => ({ underline: true }) | 否 | — |
disabledStyle | Style | () => ({ dim: true }) | 否 | — |
showLineNumbers | boolean | true | 否 | — |
showHref | boolean | true | 否 | — |
focusable | boolean | true | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
select | — | — |
activate | — | — |
activeChange | — | — |
focus | — | — |
blur | — | — |
keydown | — | — |
TLogMinimap
源码:src/vue/components/TLogMinimap.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
metrics | TLogMinimapMetrics | null | null | 否 | — |
markers | readonly TLogMinimapMarker[] | () => [] | 否 | — |
density | readonly TLogMinimapDensityBucket[] | () => [] | 否 | — |
style | Style | undefined | 否 | — |
densityStyle | Style | undefined | 否 | — |
markerStyle | Style | undefined | 否 | — |
currentMarkerStyle | Style | undefined | 否 | — |
viewportStyle | Style | undefined | 否 | — |
estimatedStyle | Style | undefined | 否 | — |
showMarkers | boolean | true | 否 | — |
showDensity | boolean | true | 否 | — |
showViewport | boolean | true | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
scrollTo | — | — |
markerClick | — | — |
TLogScrollbar
源码:src/vue/components/TLogScrollbar.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
metrics | TLogScrollbarMetrics | null | null | 否 | — |
style | Style | undefined | 否 | — |
thumbStyle | Style | undefined | 否 | — |
trackStyle | Style | undefined | 否 | — |
measuringStyle | Style | undefined | 否 | — |
markers | readonly TLogScrollbarMarker[] | () => [] | 否 | — |
markerStyle | Style | () => ({ fg: "yellowBright" }) | 否 | — |
currentMarkerStyle | Style | () => ({ fg: "redBright", bold: true }) | 否 | — |
showMarkers | boolean | true | 否 | — |
showArrows | boolean | false | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
scrollTo | — | — |
scrollBy | — | — |
markerClick | — | — |
TLogSearchBar
源码:src/vue/components/TLogSearchBar.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
state | TLogSearchBarState | — | 是 | — |
placeholder | string | "Search…" | 否 | — |
style | Style | undefined | 否 | — |
inputStyle | Style | undefined | 否 | — |
activeStyle | Style | () => ({ inverse: true }) | 否 | — |
errorStyle | Style | () => ({ fg: "redBright", bold: true }) | 否 | — |
disabledStyle | Style | () => ({ dim: true }) | 否 | — |
toggleStyle | Style | undefined | 否 | — |
focusable | boolean | true | 否 | — |
showModeToggle | boolean | true | 否 | — |
showCaseToggle | boolean | true | 否 | — |
showWholeWordToggle | boolean | true | 否 | — |
showCount | boolean | true | 否 | — |
showNavigation | boolean | true | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update | — | — |
update:query | — | — |
update:mode | — | — |
update:caseSensitive | — | — |
update:wholeWord | — | — |
previous | — | — |
next | — | — |
clear | — | — |
focus | — | — |
blur | — | — |
keydown | — | — |
TLogSearchPager
源码:src/vue/components/TLogSearchPager.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
state | TLogSearchPagerState | null | null | 否 | — |
style | Style | undefined | 否 | — |
activeStyle | Style | undefined | 否 | — |
disabledStyle | Style | () => ({ dim: true }) | 否 | — |
errorStyle | Style | () => ({ fg: "redBright", bold: true }) | 否 | — |
showCount | boolean | true | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
previousPage | — | — |
nextPage | — | — |
pageChange | — | — |
TLogSearchResults
源码:src/vue/components/TLogSearchResults.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
results | readonly TLogSearchResultItem[] | () => [] | 否 | — |
activeIndex | number | -1 | 否 | — |
style | Style | undefined | 否 | — |
activeStyle | Style | () => ({ inverse: true }) | 否 | — |
matchStyle | Style | () => ({ underline: true }) | 否 | — |
currentStyle | Style | () => ({ bold: true }) | 否 | — |
showLineNumbers | boolean | true | 否 | — |
focusable | boolean | true | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
select | — | — |
activeChange | — | — |
keydown | — | — |
focus | — | — |
blur | — | — |
TLogView
源码:src/vue/components/TLogView.ts
Experimental import:
@simon_he/vue-tui/experimental
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
source | TLogDataSource | — | 是 | — |
version | number | — | 是 | — |
scrollTop | number | undefined | 否 | — |
defaultScrollTop | number | undefined | 否 | — |
style | Style | undefined | 否 | — |
autoFocus | boolean | false | 否 | — |
autoStickToBottom | boolean | true | 否 | — |
overscan | number | 2 | 否 | — |
wrap | boolean | false | 否 | — |
visualIndexMode | "estimated" | "exact" | "estimated" | 否 | — |
visualIndexOptions | TLogViewVisualIndexOptions | undefined | 否 | — |
ansi | boolean | false | 否 | — |
links | boolean | false | 否 | — |
linkStyle | Style | () => ({ underline: true }) | 否 | — |
keyboardLinks | boolean | false | 否 | — |
linkFocusStyle | Style | () => ({ inverse: true }) | 否 | — |
searchQuery | string | "" | 否 | — |
searchOptions | TLogViewSearchOptions | undefined | 否 | — |
highlightMatches | boolean | true | 否 | — |
matchStyle | Style | () => ({ inverse: true }) | 否 | — |
currentMatchStyle | Style | () => ({ inverse: true, bold: true }) | 否 | — |
rowScrollMode | RowScrollMode | "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
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
links | readonly TLogLinkPanelItem[] | () => [] | 否 | — |
modelValue | number | -1 | 否 | — |
style | Style | undefined | 否 | — |
activeStyle | Style | undefined | 否 | — |
showLineNumbers | boolean | true | 否 | — |
rowScrollMode | RowScrollMode | "off" | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update:modelValue | — | — |
activeChange | — | — |
select | — | — |
activate | — | — |
focus | — | — |
blur | — | — |
keydown | — | — |
scroll | — | — |
TLogVirtualSearchResults
源码:src/vue/components/TLogVirtualSearchResults.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
itemCount | number | — | 是 | — |
itemVersion | number | — | 是 | — |
getItem | (index: number) => TLogSearchResultItem | null | — | 是 | — |
modelValue | number | -1 | 否 | — |
style | Style | undefined | 否 | — |
activeStyle | Style | undefined | 否 | — |
showLineNumbers | boolean | true | 否 | — |
rowScrollMode | RowScrollMode | "off" | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update:modelValue | — | — |
activeChange | — | — |
select | — | — |
focus | — | — |
blur | — | — |
keydown | — | — |
scroll | — | — |
TMultilineModal
源码:src/vue/components/TMultilineModal.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
visible | boolean | — | 是 | — |
content | string | — | 是 | — |
title | string | "Multiline Text" | 否 | — |
style | Style | undefined | 否 | — |
zIndex | number | 1000 | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
close | — | — |
TPathPicker
源码:src/vue/components/TPathPicker.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
workspace | string | — | 是 | — |
mode | PathPickMode | "any" | 否 | — |
modelValue | string | — | 是 | — |
placeholder | string | "" | 否 | — |
style | Style | undefined | 否 | — |
inputStyle | Style | undefined | 否 | — |
activeStyle | Style | undefined | 否 | — |
matchStyle | Style | undefined | 否 | — |
autoFocus | boolean | false | 否 | — |
showHidden | boolean | false | 否 | — |
maxSuggestions | number | 50 | 否 | — |
provider | PathPickerProvider | undefined | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update:modelValue | — | — |
select | — | — |
invalid | — | — |
keydown | — | — |
focus | — | — |
blur | — | — |
TRenderLayer
源码:src/vue/components/TRenderLayer.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
zIndex | number | 0 | 否 | — |
Events
—
TRenderPlane
源码:src/vue/components/TRenderPlane.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
plane | TerminalRenderPlane | "default" | 否 | — |
Events
—
TRouterView
源码:src/vue/router/RouterView.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
routes | TerminalRouteRecord[] | — | 是 | — |
forceRemount | boolean | true | 否 | — |
Events
—
TSelect
源码:src/vue/components/TSelect.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
options | SelectOption[] | — | 是 | — |
modelValue | number | number[] | 0 | 否 | — |
multiple | boolean | false | 否 | — |
multipleEmit | TSelectMultipleEmitMode | "value" | 否 | — |
style | Style | undefined | 否 | — |
highlightStyle | Style | undefined | 否 | — |
matchStyle | Style | undefined | 否 | — |
highlightMatchStyle | Style | undefined | 否 | — |
autoFocus | boolean | false | 否 | — |
closeOnBlur | boolean | false | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update:modelValue | — | — |
change | — | — |
confirm | — | — |
close | — | — |
focus | — | — |
blur | — | — |
keydown | — | — |
TText
源码:src/vue/components/TText.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
value | string | — | 是 | — |
w | number | undefined | 否 | — |
h | number | undefined | 否 | — |
style | Style | undefined | 否 | — |
clear | boolean | true | 否 | — |
wrap | boolean | false | 否 | — |
depsKey | unknown | undefined | 否 | Optional 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. externalterminal writes or higher-level virtualized row reuse). |
Events
—
TTransition
源码:src/vue/components/TTransition.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
show | boolean | — | 是 | — |
duration | number | 200 | 否 | — |
beforeEnter | TransitionHook | undefined | 否 | — |
enter | TransitionHook | undefined | 否 | — |
afterEnter | TransitionHook | undefined | 否 | — |
beforeLeave | TransitionHook | undefined | 否 | — |
leave | TransitionHook | undefined | 否 | — |
afterLeave | TransitionHook | undefined | 否 | — |
Events
—
TView
源码:src/vue/components/TView.ts
Props
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
scrollX | number | 0 | 否 | — |
scrollY | number | 0 | 否 | — |
focusable | boolean | false | 否 | — |
selectable | boolean | undefined | 否 | — |
autoFocus | boolean | false | 否 | — |
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
| 名称 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
x | number | — | 是 | — |
y | number | — | 是 | — |
w | number | — | 是 | — |
h | number | — | 是 | — |
zIndex | number | 0 | 否 | — |
itemCount | number | — | 是 | — |
itemVersion | number | — | 是 | — |
getItem | (index: number) => unknown | — | 是 | — |
renderItem | (item: unknown, index: number) => unknown | undefined | 否 | — |
modelValue | number | 0 | 否 | — |
scrollTop | number | undefined | 否 | — |
style | Style | undefined | 否 | — |
activeStyle | Style | undefined | 否 | — |
autoFocus | boolean | false | 否 | — |
rowScrollMode | RowScrollMode | "off" | 否 | — |
Events
| 名称 | Payload | 说明 |
|---|---|---|
update:modelValue | — | — |
update:scrollTop | — | — |
change | — | — |
itemClick | — | — |
scroll | — | — |
focus | — | — |
blur | — | — |
keydown | — | — |