import { AbstractText } from '../text/AbstractText'; import { HTMLTextStyle } from './HtmlTextStyle'; import type { View } from '../../rendering/renderers/shared/view/View'; import type { TextOptions, TextString } from '../text/AbstractText'; import type { HTMLTextStyleOptions } from './HtmlTextStyle'; /** * Constructor options used for `HTMLText` instances. * @property {string} [text=''] - The string that you would like the text to display. * @property {text.HTMLTextStyle | text.HTMLTextStyleOptions} [style] - The style of the text. * @memberof text */ export type HTMLTextOptions = TextOptions; /** * A HTMLText Object will create a line or multiple lines of text. * * To split a line you can use '\n' in your text string, or, on the `style` object, * change its `wordWrap` property to true and and give the `wordWrapWidth` property a value. * * HTMLText uses an svg foreignObject to render HTML text. * * * The primary advantages of this render mode are: * * - Supports [HTML tags](https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/HTML_text_fundamentals) * for styling such as ``, or ``, as well as `` * * - Better support for emojis and other HTML layout features, better compatibility with CSS * line-height and letter-spacing. * * * The primary disadvantages are: * - Unlike `text`, `html` rendering will vary slightly between platforms and browsers. * `html` uses SVG/DOM to render text and not Context2D's fillText like `text`. * * - Performance and memory usage is on-par with `text` (that is to say, slow and heavy) * * - Only works with browsers that support . * @example * import { HTMLText } from 'pixi.js'; * * const text = new HTMLText({ * text: 'Hello Pixi!', * style: { * fontFamily: 'Arial', * fontSize: 24, * fill: 0xff1010, * align: 'center', * } * }); * @memberof scene */ export declare class HTMLText extends AbstractText implements View { readonly renderPipeId: string; /** * @param {text.HTMLTextOptions} options - The options of the html text. */ constructor(options?: HTMLTextOptions); /** @deprecated since 8.0.0 */ constructor(text?: TextString, options?: Partial); protected _updateBounds(): void; }