Skip to content
pixi-silk
GitHub repository
Interface

SilkTextStyle

import type { SilkTextStyle } from 'pixi-silk/text';

The look of a SilkText. Every field can change later through its setter or SilkText.set.

Extended by#

Properties#

PropertyTypeDescriptionDefined in
aaWidth?numberWidth of the anti-aliasing ramp in device pixels. Larger is softer. Default 1.text/SilkText.ts:94
align?TextAlignAlignment of the lines. Default left.text/SilkText.ts:76
breakWords?booleanBreaks words that are wider than a line on their own. Default false.text/SilkText.ts:82
dilate?numberGrows (positive) or thins (negative) the glyphs, in local units. Default 0.text/SilkText.ts:92
fill?ColorSource | GradientA colour, or a pixi-silk gradient over the text box (linear, radial and conic). Default white.text/SilkText.ts:70
fontFamily?stringCSS font family list. Default system-ui, -apple-system, Segoe UI, Roboto, sans-serif.text/SilkText.ts:62
fontSize?numberFont size in local units. Default 16.text/SilkText.ts:64
fontStyle?"normal" | "italic" | "oblique"normal, italic or oblique. Default normal.text/SilkText.ts:68
fontWeight?string | numberCSS font weight. Default 400.text/SilkText.ts:66
kerning?booleanApplies the font’s kerning (measured from Canvas). Default true.text/SilkText.ts:86
letterSpacing?numberExtra space after each character, in local units. Default 0.text/SilkText.ts:72
lineHeight?numberDistance between baselines. 0 uses the font’s ascent plus descent, like PixiJS Text. Default 0.text/SilkText.ts:74
outline?TextOutline | nullA line around the glyphs. null for none. Default null.text/SilkText.ts:88
shadow?TextShadow | nullA drop shadow or glow under the glyphs. null for none. Default null.text/SilkText.ts:90
tabularNumbers?booleanGives the digits one width, like font-variant-numeric: tabular-nums, for readouts. Default false.text/SilkText.ts:84
wordWrap?booleanBreaks lines at spaces to fit wordWrapWidth. Default false.text/SilkText.ts:78
wordWrapWidth?numberWidth that wordWrap breaks lines at, in local units. Default 100.text/SilkText.ts:80