Skip to content

Function: Highlight()

ts
function Highlight(props: UiHighlightProps): Block;

Defined in: src/renderer/blocks/index.ts:1138

Highlight strip — colored left border + short message used to flag a field or section that needs the user's attention.

Distinct from the puppeteer Highlight class exported by @matterway/sdk, which paints a DOM-level overlay around a live page element. This Highlight is the React block rendered inside a skill's bubble; the two share a name but live in different module entries (@matterway/sdk/UI vs @matterway/sdk).

Parameters

ParameterType
propsUiHighlightProps

Returns

Block

Examples

ts
Highlight({text: 'Fill or verify highlighted data'});
ts
Highlight({
  text: 'Verify the extracted invoice number',
  color: 'hsl(var(--warning))',
});

Matterway Assistant SDK Documentation