@primer/react/lib/KeybindingHint/KeybindingHint.d.ts

An implementation of GitHub's Primer Design System using React

import React from 'react';
import type { KeybindingHintProps } from './props';
/** Indicates the presence of an available keybinding. */
export declare const KeybindingHint: React.MemoExoticComponent<({ className, ...props }: KeybindingHintProps) => React.JSX.Element>;
/**
 * AVOID: `KeybindingHint` is nearly always sufficient for providing both visible and accessible keyboard hints, and
 * will result in a good screen reader experience when used as the target for `aria-describedby` and `aria-labelledby`.
 * However, there may be cases where we need a plain string version, such as when building `aria-label` or
 * `aria-description`. In that case, this plain string builder can be used instead.
 *
 * NOTE that this string should _only_ be used when building `aria-label` or `aria-description` props (never rendered
 * visibly) and should nearly always also be paired with a visible hint for sighted users.
 */
export declare const getAccessibleKeybindingHintString: (sequence: string, isMacOS: boolean) => string;
//# sourceMappingURL=KeybindingHint.d.ts.map