@keybindy/core/dist/ScopeManager.js

A lightweight and framework-agnostic keyboard shortcut manager for web apps. Define, register, and handle keybindings with ease.

import { warn } from './utils/log.js';

class ScopeManager {
    scopeStack = ['global'];
    /**
     * Pushes a new scope onto the scope stack.
     * @param scope - The scope to push.
     */
    pushScope(scope) {
        if (!scope)
            return;
        if (this.scopeStack.includes(scope))
            return;
        this.scopeStack.push(scope);
    }
    /**
     * Pops the last scope from the scope stack.
     */
    popScope() {
        if (this.scopeStack.length > 1) {
            this.scopeStack.pop();
        }
    }
    /**
     * Swaps the active scope with the scope at the given index.
     * @param scope - The scope to swap.
     * @param index - The index of the scope to swap.
     * @private
     */
    swap(scope, index) {
        const temp = this.scopeStack[index];
        this.scopeStack[index] = scope;
        this.scopeStack[this.scopeStack.length - 1] = temp;
    }
    /**
     * Activates the scope at the given index.
     * @param scope - The scope to activate.
     */
    setActiveScope(scope) {
        if (!scope)
            return;
        if (!this.scopeStack.includes(scope)) {
            warn('Scope not found: ' + scope);
            return;
        }
        const index = this.scopeStack.indexOf(scope);
        if (index === -1)
            return;
        this.swap(this.getActiveScope(), index);
    }
    /**
     * Resets the scope stack to the default state.
     */
    resetScope() {
        this.scopeStack = ['global'];
    }
    /**
     * Returns the active scope.
     * @returns The active scope.
     */
    getActiveScope() {
        return this.scopeStack[this.scopeStack.length - 1];
    }
    /**
     * Checks if the given scope is active.
     * @param scope - The scope to check.
     * @returns `true` if the scope is active, `false` otherwise.
     */
    isScopeActive(scope) {
        return this.getActiveScope() === (scope || 'global');
    }
    /**
     * Returns all scopes in the stack.
     * @returns An array of scopes.
     */
    getScopes() {
        return [...this.scopeStack];
    }
}

export { ScopeManager };