Liking cljdoc? Tell your friends :D

dots.vscode.status-bar-item

A status bar item is a status bar contribution that can show text and icons and run a command on click.

A status bar item is a status bar contribution that can
show text and icons and run a command on click.
raw docstring

accessibility-informationcljs

(accessibility-information status-bar-item)

Accessibility information used when a screen reader interacts with this StatusBar item

Accessibility information used when a screen reader interacts with this StatusBar item
sourceraw docstring

alignmentcljs

(alignment status-bar-item)

The alignment of this item.

The alignment of this item.
sourceraw docstring

background-colorcljs

(background-color status-bar-item)

The background color for this entry.

Note: only the following colors are supported:

  • new ThemeColor('statusBarItem.errorBackground')
  • new ThemeColor('statusBarItem.warningBackground')

More background colors may be supported in the future.

Note: when a background color is set, the statusbar may override the color choice to ensure the entry is readable in all themes.

The background color for this entry.

*Note*: only the following colors are supported:
* `new ThemeColor('statusBarItem.errorBackground')`
* `new ThemeColor('statusBarItem.warningBackground')`

More background colors may be supported in the future.

*Note*: when a background color is set, the statusbar may override
the `color` choice to ensure the entry is readable in all themes.
sourceraw docstring

colorcljs

(color status-bar-item)

The foreground color for this entry.

The foreground color for this entry.
sourceraw docstring

commandcljs

(command status-bar-item)

{@linkcode Command } or identifier of a command to run on click.

The command must be {@link commands.getCommands known}.

Note that if this is a {@linkcode Command } object, only the {@linkcode Command.command command} and {@linkcode Command.arguments arguments} are used by the editor.

{@linkcode Command } or identifier of a command to run on click.

The command must be {@link commands.getCommands known}.

Note that if this is a {@linkcode Command } object, only the {@linkcode Command.command command} and {@linkcode Command.arguments arguments}
are used by the editor.
sourceraw docstring

disposecljs

(dispose status-bar-item)

Dispose and free associated resources. Call {@link StatusBarItem.hide hide}.

Returns: void

Dispose and free associated resources. Call
{@link StatusBarItem.hide hide}.

**Returns:** `void`
sourceraw docstring

hidecljs

(hide status-bar-item)

Hide the entry in the status bar.

Returns: void

Hide the entry in the status bar.

**Returns:** `void`
sourceraw docstring

idcljs

(id status-bar-item)

The identifier of this item.

Note: if no identifier was provided by the {@linkcode window.createStatusBarItem } method, the identifier will match the {@link Extension.id extension identifier}.

The identifier of this item.

*Note*: if no identifier was provided by the {@linkcode window.createStatusBarItem }
method, the identifier will match the {@link Extension.id extension identifier}.
sourceraw docstring

namecljs

(name status-bar-item)

The name of the entry, like 'Python Language Indicator', 'Git Status' etc. Try to keep the length of the name short, yet descriptive enough that users can understand what the status bar item is about.

The name of the entry, like 'Python Language Indicator', 'Git Status' etc.
Try to keep the length of the name short, yet descriptive enough that
users can understand what the status bar item is about.
sourceraw docstring

prioritycljs

(priority status-bar-item)

The priority of this item. Higher value means the item should be shown more to the left.

The priority of this item. Higher value means the item should
be shown more to the left.
sourceraw docstring

set-accessibility-information!cljs

(set-accessibility-information! status-bar-item value)

Accessibility information used when a screen reader interacts with this StatusBar item

Accessibility information used when a screen reader interacts with this StatusBar item
sourceraw docstring

set-background-color!cljs

(set-background-color! status-bar-item value)

The background color for this entry.

Note: only the following colors are supported:

  • new ThemeColor('statusBarItem.errorBackground')
  • new ThemeColor('statusBarItem.warningBackground')

More background colors may be supported in the future.

Note: when a background color is set, the statusbar may override the color choice to ensure the entry is readable in all themes.

The background color for this entry.

*Note*: only the following colors are supported:
* `new ThemeColor('statusBarItem.errorBackground')`
* `new ThemeColor('statusBarItem.warningBackground')`

More background colors may be supported in the future.

*Note*: when a background color is set, the statusbar may override
the `color` choice to ensure the entry is readable in all themes.
sourceraw docstring

set-color!cljs

(set-color! status-bar-item value)

The foreground color for this entry.

The foreground color for this entry.
sourceraw docstring

set-command!cljs

(set-command! status-bar-item value)

{@linkcode Command } or identifier of a command to run on click.

The command must be {@link commands.getCommands known}.

Note that if this is a {@linkcode Command } object, only the {@linkcode Command.command command} and {@linkcode Command.arguments arguments} are used by the editor.

{@linkcode Command } or identifier of a command to run on click.

The command must be {@link commands.getCommands known}.

Note that if this is a {@linkcode Command } object, only the {@linkcode Command.command command} and {@linkcode Command.arguments arguments}
are used by the editor.
sourceraw docstring

set-name!cljs

(set-name! status-bar-item value)

The name of the entry, like 'Python Language Indicator', 'Git Status' etc. Try to keep the length of the name short, yet descriptive enough that users can understand what the status bar item is about.

The name of the entry, like 'Python Language Indicator', 'Git Status' etc.
Try to keep the length of the name short, yet descriptive enough that
users can understand what the status bar item is about.
sourceraw docstring

set-text!cljs

(set-text! status-bar-item value)

The text to show for the entry. You can embed icons in the text by leveraging the syntax:

My text $(icon-name) contains icons like $(icon-name) this one.

Where the icon-name is taken from the ThemeIcon icon set, e.g. light-bulb, thumbsup, zap etc.

The text to show for the entry. You can embed icons in the text by leveraging the syntax:

`My text $(icon-name) contains icons like $(icon-name) this one.`

Where the icon-name is taken from the ThemeIcon [icon set](https://code.visualstudio.com/api/references/icons-in-labels#icon-listing), e.g.
`light-bulb`, `thumbsup`, `zap` etc.
sourceraw docstring

set-tooltip!cljs

(set-tooltip! status-bar-item value)

The tooltip text when you hover over this entry.

The tooltip text when you hover over this entry.
sourceraw docstring

showcljs

(show status-bar-item)

Shows the entry in the status bar.

Returns: void

Shows the entry in the status bar.

**Returns:** `void`
sourceraw docstring

textcljs

(text status-bar-item)

The text to show for the entry. You can embed icons in the text by leveraging the syntax:

My text $(icon-name) contains icons like $(icon-name) this one.

Where the icon-name is taken from the ThemeIcon icon set, e.g. light-bulb, thumbsup, zap etc.

The text to show for the entry. You can embed icons in the text by leveraging the syntax:

`My text $(icon-name) contains icons like $(icon-name) this one.`

Where the icon-name is taken from the ThemeIcon [icon set](https://code.visualstudio.com/api/references/icons-in-labels#icon-listing), e.g.
`light-bulb`, `thumbsup`, `zap` etc.
sourceraw docstring

tooltipcljs

(tooltip status-bar-item)

The tooltip text when you hover over this entry.

The tooltip text when you hover over this entry.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close