pixi-multistyle-text

pixi-multistyle-text

Add a MultiStyleText object inside pixi.js to easily create text using different styles.

Example

In the example below, we are defining 4 text styles. default is the default style for the text, and the others matches the tags inside the text.

let text = new MultiStyleText("Let's make some <ml>multiline</ml>\nand <ms>multistyle</ms> text for\n<pixi>Pixi.js!</pixi>",
{
	"default": {
		fontFamily: "Arial",
		fontSize: "24px",
		fill: "#cccccc",
		align: "center"
	},
	"ml": {
		fontStyle: "italic",
		fill: "#ff8888"
	},
	"ms": {
		fontStyle: "italic",
		fill: "#4488ff"
	},
	"pixi": {
		fontSize: "64px",
		fill: "#efefef"
	}
});

Build instructions

$ npm install
$ npm run build

Usage

text = new MultiStyleText(text, textStyles)

Creates a new MultiStyleText with the given text and styles.

textStyles

Type: { [key: string]: ExtendedTextStyle }

Each key of this dictionary should match with a tag in the text. Use the key default for the default style.

Each ExtendedTextStyle object can have any of the properties of a standard PIXI text style, in addition to a valign property that allows you to specify where text is rendered relative to larger text on the same line ("top", "middle", or "bottom").

The align, wordWrap, wordWrapWidth, and breakWord properties are ignored on all styles except for the default style, which controls those properties for the entire text object.

If text is rendered without any value assigned to a given parameter, Pixi's defaults are used.

Demo

$ npm run demo

License

MIT, see LICENSE.md for details.

Changelog

0.7.0 (2018-10-29)

Bug Fixes

• Fix Stroke thickness issues (#73) (36cfc62), closes #59 #60
• text not rendered when stroke or fill is 0x000000 (#69) (aa0e7de)

Chores

• fix happo, use microbundle to create the dist files, use circleci v2 (#63) (56c7a80)

BREAKING CHANGES

• Since we now use microbundle to create the library. The output changes a bit and the output file in a CJS file only. If you need to use the library with a script tag, you should use the UMD build.

<a name="0.6.0"></a>