Text
Truncates overflowing text at any position, with auto, looping and hover scrolling.
Usage
Ellipsis position
Loading demo...
Scroll mode
Loading demo...
Looping scroll
Loading demo...
Best Practices
- Give
TxTexta definite width, or place it in a fixed-width container; it never widens its parent. - Put padding and borders on the outer container, not on
TxTextitself. - Use
overflow="middle"for file names to keep the start and the extension; useoverflow="start"for paths to keep the file name. - Do not set
scroll="auto"orscroll="loop"on every row of a list; it competes for attention. Usescroll="hover"when readers need the full text. - The default
loopEdge="gap"clears the whole text before it returns; useloopEdge="fade"to keep the edges soft, orloopEdge="wrap"to keep text in view at all times.
API Reference
Props
| Prop | Type | Default | Description |
|---|---|---|---|
text | string | - | The full text. It is shown whole when it fits. |
overflow | 'start' | 'middle' | 'end' | 'end' | Where the ellipsis goes when the text is cut. Ignored with scroll="auto" and scroll="loop". |
scroll | 'none' | 'auto' | 'hover' | 'loop' | 'none' | auto swings overflowing text back and forth; loop scrolls it round (edge effect set by loopEdge); hover slides the hidden part in while the pointer is over it, and on touch a tap toggles it. |
loopEdge | 'gap' | 'clip' | 'fade' | 'wrap' | 'gap' | Only with scroll="loop". gap clears the text fully before it re-enters; clip leaves a two-character gap and cuts at the edge; fade is clip with both edges fading; wrap joins the text end to end, so text stays in view. |
Overview
- The root is a
<span>withdisplay: block; its width comes from the parent. - End ellipsis uses CSS. Start and middle ellipses are measured on mount, on resize and once the font loads;
titlecarries the full text when cut. - Looping starts only when the text overflows, runs at about 40px/s, and only animates
transform. - On touch,
scroll="hover"expands on a tap and collapses on another tap or a tap outside the component. - Screen readers read the full text, never the truncated form.
- Reduced motion stops every scroll mode and falls back to a static cut.
Technologies
- Source:
packages/tuffex/packages/components/src/text/.
查看源码
packages/tuffex/packages/components/src/text/index.ts