Skip to content

QuickOpen.md

Latest commit

 

History

History
57 lines (40 loc) · 3.61 KB

QuickOpen.md

File metadata and controls

57 lines (40 loc) · 3.61 KB

Import :

const QuickOpen = brackets.getModule("search/QuickOpen")

SymbolKind : Object

Represents the symbol kind

Kind: global variable

QuickOpenPlugin()

Defines API for new QuickOpen plug-ins

Kind: global function

addQuickOpenPlugin(pluginDef)

Creates and registers a new QuickOpenPlugin

Kind: global function

Param Type Description
pluginDef Object Plugin definition object containing the following properties: {string} name - Plug-in name, must be unique. {Array(string)} languageIds - Language Ids array. Example: ["javascript", "css", "html"]. To allow any language, pass []. Required. {function()} [done] - Called when quick open is complete. Plug-in should clear its internal state. Optional. {function(string, StringMatch.StringMatcher): (Array(SearchResult

highlightMatch(item, matchClass, rangeFilter) ⇒ string

Formats item's label as properly escaped HTML text, highlighting sections that match 'query'. If item is a SearchResult generated by stringMatch(), uses its metadata about which string ranges matched; else formats the label with no highlighting.

Kind: global function
Returns: string - bolded, HTML-escaped result

Param Type Description
item string | SearchResult
matchClass string CSS class for highlighting matched text
rangeFilter function

beginSearch(prefix, initialString)

Opens the Quick Open bar prepopulated with the given prefix (to select a mode) and optionally with the given query text too. Updates text field contents if Quick Open already open.

Kind: global function

Param Type
prefix string
initialString string