Skip to main content

statusBarStore

MS Code Extension API

MS Code Extension API / features/statusbar/store/statusBarStore

features/statusbar/store/statusBarStore

Interfaces​

StatusBarItem​

Defined in: features/statusbar/store/statusBarStore.ts:35

Full operational validation template representing a single data or action item positioned on the status bar interface layer.

Properties​

alignment​

alignment: StatusBarAlignment

Defined in: features/statusbar/store/statusBarStore.ts:39

Primary spatial anchor zone assigning item orientation layout paths.

className?​

optional className?: string

Defined in: features/statusbar/store/statusBarStore.ts:63

Dynamic layout tracking classes appended onto root rendering blocks.

color?​

optional color?: string

Defined in: features/statusbar/store/statusBarStore.ts:53

Custom aesthetic hexadecimal parameter or CSS variable color applied directly to text/icons.

Example​
'var(--ms-error)' or '#ff5555'
hidden?​

optional hidden?: boolean

Defined in: features/statusbar/store/statusBarStore.ts:57

Toggles item rendering. If true, the item is completely unmounted from the DOM layout.

icon?​

optional icon?: string

Defined in: features/statusbar/store/statusBarStore.ts:47

Codicon alphanumeric name string mapping the indicator icon next to text fields.

id​

id: string

Defined in: features/statusbar/store/statusBarStore.ts:37

Universally unique identifier managing the item's state slot (e.g., 'mscode-git-sync')

label?​

optional label?: string

Defined in: features/statusbar/store/statusBarStore.ts:45

Natural descriptive label or plain text content displayed directly inside the item row.

onClick?​

optional onClick?: (e) => void

Defined in: features/statusbar/store/statusBarStore.ts:59

Asynchronous click event execution logic intercepting client pointer selections.

Parameters​
e​

MouseEvent

Returns​

void

priority​

priority: number

Defined in: features/statusbar/store/statusBarStore.ts:43

Layout weighting coefficient. Higher integers force items closer to the absolute outer corners of the parent container bar.

spin?​

optional spin?: boolean

Defined in: features/statusbar/store/statusBarStore.ts:55

Flags whether the inner icon token executes an infinite spin animation loop (ideal for loaders).

style?​

optional style?: CSSProperties

Defined in: features/statusbar/store/statusBarStore.ts:61

Native inline styling overrides passed directly down to sub-container elements.

tooltip?​

optional tooltip?: string

Defined in: features/statusbar/store/statusBarStore.ts:49

Rich documentation tooltips or description markers shown when hovering over bounds.

StatusBarState​

Defined in: features/statusbar/store/statusBarStore.ts:70

Operational API interface specifications mapping internal mutation methods to register, adjust, or completely dismantle telemetry slots.

Properties​

items​

items: Record<string, StatusBarItem>

Defined in: features/statusbar/store/statusBarStore.ts:72

Central lookup index tracking active indicators mapped out in memory tables.

registerItem​

registerItem: (item) => void

Defined in: features/statusbar/store/statusBarStore.ts:78

Registers a fresh telemetry allocation block inside the runtime memory arrays. *

Parameters​
item​

StatusBarItem

Full initialization metadata properties template block.

Returns​

void

removeItem​

removeItem: (id) => void

Defined in: features/statusbar/store/statusBarStore.ts:91

Completely purges a targeted status bar entry node, freeing up application allocation queues. *

Parameters​
id​

string

Unique target identifier token to unregister.

Returns​

void

updateItem​

updateItem: (id, updates) => void

Defined in: features/statusbar/store/statusBarStore.ts:85

Dynamically merges specialized structural parameters onto an existing target entry slot. *

Parameters​
id​

string

Unique target identifier boundary token.

updates​

Partial<StatusBarItem>

Incremental properties patch mapping to be applied.

Returns​

void

Type Aliases​

StatusBarAlignment​

StatusBarAlignment = "left" | "right"

Defined in: features/statusbar/store/statusBarStore.ts:29

Alignment properties designating whether the target item docks into the left-hand cluster or the right-hand utility tray zone.

Variables​

useStatusBarStore​

const useStatusBarStore: UseBoundStore<StoreApi<StatusBarState>>

Defined in: features/statusbar/store/statusBarStore.ts:120

Zustand Hook Subsystem Engine orchestrating systemic layout modifications across the status bar interfaces in real-time. *

Example​

// ─── REACTION ENGINE USAGE INSIDE CORE EXTENSION HOST / Subsystem ───
import { useStatusBarStore } from '@/store/statusBarStore';
* // 1. Initial Core Item Registration (Uncontrolled/Imperative Boot)
useStatusBarStore.getState().registerItem({
id: 'mscode-prettier-node',
alignment: 'right',
priority: 85,
label: 'Prettier',
icon: 'check',
tooltip: 'Prettier Formatter Active',
hidden: false
});
* // 2. Real-time Async Metadata Interception (e.g., Parsing Failure Trigger)
useStatusBarStore.getState().updateItem('mscode-prettier-node', {
label: 'Prettier: Error',
icon: 'warning',
color: 'var(--ms-error)',
tooltip: 'Syntax parsing constraints triggered line failures'
});
* // 3. Complete Resource Teardown Workflow
useStatusBarStore.getState().removeItem('mscode-prettier-node');