Interfaces

TextProps

Paint attributes shared by every drawing component, <Group>, and <Paint>.

Extends

Properties

antiAlias?

optional antiAlias?: boolean;

Inherited from

PaintProps.antiAlias


blendMode?

optional blendMode?: BlendMode;

How this drawing composites onto what is already there. 'srcOver' by default.

Inherited from

PaintProps.blendMode


children?

optional children?: ReactNode;

Inherited from

PaintProps.children


color?

optional color?: Animated<Color>;

Inherited from

PaintProps.color


ellipsis?

optional ellipsis?: string;

Appended to the last line when maxLines truncates.

Inherited from

ParagraphProps.ellipsis


fauxBold?

optional fauxBold?: boolean;

Force the embolden/shear the face match only applies when nothing close enough exists.

Inherited from

FontProps.fauxBold


fauxItalic?

optional fauxItalic?: boolean;

Inherited from

FontProps.fauxItalic


fontFamily?

optional fontFamily?: string;

A family registered with useFonts/loadFont, or one the platform knows. Unregistered and unknown falls back to the platform's default text font.

Inherited from

FontProps.fontFamily


fontSize?

optional fontSize?: Animated<number>;

Inherited from

FontProps.fontSize


fontStyle?

optional fontStyle?: "normal" | "italic";

Inherited from

FontProps.fontStyle


fontWeight?

optional fontWeight?: FontWeight;

Picks the nearest face in the family; synthesised when none is close.

Inherited from

FontProps.fontWeight


letterSpacing?

optional letterSpacing?: number;

Extra px between glyphs.

Inherited from

FontProps.letterSpacing


lineHeight?

optional lineHeight?: number;

Baseline-to-baseline distance in px. Defaults to the font's own spacing.

Inherited from

ParagraphProps.lineHeight


maxLines?

optional maxLines?: number;

Stop after this many lines. Omitted or 0 means unlimited.

Inherited from

ParagraphProps.maxLines


opacity?

optional opacity?: Animated<number>;

Paint-wide alpha multiplier in [0, 1]; only one per chain can animate.

Inherited from

PaintProps.opacity


ref?

optional ref?: NodeHandle;

A handle from useNode(), for changing this node without a React render. See NodeHandle.

Inherited from

PaintProps.ref


strokeCap?

optional strokeCap?: "butt" | "round" | "square";

Inherited from

PaintProps.strokeCap


strokeJoin?

optional strokeJoin?: "round" | "miter" | "bevel";

Inherited from

PaintProps.strokeJoin


strokeMiter?

optional strokeMiter?: Animated<number>;

Past this length-over-width ratio a 'miter' join falls back to bevel. Defaults to 4.

Inherited from

PaintProps.strokeMiter


strokeWidth?

optional strokeWidth?: Animated<number>;

Inherited from

PaintProps.strokeWidth


style?

optional style?: "fill" | "stroke";

'fill' (default) or 'stroke'.

Inherited from

PaintProps.style


text?

optional text?: Animated<string>;

A SharedValue (or a handle.set({ text }) write) gets a string slot: the engine re-shapes on the render thread when the value changes, with no re-encode - the live-counter path.

Optional because <Span> children (inherited from PaintProps) are the other way to give a <Text> its content, and they replace this when present. A <Text> with neither draws nothing.


textAlign?

optional textAlign?: "center" | "left" | "right";

How lines sit inside width (or inside the widest line without one).

Inherited from

ParagraphProps.textAlign


visible?

optional visible?: Animated<number | boolean>;

Skip drawing (and hit-testing) this node. A value slot, so a handle or a SharedValue toggles it with no re-encode - the supported way to pool mounted nodes for particle systems and variable-count scenes.

Inherited from

PaintProps.visible


width?

optional width?: number;

Wrap width in px. Without it, text is only broken at explicit \n - which is the cheap single-line path, unchanged.

Inherited from

ParagraphProps.width


x

x: Animated<number>;

y

y: Animated<number>;