mui-tiptap
Version:
A Material-UI (MUI) styled WYSIWYG rich text editor, using Tiptap
20 lines (19 loc) • 856 B
TypeScript
/**
* Return true if the user is using a Mac (as opposed to Windows, etc.) device.
*/
export declare function isMac(): boolean;
/**
* Return a human-readable version of which modifier key should be used for
* keyboard shortcuts depending on Mac vs non-Mac platforms. Useful for visually
* indicating which key to press.
*/
export declare function getModShortcutKey(): string;
/**
* Format an array of shortcut keys (e.g. ["mod", "Shift", "B"]) into a
* human-readable string (e.g. "Ctrl + Shift + B" or "⌘ + Shift + B"), suitable
* for use as an aria-description. Returns undefined if the array is empty or
* undefined.
*/
export declare function getShortcutKeysDescription(shortcutKeys: string[] | undefined): string | undefined;
/** Return true if the user is using a touch-based device. */
export declare function isTouchDevice(): boolean;