Skip to content

Interface TextComponent

🏷️ Properties

block optional

block: string

A string specifying the coordinates of the block entity from which the NBT value is obtained. The coordinates can be absolute or relative. Useless if nbt is absent.

Defined in: packages/text-component/index.ts:57

bold optional

bold: boolean

Defined in: packages/text-component/index.ts:72

clickEvent optional

clickEvent: Object

Allows for events to occur when the player clicks on text.

Defined in: packages/text-component/index.ts:84

color optional

color: string

The color to render this text in. Valid values are "black", "dark_blue", "dark_green", "dark_aqua", "dark_red", "dark_purple", "gold", "gray", "dark_gray", "blue", "green", "aqua", "red", "light_purple", "yellow", "white", and "reset" (cancels out the effects of colors used by parent objects). Technically, "bold", "italic", "underlined", "strikethrough", and "obfuscated" are also accepted, but it may be better practice to use the tags below for such formats.

Defined in: packages/text-component/index.ts:71

entity optional

entity: string

A string specifying the target selector for the entity from which the NBT value is obtained. Useless if nbt is absent.

Defined in: packages/text-component/index.ts:61

extra optional

extra: TextComponent[]

A list element whose structure repeats this raw JSON text structure. Note that all properties of this object are inherited by children except for text, extra, translate, with, and score.

This means that children retain the same formatting and events as this object unless they explicitly override them.

Defined in: packages/text-component/index.ts:67

hoverEvent optional

hoverEvent: Object

Defined in: packages/text-component/index.ts:101

insertion optional

insertion: string

When the text is shift-clicked by a player, this string is inserted in their chat input. It does not overwrite any existing text the player was writing.

Defined in: packages/text-component/index.ts:80

italic optional

italic: boolean

Defined in: packages/text-component/index.ts:73

keybind optional

keybind: string

A string that can be used to display the key needed to preform a certain action. An example is key.inventory which always displays "E" unless the player has set a different key for opening their inventory.

Ignored when any of the previous fields exist in the root object.

Defined in: packages/text-component/index.ts:49

nbt optional

nbt: string

A string indicating the NBT path used for looking up NBT values from an entity or a block entity. Ignored when any of the previous fields exist in the root object.

Defined in: packages/text-component/index.ts:53

obfuscated optional

obfuscated: boolean

Defined in: packages/text-component/index.ts:76

score optional

score: Object

A player's score in an objective. Displays nothing if the player is not tracked in the given objective. Ignored when any of the previous fields exist in the root object.

Defined in: packages/text-component/index.ts:26

selector optional

selector: string

A string containing a selector (@p,@a,@r,@e or @s) and, optionally, selector arguments.

Unlike text, the selector is translated into the correct player/entity names. If more than one player/entity is detected by the selector, it is displayed in a form such as 'Name1 and Name2' or 'Name1, Name2, Name3, and Name4'. Ignored when any of the previous fields exist in the root object.

  • Clicking a player's name inserted into a /tellraw command this way suggests a command to whisper to that player.
  • Shift-clicking a player's name inserts that name into chat.
  • Shift-clicking a non-player entity's name inserts its UUID into chat.

Defined in: packages/text-component/index.ts:42

strikethrough optional

strikethrough: boolean

Defined in: packages/text-component/index.ts:75


text: string

A string representing raw text to display directly in chat. Note that selectors such as "@a" and "@p" are not translated into player names; use selector instead. Can use escape characters, such as \n for newline (enter), \t for tab, etc.

Defined in: packages/text-component/index.ts:11

translate optional

translate: string

The translation identifier of text to be displayed using the player's selected language. This identifier is the same as the identifiers found in lang files from assets or resource packs. Ignored when text exist in the root object.

Defined in: packages/text-component/index.ts:15

underlined optional

underlined: boolean

Defined in: packages/text-component/index.ts:74

with optional

with: string[]

A list of chat component arguments and/or string arguments to be used by translate. Useless otherwise.

The arguments are text corresponding to the arguments used by the translation string in the current language, in order (for example, the first list element corresponds to "%1$s" in a translation string). Argument structure repeats this raw JSON text structure.

Defined in: packages/text-component/index.ts:21