@sap-ux/ui-components
Version:
SAP UI Components Library
31 lines • 1.36 kB
TypeScript
import React from 'react';
import './UIQuickNavigation.scss';
export declare const QUICK_NAVIGATION_ATTRIBUTE = "data-quick-navigation-key";
export declare const QUICK_NAVIGATION_ATTRIBUTE_OFFSET_Y = "data-quick-navigation-offset-y";
export declare const QUICK_NAVIGATION_ATTRIBUTE_OFFSET_X = "data-quick-navigation-offset-x";
export interface UIQuickNavigationAttribute {
[QUICK_NAVIGATION_ATTRIBUTE]: string;
[QUICK_NAVIGATION_ATTRIBUTE_OFFSET_Y]?: string;
[QUICK_NAVIGATION_ATTRIBUTE_OFFSET_X]?: string;
}
export declare const setQuickNavigationKey: (key: string, offset?: UIQuickNavigationOffset) => UIQuickNavigationAttribute;
export interface UIQuickNavigationOffset {
x: number;
y: number;
}
export interface UIQuickNavigationProps {
className?: string;
children: React.ReactNode;
inline?: boolean;
offset?: UIQuickNavigationOffset;
}
/**
* Method checks if quick navigation should be enabled for passed keyboard event.
* Quick navigation is enabled when user hold 'ctrl + alt' or 'meta + alt'.
*
* @param event Keyboard event.
* @returns True if quick navigation should be enabled for passed keyboard event.
*/
export declare const isQuickNavigationEnabled: (event: KeyboardEvent) => boolean;
export declare const UIQuickNavigation: React.FC<UIQuickNavigationProps>;
//# sourceMappingURL=UIQuickNavigation.d.ts.map