Skip to content

KeyScope

Unofficial

A registered keyboard shortcut interceptor within a scope.

Import:

import type { KeyScope } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface KeyScope

Properties

PropertyTypeDescription
keynull | stringKey to match.
modifiersnull | stringModifiers to match.
scopeScopeobsidian#Scope where the key interceptor is registered.

Methods

MethodReturnsDescription
func()voidCallback of function to execute when key is pressed.

Links to this page: