Skip to content

WorkspaceLayoutStateKeyDefinition<T>

Defines a layout-scoped key.

Import:

import type { WorkspaceLayoutStateKeyDefinition } from '@mnaoumov/obsidian-lib/components/workspace-layout-state-component';

Signature:

export interface WorkspaceLayoutStateKeyDefinition<T>

Properties

PropertyTypeDescription
defaultValueTThe value read when nothing valid is stored.
isValid?(value: unknown) => value is TChecks a stored value. A value that fails reads as the default and stays stored until it is replaced or unset.
keystringThe key name, unique within the plugin.