@neo4j-ndl/react
Version:
React implementation of Neo4j Design System
35 lines • 1.45 kB
TypeScript
/**
*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
export type OperatingSystem = 'mac' | 'windows' | 'linux';
export type KbdKey = 'meta' | 'shift' | 'ctrl' | 'enter' | 'delete' | 'escape' | 'tab' | 'capslock' | 'up' | 'right' | 'down' | 'left' | 'pageup' | 'pagedown' | 'home' | 'end' | 'space' | 'fn' | 'alt';
/**
* Detects the operating system based on the user agent
*/
export declare function detectOS(): OperatingSystem;
/**
* Returns OS-aware keyboard key symbols
*/
export declare function getKbdKeysMap(os?: OperatingSystem): Record<KbdKey, string>;
/**
* Returns OS-aware keyboard key labels
*/
export declare function getKbdKeysLabelMap(os?: OperatingSystem): Record<KbdKey, string>;
//# sourceMappingURL=kbd-utils.d.ts.map