build69
build69  /  Components  /  ShortcutHelp /  Source

ShortcutHelp

Keyboard-shortcuts help dialog built on Radix Dialog. Documents app shortcuts as a grouped two-column list of Kbd keycaps ("mod" renders ⌘ on macOS, Ctrl elsewhere), with a filter-as-you-type search field and a global ho

3 files2 dependenciestokens resolved ✓
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
"use client";

import * as React from "react";
import { cn } from "@/lib/utils";
import { surface, type Tone, type Emphasis } from "@/lib/recipes";

// ShortcutHelp — Keyboard-shortcuts help dialog built on Radix Dialog. Documents app shortcuts as a group
export interface ShortcutHelpProps extends React.ComponentProps<"div"> {
  /** Semantic role: which accent the component uses. */
  tone?: Tone;
  /** Visual loudness: how prominent it reads. */
  emphasis?: Emphasis;
}

export function ShortcutHelp({
  className,
  tone = "primary",
  emphasis = "solid",
  ...props
}: ShortcutHelpProps) {
  return (
    <div
      data-slot="shortcut-help"
      data-tone={tone}
      data-emphasis={emphasis}
      className={cn(
        "inline-flex items-center gap-2 rounded-lg transition-colors",
        surface(tone, emphasis),
        className,
      )}
      {...props}
    />
  );
}