Skip to main content

StatusBar

Import :

const StatusBar = brackets.getModule("widgets/StatusBar")

AppInit

A status bar with support for file information and busy and status indicators. This is a semi-generic container; for the code that decides what content appears in the status bar, see client modules like EditorStatusBar. (Although in practice StatusBar's HTML structure and initialization assume it's only used for this one purpose, and all the APIs are on a singleton).

Kind: global variable

showBusyIndicator(updateCursor)

Shows the 'busy' indicator

Kind: global function

ParamTypeDescription
updateCursorbooleanSets the cursor to "wait"

hideBusyIndicator()

Hides the 'busy' indicator

Kind: global function

addIndicator(id, [indicator], [visible], [style], [tooltip], [insertBefore])

Registers a new status indicator

Kind: global function

ParamTypeDescription
idstringRegistration id of the indicator to be updated.
[indicator]DOMNode | jQueryObjectOptional DOMNode for the indicator
[visible]booleanShows or hides the indicator over the statusbar.
[style]stringSets the attribute "class" of the indicator.
[tooltip]stringSets the attribute "title" of the indicator.
[insertBefore]stringAn id of an existing status bar indicator. The new indicator will be inserted before (i.e. to the left of) the indicator specified by this parameter.

updateIndicator(id, visible, [style], [tooltip])

Updates a status indicator

Kind: global function

ParamTypeDescription
idstringRegistration id of the indicator to be updated.
visiblebooleanShows or hides the indicator over the statusbar.
[style]stringSets the attribute "class" of the indicator.
[tooltip]stringSets the attribute "title" of the indicator.

hideInformation()

Hide the statusbar Information Panel

Kind: global function

showInformation()

Show the statusbar Information Panel

Kind: global function

hideIndicators()

Hide the statusbar Indicators

Kind: global function

showIndicators()

Show the statusbar Indicators

Kind: global function

hideAllPanes()

Hides all panels but not the status bar

Kind: global function

showAllPanes()

Shows all panels (will not show a hidden statusbar)

Kind: global function

hide()

Hide the statusbar

Kind: global function

show()

Show the statusbar

Kind: global function