RegisterAllWindowsStatusBarItemParams
Parameters for registerAllWindowsStatusBarItem.
Import:
import type { RegisterAllWindowsStatusBarItemParams } from '@mnaoumov/obsidian-lib/components/all-windows-status-bar-item-component';Signature:
export interface RegisterAllWindowsStatusBarItemParams extends AllWindowsStatusBarItemComponentConstructorParamsExtends: AllWindowsStatusBarItemComponentConstructorParams
Properties
| Property | Type | Description |
|---|---|---|
| app | App | The Obsidian app instance. (Inherited from AllWindowsStatusBarItemComponentConstructorParams) |
| cls? | readonly string[] | Extra CSS classes for each item. (Inherited from AllWindowsStatusBarItemComponentConstructorParams) |
| component | Component | The component that owns the items: they are removed when it unloads. |
| pluginId? | string | The 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.(Inherited from AllWindowsStatusBarItemComponentConstructorParams) |
| render | (params: AllWindowsStatusBarItemRenderParams) => void | Renders 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. (Inherited from AllWindowsStatusBarItemComponentConstructorParams) |
| shouldCreateMissingStatusBar? | boolean | Whether 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.(Inherited from AllWindowsStatusBarItemComponentConstructorParams) |
Links to this page: