isHighlightModeActive - Methods - Annotations API

Annotations API Methods

isHighlightModeActive()

Checks whether keyboard highlight mode is active.

You would want to use this so that you can determine whether learners are currently able to highlight text using keyboard controls.

Returns true when keyboard highlight mode is active, and false when it is inactive.

Examples

itemsApp.assessApp().annotationsApp().module('texthighlight').isHighlightModeActive();

Arguments

None.

Return value

Type boolean

Versioning

Version added: v2026.2.LTS (now live in developer)

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.