API Reference / @gtkx/testing / PrettyWidgetOptions

Type Alias: PrettyWidgetOptions

PrettyWidgetOptions = object

Defined in: pretty-widget.d.ts:9

Options controlling how a widget tree is rendered to a string by prettyWidget and logWidget.

Properties

getId?

optional getId?: WidgetIdResolver

Defined in: pretty-widget.d.ts:15

Resolves an id attribute to show for each widget.

---

maxDepth?

optional maxDepth?: number

Defined in: pretty-widget.d.ts:17

Stops descending past this depth, replacing deeper children with a summary line.

---

maxLength?

optional maxLength?: number

Defined in: pretty-widget.d.ts:11

Truncates the output once it exceeds this many characters.

---

shouldHighlight?

optional shouldHighlight?: boolean

Defined in: pretty-widget.d.ts:13

Whether to apply ANSI color highlighting; defaults to the terminal capabilities.