Skip to content

AllWindowsStatusBarItemComponentConstructorParams

Parameters for the AllWindowsStatusBarItemComponent constructor.

Import:

import type { AllWindowsStatusBarItemComponentConstructorParams } from '@mnaoumov/obsidian-lib/components/all-windows-status-bar-item-component';

Signature:

export interface AllWindowsStatusBarItemComponentConstructorParams

Properties

PropertyTypeDescription
appAppThe Obsidian app instance.
cls?readonly string[]Extra CSS classes for each item.
pluginId?stringThe plugin id. When given, each item gets the plugin-<id> class that Plugin.addStatusBarItem adds, so themes and CSS snippets that target the plugin's status-bar items match these too.
render(params: AllWindowsStatusBarItemRenderParams) => voidRenders the item of one window. Called when the item is created and again by AllWindowsStatusBarItemComponent.refresh, so it must be safe to call repeatedly on the same element.
shouldCreateMissingStatusBar?booleanWhether to create a status bar in a window that has none, as every popout in Obsidian 1.15.1 does. When false, such a window gets no item. Defaults to true.

Links to this page: