text

A run of text. Wraps, truncates and aligns within the box it is given.

<text content="billing-worker" fg="accent" bold />

Props

| Prop | Type | Default | | | — | — | — | — | | children | unknown | | | | content | string | | The string to draw. children is accepted as a shorthand. | | truncate | 'end' \| 'start' \| 'middle' \| false | | Where to cut when the text does not fit. | | ellipsis | string | | |

Plus everything on BaseProps.

content and children are the same thing - <text>hello</text> and <text content="hello" /> produce the same node. Prefer content when the string is computed, because it survives being written as data.

Text does not size itself; the box around it decides the width, and wrap and truncate decide what happens when the string is longer than that:

<box width={20}>
  <text content="a service name far too long for this column" truncate="middle" />
</box>

truncate takes 'start', 'middle', 'end' or false, and ellipsis replaces the character used to mark the cut.

See also


Back to top

MIT licensed. Pre-1.0 - the surface is still moving.