Skip to main content

IWidgetStatus

Defined in: js-api/src/widgets/base.ts:246

Runtime snapshot of a widget's structure, used by the automated testing system. Returned by Widget.getWidgetStatus.

Properties

PropertyTypeDescriptionDefined in
descriptionstring | nullFree-form description of the widget's current state.js-api/src/widgets/base.ts:256
errorstring | nullValidation error message; null means the widget is in a valid state.js-api/src/widgets/base.ts:258
eventsIEventType[]Events fired by this widget.js-api/src/widgets/base.ts:254
hitAreasobjectNamed interactive regions: region name → bounding rectangle.js-api/src/widgets/base.ts:250
inputs?IInputStatus[]Live state of the widget's named inputs — present on widgets that edit named values (forms), absent on the ones that do not.js-api/src/widgets/base.ts:261
partsobjectNamed UI parts: part name → root DOM Element.js-api/src/widgets/base.ts:248
shortcutsobjectKeyboard shortcuts: key combo string → human-readable description.js-api/src/widgets/base.ts:252