Interfaces

TextPathProps

Text laid along an SVG path: each glyph is placed at its own advance along the curve and rotated to the tangent there. The path is the baseline, so there is no x/y - and no wrapping, since the path is the line.

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


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


opacity?

optional opacity?: Animated<number>;

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

Inherited from

PaintProps.opacity


path

path: string;

SVG path data, read once per commit, exactly as <Path> reads it.


ref?

optional ref?: NodeHandle;

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

Inherited from

PaintProps.ref


startOffset?

optional startOffset?: number;

Distance along the path where the first glyph starts.


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?: string;

Optional only because <Span> children replace it, as in <Text>.


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