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

Outline GitHub

A replacement of the outline functionality from atom-ide-ui. Presents symbols of an active text editor in a tree view.

screenshot of outline feature

API

Outline

Properties

outlineTrees

OutlineTree[]

OutlineProvider

Properties

grammarScopes

readonly string[]

name

string

priority

number

If there are multiple providers for a given grammar, the one with the highest priority will be used.

updateOnEdit

(optional)
boolean

Methods

getOutline

Parameters

editor
TextEditor

Returns

Promise<undefined|null|Outline>

OutlineTree

Properties

children

OutlineTree[]

endPosition

(optional)
Point

icon

(optional)
string

from Atom.Octicon or Atom.OcticonsPrivate (types not allowed over rpc so we use string)

kind

(optional)
OutlineTreeKind

kind you can pass to the UI for theming

landingPosition

(optional)
Point

plainText

(optional)
string

Must have plainText or the tokenizedText property. If both are present, tokenizedText is preferred.

representativeName

(optional)
string

If user has atom-ide-base-outline-view.nameOnly then representativeName is used instead.

startPosition

Point

tokenizedText

(optional)
TokenizedText

Must have plainText or the tokenizedText property. If both are present, tokenizedText is preferred.

TextToken

Properties

kind

TokenKind

value

string

OutlineTreeKind

Kind of outline tree - matches the names from the Language Server Protocol v2.

TokenKind

TokenizedText