addHintIndicator()

addHintIndicator(el, clickToClose?, autoClose?): HTMLElement

Defined in: js-api/ui.ts:2634

Adds a hint indication to the provided element and returns it.

Pass a function instead of an element when the target is rebuilt while the hint is up — a ribbon item, a re-rendered toolbar. The blob then re-resolves its target on every tick and moves with it; bound to a single node, it would be orphaned on the node that was replaced and the learner would see nothing highlighted.

Returns the target — or, for a function whose target has not rendered yet, the blob itself; [remove] takes either.

Example: https://public.datagrok.ai/js/samples/ui/interactivity/hints

Parameters

Parameter	Type	Default value
el	HTMLElement | (() => HTMLElement | null)	undefined
clickToClose	boolean	true
autoClose?	number	undefined

Returns

HTMLElement