@stratakit/bricks/dist/Kbd.d.ts

Small, modular components for StrataKit

import type { BaseProps } from "@stratakit/foundations/secret-internals";
import type { PredefinedSymbol } from "./Kbd.internal.js";
interface KbdProps extends BaseProps<"kbd"> {
    /** @default "solid" */
    variant?: "solid" | "muted" | "ghost";
    /**
     * Display a specific key symbol from a predefined list. This is useful for
     * displaying modifier keys or special keys, such as `Control`, `Shift`, `Enter`, etc.
     *
     * Example:
     * ```tsx
     * <Kbd symbol="Control" />
     * ```
     */
    symbol?: PredefinedSymbol;
}
/**
 * A styled wrapper over the HTML `<kbd>` element. This is typically
 * used for displaying keyboard shortcuts.
 *
 * ```tsx
 * <Kbd>Ctrl</Kbd> <Kbd>S</Kbd>
 * ```
 *
 * ```tsx
 * <Kbd symbol="Control" />
 * ```
 */
declare const Kbd: import("react").ForwardRefExoticComponent<KbdProps & import("react").RefAttributes<HTMLElement>>;
export default Kbd;