Function showHighlight

showHighlight(ctx, options): Promise<string>

Displays a highlight on the specified elements and shows a form with the provided options.

Parameters

ctx: Context
The context in which the highlight and form should be displayed.
options: ShowHighlightOptions
The options for displaying the highlight and form.

Returns Promise<string>

A promise that resolves to the button that was clicked.

Example

const options = {
  selectors: ['.highlight-element'],
  color: '#ff0000',
  buttons: [
    { text: 'OK', value: 'ok' },
    { text: 'Cancel', value: 'cancel' }
  ],
  title: 'Message title',
  description: 'Message description',
  text: 'Your highlighted color'
};
const button = await showHighlight(ctx, options);
console.log('Button clicked:', button);