Files
Danny White 8939c97574 chore(studio): standardise keyboard shortcut UI (#44262)
## What kind of change does this PR introduce?

Chore / UI consistency fix. Resolves DEPR-418.

## What is the current behavior?

Shortcut hints are still hand-built in several high-traffic Studio
surfaces, which leads to inconsistent rendering and stale
platform-specific markup. Buttons in particular can end up with awkward
spacing and baseline alignment when shortcut labels are inserted
directly into the button text.

## What is the new behavior?

This PR standardises those shortcut hints around `KeyboardShortcut` and
updates the surrounding layout primitives to support that approach more
cleanly.

It includes:
- Design docs
- using `KeyboardShortcut` in the table side-panel `ActionBar`
- replacing hardcoded operation queue button shortcuts in
`OperationQueueSidePanel`
- standardising the command menu trigger shortcut chip and updating the
`LayoutHeader` overrides to match the new DOM shape
- replacing the AI editor empty-state `Cmd/Ctrl + K` hint with
`KeyboardShortcut`
- refining shared shortcut/button primitives so inline shortcuts align
better when used as button accessories
- keeping the SQL utility shortcut work on this branch consistent with
the same shared component approach

| Before | After |
| --- | --- |
| <img width="1454" height="902" alt="CleanShot 2026-03-27 at 15 55
32@2x"
src="https://github.com/user-attachments/assets/3a8de192-3f4c-480b-9d26-9b28becd0ee3"
/> | <img width="1488" height="906" alt="CleanShot 2026-03-27 at 15 29
31@2x-63A17C58-D023-4D3A-9355-6C40A6485328"
src="https://github.com/user-attachments/assets/46ef7f7a-2b8b-4c10-8935-84ca5ad44562"
/> |
| <img width="738" height="328" alt="CleanShot 2026-03-27 at 15 57
07@2x"
src="https://github.com/user-attachments/assets/ad459c41-867d-42f9-a8cb-c936af8326b7"
/> | <img width="726" height="290" alt="CleanShot 2026-03-27 at 15 56
29@2x-ECE4E10F-9693-4ED8-B085-DC436A839F52"
src="https://github.com/user-attachments/assets/95b4bfb4-ec34-4080-8b69-211b5045ca26"
/> |

## Later todo

- [ ] Replace the string-based SQL editor placeholder shortcut in
`SQLEditor` once that placeholder API supports rich content
- [ ] Refactor `CommandOption` to use `KeyboardShortcut` instead of
bespoke platform detection and command-key markup
- [ ] Standardise the remaining DataTable shortcut hints
(`DataTableToolbar`, `DataTableResetButton`, `DataTableFilterCommand`,
`DataTableFilterControlsDrawer`) around `KeyboardShortcut`


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **New Features**
* Introduced a new KeyboardShortcut component for displaying keyboard
shortcuts with two visual variants (pill and inline).
* Standardized keyboard shortcut indicators across the application
interface for consistent user experience.

* **Bug Fixes**
* Fixed capitalization inconsistencies in button labels and hotkey
settings.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-08 09:42:55 -06:00

297 lines
11 KiB
TypeScript

import { LOCAL_STORAGE_KEYS, useParams } from 'common'
import dayjs from 'dayjs'
import { DevToolbarTrigger } from 'dev-tools'
import { AnimatePresence, motion } from 'framer-motion'
import { ChevronLeft } from 'lucide-react'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { ReactNode, useMemo } from 'react'
import { Badge, cn } from 'ui'
import { CommandMenuTriggerInput } from 'ui-patterns'
import { BreadcrumbsView } from './BreadcrumbsView'
import { FeedbackDropdown } from './FeedbackDropdown/FeedbackDropdown'
import { HeaderUpgradeButton } from './HeaderUpgradeButton'
import { HomeIcon } from './HomeIcon'
import { LocalVersionPopover } from './LocalVersionPopover'
import { MergeRequestButton } from './MergeRequestButton'
import {
useIsBranching2Enabled,
useIsFloatingMobileToolbarEnabled,
} from '@/components/interfaces/App/FeaturePreview/FeaturePreviewContext'
import { ConnectButton } from '@/components/interfaces/ConnectButton/ConnectButton'
import { ConnectSheet } from '@/components/interfaces/ConnectSheet/ConnectSheet'
import { LocalDropdown } from '@/components/interfaces/LocalDropdown'
import { UserDropdown } from '@/components/interfaces/UserDropdown'
import { AdvisorButton } from '@/components/layouts/AppLayout/AdvisorButton'
import { AssistantButton } from '@/components/layouts/AppLayout/AssistantButton'
import { BranchDropdown } from '@/components/layouts/AppLayout/BranchDropdown'
import { InlineEditorButton } from '@/components/layouts/AppLayout/InlineEditorButton'
import { OrganizationDropdown } from '@/components/layouts/AppLayout/OrganizationDropdown'
import { ProjectDropdown } from '@/components/layouts/AppLayout/ProjectDropdown'
import { HelpButton } from '@/components/ui/HelpPanel/HelpButton'
import { getResourcesExceededLimitsOrg } from '@/components/ui/OveragesBanner/OveragesBanner.utils'
import { useOrgUsageQuery } from '@/data/usage/org-usage-query'
import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { IS_PLATFORM } from '@/lib/constants'
const LayoutHeaderDivider = ({ className, ...props }: React.HTMLProps<HTMLSpanElement>) => (
<span className={cn('text-border-stronger pr-2', className)} {...props}>
<svg
viewBox="0 0 24 24"
width="16"
height="16"
stroke="currentColor"
strokeWidth="1"
strokeLinecap="round"
strokeLinejoin="round"
fill="none"
shapeRendering="geometricPrecision"
aria-hidden={true}
>
<path d="M16 3.549L7.12 20.600" />
</svg>
</span>
)
interface LayoutHeaderProps {
customHeaderComponents?: ReactNode
breadcrumbs?: unknown[]
headerTitle?: string
backToDashboardURL?: string
}
export const LayoutHeader = ({
customHeaderComponents,
breadcrumbs = [],
headerTitle,
backToDashboardURL,
}: LayoutHeaderProps) => {
const router = useRouter()
const { ref: projectRef, slug } = useParams()
const { data: selectedProject } = useSelectedProjectQuery()
const { data: selectedOrganization } = useSelectedOrganizationQuery()
const gitlessBranching = useIsBranching2Enabled()
const showFloatingMobileToolbar = useIsFloatingMobileToolbarEnabled()
const [commandMenuEnabled] = useLocalStorageQuery(LOCAL_STORAGE_KEYS.HOTKEY_COMMAND_MENU, true)
const isAccountPage = router.pathname.startsWith('/account')
// We only want to query the org usage and check for possible over-ages for plans without usage billing enabled (free or pro with spend cap)
const { data: orgUsage } = useOrgUsageQuery(
{ orgSlug: selectedOrganization?.slug },
{ enabled: selectedOrganization?.usage_billing_enabled === false }
)
const exceedingLimits = useMemo(() => {
if (orgUsage) {
return getResourcesExceededLimitsOrg(orgUsage?.usages || []).length > 0
} else {
return false
}
}, [orgUsage])
const isNewProject =
selectedProject?.inserted_at !== undefined &&
dayjs(selectedProject.inserted_at).isAfter(dayjs().subtract(5, 'day'))
const connectButtonType = isNewProject ? 'primary' : 'default'
// show org selection if we are on a project page or on a explicit org route
const showOrgSelection = slug || (selectedOrganization && projectRef)
return (
<>
<header
className={cn(
'flex h-11 md:h-12 items-center flex-shrink-0 border-b',
showFloatingMobileToolbar && 'hidden md:flex'
)}
>
{backToDashboardURL && isAccountPage && (
<div className="flex items-center justify-center border-r flex-0 md:hidden h-full aspect-square">
<Link
href={backToDashboardURL}
className="flex items-center justify-center border-none !bg-transparent rounded-md min-w-[30px] w-[30px] h-[30px] text-foreground-lighter hover:text-foreground transition-colors"
>
<ChevronLeft strokeWidth={1.5} size={16} />
</Link>
</div>
)}
<div
className={cn(
'flex items-center justify-between h-full pr-3 flex-1 overflow-x-auto gap-x-8 pl-4'
)}
>
<div className="flex md:hidden items-center text-sm not-sr-only">
<AnimatePresence>
{headerTitle && (
<motion.div
className="flex items-center -ml-1"
initial={{ opacity: 0, x: -20 }}
animate={{ opacity: 1, x: 0 }}
exit={{ opacity: 0, x: -20 }}
transition={{
duration: 0.15,
ease: 'easeOut',
}}
>
<LayoutHeaderDivider />
<span className="text-foreground">{headerTitle}</span>
</motion.div>
)}
</AnimatePresence>
</div>
<div className="hidden md:flex items-center text-sm">
<HomeIcon />
<div className="flex items-center md:pl-2">
{showOrgSelection && IS_PLATFORM ? (
<>
<LayoutHeaderDivider className="hidden md:block" />
<OrganizationDropdown />
</>
) : null}
<AnimatePresence>
{projectRef && (
<motion.div
className="flex items-center"
initial={{ opacity: 0, x: -20 }}
animate={{ opacity: 1, x: 0 }}
exit={{ opacity: 0, x: -20 }}
transition={{
duration: 0.15,
ease: 'easeOut',
}}
>
{IS_PLATFORM && <LayoutHeaderDivider />}
<ProjectDropdown />
{exceedingLimits && (
<div className="ml-2">
<Link href={`/org/${selectedOrganization?.slug}/usage`}>
<Badge variant="destructive">Exceeding usage limits</Badge>
</Link>
</div>
)}
{selectedProject && IS_PLATFORM && (
<>
<LayoutHeaderDivider />
<BranchDropdown />
</>
)}
</motion.div>
)}
</AnimatePresence>
</div>
<AnimatePresence>
{headerTitle && (
<motion.div
className="flex items-center"
initial={{ opacity: 0, x: -20 }}
animate={{ opacity: 1, x: 0 }}
exit={{ opacity: 0, x: -20 }}
transition={{
duration: 0.15,
ease: 'easeOut',
}}
>
<LayoutHeaderDivider />
<span className="text-foreground">{headerTitle}</span>
</motion.div>
)}
</AnimatePresence>
<AnimatePresence>
{projectRef && (
<motion.div
className="ml-3 items-center gap-x-2 flex"
initial={{ opacity: 0, x: -20 }}
animate={{ opacity: 1, x: 0 }}
exit={{ opacity: 0, x: -20 }}
transition={{
duration: 0.15,
ease: 'easeOut',
}}
>
{IS_PLATFORM && gitlessBranching && <MergeRequestButton />}
<ConnectButton buttonType={connectButtonType} />
</motion.div>
)}
</AnimatePresence>
<BreadcrumbsView defaultValue={breadcrumbs} />
</div>
<div className="flex items-center gap-x-2">
{customHeaderComponents && customHeaderComponents}
{IS_PLATFORM ? (
<>
<DevToolbarTrigger />
<FeedbackDropdown />
<div className="flex items-center gap-1 md:gap-2">
<CommandMenuTriggerInput
showShortcut={commandMenuEnabled}
placeholder="Search..."
className={cn(
'hidden md:flex md:min-w-32 xl:min-w-32 rounded-full bg-transparent',
'[&_.command-shortcut]:border-none',
'[&_.command-shortcut]:pr-2',
'[&_.command-shortcut]:bg-transparent',
'[&_.command-shortcut]:text-foreground-lighter',
'[&_.command-shortcut]:shadow-none'
)}
/>
<HelpButton />
<AdvisorButton projectRef={projectRef} />
<AnimatePresence initial={false}>
{!!projectRef && (
<>
<InlineEditorButton />
<AssistantButton />
</>
)}
</AnimatePresence>
</div>
<HeaderUpgradeButton className="hidden md:flex" />
<UserDropdown triggerClassName="hidden md:flex" />
</>
) : (
<>
<LocalVersionPopover />
<div className="flex items-center gap-1 md:gap-2">
<CommandMenuTriggerInput
placeholder="Search..."
className="hidden md:flex md:min-w-32 xl:min-w-32 rounded-full bg-transparent
[&_.command-shortcut]:border-none
[&_.command-shortcut]:pr-2
[&_.command-shortcut]:bg-transparent
[&_.command-shortcut]:text-foreground-lighter
[&_.command-shortcut]:shadow-none
"
/>
<HelpButton />
<AdvisorButton projectRef={projectRef} />
<AnimatePresence initial={false}>
{!!projectRef && (
<>
<InlineEditorButton />
<AssistantButton />
</>
)}
</AnimatePresence>
</div>
<LocalDropdown triggerClassName="hidden md:flex" />
</>
)}
</div>
</div>
</header>
<ConnectSheet />
</>
)
}