<link rel="stylesheet" href="/_merged_assets/_static/noscript.css">
Atom Community Logo Atom Community API Getting Started Toggle darkmode

Hyperclick

API

HyperclickProvider

Properties

getSuggestion

(optional)

  

Use this to provide a suggestion if it can have non-contiguous ranges. A primary use-case for this is Objective-C methods.

getSuggestionForWord

(optional)

  

Use this to provide a suggestion for single-word matches. Optionally set wordRegExp to adjust word-matching.

grammarScopes

(optional)
string[]

Optionally, limit the set of grammar scopes the provider should apply to.

priority

number

The higher this is, the more precedence the provider gets.

providerName

(optional)
string

Must be unique. Used for analytics.

wordRegExp

(optional)
RegExp

HyperclickSuggestion

Properties

callback


  |[]

The function to call when the underlined text is clicked.

range

Range|Range[]

The range(s) to underline to provide as a visual cue for clicking.