StatusBarItem class

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

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

StatusBarItem({String? id, StatusBarAlignment? alignment, num? priority, String? name, String? text, dynamic tooltip, dynamic color, ThemeColor? backgroundColor, dynamic command, AccessibilityInformation? accessibilityInformation, void show()?, void hide()?, void dispose()?})
factory

Properties

accessibilityInformation ↔ AccessibilityInformation?

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

Accessibility information used when a screen reader interacts with this StatusBar item
getter/setter pair
alignment → StatusBarAlignment

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

The alignment of this item.
no setter
backgroundColor ↔ ThemeColor?

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

The background color for this entry.
getter/setter pair
color ↔ dynamic

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

The foreground color for this entry.
getter/setter pair
command ↔ dynamic

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

{@linkcode Command} or identifier of a command to run on click.
getter/setter pair
dispose ↔ void Function()

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hide ↔ void Function()

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

getter/setter pair
id → String

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

The identifier of this item.
no setter
name ↔ String?

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

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.
getter/setter pair
priority → num?

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

The priority of this item. Higher value means the item should be shown more to the left.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
show ↔ void Function()

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

getter/setter pair
text ↔ String

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

The text to show for the entry. You can embed icons in the text by leveraging the syntax:
getter/setter pair
tooltip ↔ dynamic

Available on StatusBarItem, provided by the StatusBarItem$Typings extension

The tooltip text when you hover over this entry.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited