@tanstack/hotkeys-devtools 0.9.0 → 1.1.0

package/src/components/Shell.tsx

@@ -1,171 +0,0 @@
-import {
-  createEffect,
-  createMemo,
-  createSignal,
-  onCleanup,
-  onMount,
-} from 'solid-js'
-import { Header, HeaderLogo, MainPanel } from '@tanstack/devtools-ui'
-import { useStyles } from '../styles/use-styles'
-import { useHotkeysDevtoolsState } from '../HotkeysContextProvider'
-import { HeldKeysBar } from './HeldKeysTopbar'
-import { HotkeyList } from './HotkeyList'
-import { DetailsPanel } from './DetailsPanel'
-
-function readResizeObserverBlockSize(entry: ResizeObserverEntry): number {
-  const [box] = entry.borderBoxSize
-  if (box !== undefined) return box.blockSize
-  return entry.contentRect.height
-}
-
-/** TanStack devtools plugin pane; percentage heights break without this. */
-function resolvePluginHost(el: HTMLElement): HTMLElement | null {
-  const found = el.closest('[id^="plugin-container-"]')
-  if (found instanceof HTMLElement) return found
-  let n: HTMLElement | null = el
-  for (let i = 0; i < 3 && n; i++) {
-    n = n.parentElement
-  }
-  return n
-}
-
-export function Shell() {
-  const styles = useStyles()
-  const state = useHotkeysDevtoolsState()
-  const [selectedId, setSelectedId] = createSignal<string | null>(null)
-  const [leftPanelWidth, setLeftPanelWidth] = createSignal(300)
-  const [isDragging, setIsDragging] = createSignal(false)
-  const [shellRootEl, setShellRootEl] = createSignal<HTMLElement | null>(null)
-  const [slotHeightPx, setSlotHeightPx] = createSignal<number | undefined>(
-    undefined,
-  )
-
-  const selectedRegistration = createMemo(() => {
-    const id = selectedId()
-    if (!id) return null
-    const hotkey = state.registrations().find((r) => r.id === id)
-    if (hotkey) return hotkey
-    const sequence = state.sequenceRegistrations().find((r) => r.id === id)
-    return sequence ?? null
-  })
-
-  let dragStartX = 0
-  let dragStartWidth = 0
-
-  const handleMouseDown = (e: MouseEvent) => {
-    e.preventDefault()
-    e.stopPropagation()
-    setIsDragging(true)
-    document.body.style.cursor = 'col-resize'
-    document.body.style.userSelect = 'none'
-    dragStartX = e.clientX
-    dragStartWidth = leftPanelWidth()
-  }
-
-  const handleMouseMove = (e: MouseEvent) => {
-    if (!isDragging()) return
-
-    e.preventDefault()
-    const deltaX = e.clientX - dragStartX
-    const newWidth = Math.max(150, Math.min(800, dragStartWidth + deltaX))
-    setLeftPanelWidth(newWidth)
-  }
-
-  const handleMouseUp = () => {
-    setIsDragging(false)
-    document.body.style.cursor = ''
-    document.body.style.userSelect = ''
-  }
-
-  onMount(() => {
-    document.addEventListener('mousemove', handleMouseMove)
-    document.addEventListener('mouseup', handleMouseUp)
-  })
-
-  onCleanup(() => {
-    document.removeEventListener('mousemove', handleMouseMove)
-    document.removeEventListener('mouseup', handleMouseUp)
-  })
-
-  createEffect(() => {
-    const el = shellRootEl()
-    if (!el || typeof ResizeObserver === 'undefined') return
-    const pluginHost = resolvePluginHost(el)
-    if (!pluginHost) return
-
-    const applyHeight = (entry?: ResizeObserverEntry) => {
-      const clientH = pluginHost.clientHeight
-      const fromObserver =
-        entry !== undefined ? readResizeObserverBlockSize(entry) : 0
-      const h = clientH > 0 ? clientH : fromObserver
-      if (h > 0) setSlotHeightPx(Math.round(h))
-    }
-
-    applyHeight()
-    const ro = new ResizeObserver((entries) => {
-      applyHeight(entries[0])
-    })
-    ro.observe(pluginHost)
-    onCleanup(() => ro.disconnect())
-  })
-
-  return (
-    <div
-      ref={(el) => setShellRootEl(el)}
-      class={styles().shellRoot}
-      style={{
-        ...(slotHeightPx() !== undefined
-          ? {
-              height: `${slotHeightPx()}px`,
-              'max-height': `${slotHeightPx()}px`,
-            }
-          : {}),
-      }}
-    >
-      <MainPanel class={styles().mainPanelShell}>
-        <Header>
-          <HeaderLogo
-            flavor={{
-              light: 'oklch(51.4% 0.222 16.935)',
-              dark: 'oklch(58.6% 0.253 17.585)',
-            }}
-          >
-            TanStack Hotkeys
-          </HeaderLogo>
-        </Header>
-
-        <div class={styles().mainContainer}>
-          <HeldKeysBar />
-
-          <div class={styles().panelsContainer}>
-            <div
-              class={styles().leftPanel}
-              style={{
-                width: `${leftPanelWidth()}px`,
-                'min-width': '150px',
-                'max-width': '800px',
-              }}
-            >
-              <div class={styles().leftPanelScroll}>
-                <HotkeyList
-                  selectedId={selectedId}
-                  setSelectedId={setSelectedId}
-                />
-              </div>
-            </div>
-
-            <div
-              class={`${styles().dragHandle} ${isDragging() ? 'dragging' : ''}`}
-              onMouseDown={handleMouseDown}
-            />
-
-            <div class={styles().rightPanel} style={{ flex: 1 }}>
-              <div class={styles().panelHeader}>Details</div>
-              <DetailsPanel selectedRegistration={selectedRegistration} />
-            </div>
-          </div>
-        </div>
-      </MainPanel>
-    </div>
-  )
-}

package/src/components/index.tsx

@@ -1,19 +0,0 @@
-import { ThemeContextProvider } from '@tanstack/devtools-ui'
-import { HotkeysContextProvider } from '../HotkeysContextProvider'
-import { Shell } from './Shell'
-
-import type { TanStackDevtoolsTheme } from '@tanstack/devtools-ui'
-
-interface DevtoolsProps {
-  theme: TanStackDevtoolsTheme
-}
-
-export default function HotkeysDevtools(props: DevtoolsProps) {
-  return (
-    <ThemeContextProvider theme={props.theme}>
-      <HotkeysContextProvider>
-        <Shell />
-      </HotkeysContextProvider>
-    </ThemeContextProvider>
-  )
-}

package/src/core.tsx

@@ -1,11 +0,0 @@
-import { constructCoreClass } from '@tanstack/devtools-utils/solid'
-import type { ClassType } from '@tanstack/devtools-utils/solid'
-
-const loadComponent = () => import('./components/index')
-
-export interface HotkeysDevtoolsInit {}
-
-const coreClasses = constructCoreClass(loadComponent)
-
-export const HotkeysDevtoolsCore: ClassType = coreClasses[0]
-export const HotkeysDevtoolsCoreNoOp: ClassType = coreClasses[1]

package/src/index.ts

@@ -1,11 +0,0 @@
-'use client'
-
-import * as Devtools from './core'
-import type { ClassType } from '@tanstack/devtools-utils/solid'
-
-export const HotkeysDevtoolsCore: ClassType =
-  process.env.NODE_ENV !== 'development'
-    ? Devtools.HotkeysDevtoolsCoreNoOp
-    : Devtools.HotkeysDevtoolsCore
-
-export type { HotkeysDevtoolsInit } from './core'

package/src/production.ts

@@ -1,5 +0,0 @@
-'use client'
-
-export { HotkeysDevtoolsCore } from './core'
-
-export type { HotkeysDevtoolsInit } from './core'

package/src/sequence-progress.ts

@@ -1,29 +0,0 @@
-import { DEFAULT_SEQUENCE_TIMEOUT } from '@tanstack/hotkeys'
-import type { SequenceRegistrationView } from '@tanstack/hotkeys'
-
-/**
- * Matched step count for UI, accounting for inter-key timeout even if the
- * manager has not processed another event yet.
- */
-export function effectiveSequenceMatchedSteps(
-  reg: SequenceRegistrationView,
-  now: number,
-): number {
-  const timeout = reg.options.timeout ?? DEFAULT_SEQUENCE_TIMEOUT
-  if (
-    reg.matchedStepCount <= 0 ||
-    reg.partialMatchLastKeyTime <= 0 ||
-    now - reg.partialMatchLastKeyTime > timeout
-  ) {
-    return 0
-  }
-  return reg.matchedStepCount
-}
-
-/** Whether the devtools should run a short interval to refresh sequence progress UI. */
-export function needsSequenceProgressClock(
-  regs: Array<SequenceRegistrationView>,
-  now: number,
-): boolean {
-  return regs.some((reg) => effectiveSequenceMatchedSteps(reg, now) > 0)
-}

package/src/styles/tokens.ts

@@ -1,305 +0,0 @@
-export const tokens = {
-  colors: {
-    inherit: 'inherit',
-    current: 'currentColor',
-    transparent: 'transparent',
-    black: '#000000',
-    white: '#ffffff',
-    neutral: {
-      50: '#f9fafb',
-      100: '#f2f4f7',
-      200: '#eaecf0',
-      300: '#d0d5dd',
-      400: '#98a2b3',
-      500: '#667085',
-      600: '#475467',
-      700: '#344054',
-      800: '#1d2939',
-      900: '#101828',
-    },
-    darkGray: {
-      50: '#525c7a',
-      100: '#49536e',
-      200: '#414962',
-      300: '#394056',
-      400: '#313749',
-      500: '#292e3d',
-      600: '#212530',
-      700: '#191c24',
-      800: '#111318',
-      900: '#0b0d10',
-    },
-    gray: {
-      50: '#f9fafb',
-      100: '#f2f4f7',
-      200: '#eaecf0',
-      300: '#d0d5dd',
-      400: '#98a2b3',
-      500: '#667085',
-      600: '#475467',
-      700: '#344054',
-      800: '#1d2939',
-      900: '#101828',
-    },
-    blue: {
-      25: '#F5FAFF',
-      50: '#EFF8FF',
-      100: '#D1E9FF',
-      200: '#B2DDFF',
-      300: '#84CAFF',
-      400: '#53B1FD',
-      500: '#2E90FA',
-      600: '#1570EF',
-      700: '#175CD3',
-      800: '#1849A9',
-      900: '#194185',
-    },
-    green: {
-      25: '#F6FEF9',
-      50: '#ECFDF3',
-      100: '#D1FADF',
-      200: '#A6F4C5',
-      300: '#6CE9A6',
-      400: '#32D583',
-      500: '#12B76A',
-      600: '#039855',
-      700: '#027A48',
-      800: '#05603A',
-      900: '#054F31',
-    },
-    red: {
-      50: '#fef2f2',
-      100: '#fee2e2',
-      200: '#fecaca',
-      300: '#fca5a5',
-      400: '#f87171',
-      500: '#ef4444',
-      600: '#dc2626',
-      700: '#b91c1c',
-      800: '#991b1b',
-      900: '#7f1d1d',
-      950: '#450a0a',
-    },
-    yellow: {
-      25: '#FFFCF5',
-      50: '#FFFAEB',
-      100: '#FEF0C7',
-      200: '#FEDF89',
-      300: '#FEC84B',
-      400: '#FDB022',
-      500: '#F79009',
-      600: '#DC6803',
-      700: '#B54708',
-      800: '#93370D',
-      900: '#7A2E0E',
-    },
-    purple: {
-      25: '#FAFAFF',
-      50: '#F4F3FF',
-      100: '#EBE9FE',
-      200: '#D9D6FE',
-      300: '#BDB4FE',
-      400: '#9B8AFB',
-      500: '#7A5AF8',
-      600: '#6938EF',
-      700: '#5925DC',
-      800: '#4A1FB8',
-      900: '#3E1C96',
-    },
-    teal: {
-      25: '#F6FEFC',
-      50: '#F0FDF9',
-      100: '#CCFBEF',
-      200: '#99F6E0',
-      300: '#5FE9D0',
-      400: '#2ED3B7',
-      500: '#15B79E',
-      600: '#0E9384',
-      700: '#107569',
-      800: '#125D56',
-      900: '#134E48',
-    },
-    pink: {
-      25: '#fdf2f8',
-      50: '#fce7f3',
-      100: '#fbcfe8',
-      200: '#f9a8d4',
-      300: '#f472b6',
-      400: '#ec4899',
-      500: '#db2777',
-      600: '#be185d',
-      700: '#9d174d',
-      800: '#831843',
-      900: '#500724',
-    },
-    cyan: {
-      25: '#ecfeff',
-      50: '#cffafe',
-      100: '#a5f3fc',
-      200: '#67e8f9',
-      300: '#22d3ee',
-      400: '#06b6d4',
-      500: '#0891b2',
-      600: '#0e7490',
-      700: '#155e75',
-      800: '#164e63',
-      900: '#083344',
-    },
-  },
-  alpha: {
-    100: 'ff',
-    90: 'e5',
-    80: 'cc',
-    70: 'b3',
-    60: '99',
-    50: '80',
-    40: '66',
-    30: '4d',
-    20: '33',
-    10: '1a',
-    0: '00',
-  },
-  font: {
-    size: {
-      '2xs': 'calc(var(--tsrd-font-size) * 0.625)',
-      xs: 'calc(var(--tsrd-font-size) * 0.75)',
-      sm: 'calc(var(--tsrd-font-size) * 0.875)',
-      md: 'var(--tsrd-font-size)',
-      lg: 'calc(var(--tsrd-font-size) * 1.125)',
-      xl: 'calc(var(--tsrd-font-size) * 1.25)',
-      '2xl': 'calc(var(--tsrd-font-size) * 1.5)',
-      '3xl': 'calc(var(--tsrd-font-size) * 1.875)',
-      '4xl': 'calc(var(--tsrd-font-size) * 2.25)',
-      '5xl': 'calc(var(--tsrd-font-size) * 3)',
-      '6xl': 'calc(var(--tsrd-font-size) * 3.75)',
-      '7xl': 'calc(var(--tsrd-font-size) * 4.5)',
-      '8xl': 'calc(var(--tsrd-font-size) * 6)',
-      '9xl': 'calc(var(--tsrd-font-size) * 8)',
-    },
-    lineHeight: {
-      '3xs': 'calc(var(--tsrd-font-size) * 0.75)',
-      '2xs': 'calc(var(--tsrd-font-size) * 0.875)',
-      xs: 'calc(var(--tsrd-font-size) * 1)',
-      sm: 'calc(var(--tsrd-font-size) * 1.25)',
-      md: 'calc(var(--tsrd-font-size) * 1.5)',
-      lg: 'calc(var(--tsrd-font-size) * 1.75)',
-      xl: 'calc(var(--tsrd-font-size) * 2)',
-      '2xl': 'calc(var(--tsrd-font-size) * 2.25)',
-      '3xl': 'calc(var(--tsrd-font-size) * 2.5)',
-      '4xl': 'calc(var(--tsrd-font-size) * 2.75)',
-      '5xl': 'calc(var(--tsrd-font-size) * 3)',
-      '6xl': 'calc(var(--tsrd-font-size) * 3.25)',
-      '7xl': 'calc(var(--tsrd-font-size) * 3.5)',
-      '8xl': 'calc(var(--tsrd-font-size) * 3.75)',
-      '9xl': 'calc(var(--tsrd-font-size) * 4)',
-    },
-    weight: {
-      thin: '100',
-      extralight: '200',
-      light: '300',
-      normal: '400',
-      medium: '500',
-      semibold: '600',
-      bold: '700',
-      extrabold: '800',
-      black: '900',
-    },
-    fontFamily: {
-      sans: 'ui-sans-serif, Inter, system-ui, sans-serif, sans-serif',
-      mono: `ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace`,
-    },
-  },
-  breakpoints: {
-    xs: '320px',
-    sm: '640px',
-    md: '768px',
-    lg: '1024px',
-    xl: '1280px',
-    '2xl': '1536px',
-  },
-  border: {
-    radius: {
-      none: '0px',
-      xs: 'calc(var(--tsrd-font-size) * 0.125)',
-      sm: 'calc(var(--tsrd-font-size) * 0.25)',
-      md: 'calc(var(--tsrd-font-size) * 0.375)',
-      lg: 'calc(var(--tsrd-font-size) * 0.5)',
-      xl: 'calc(var(--tsrd-font-size) * 0.75)',
-      '2xl': 'calc(var(--tsrd-font-size) * 1)',
-      '3xl': 'calc(var(--tsrd-font-size) * 1.5)',
-      full: '9999px',
-    },
-  },
-  size: {
-    0: '0px',
-    0.25: 'calc(var(--tsrd-font-size) * 0.0625)',
-    0.5: 'calc(var(--tsrd-font-size) * 0.125)',
-    1: 'calc(var(--tsrd-font-size) * 0.25)',
-    1.5: 'calc(var(--tsrd-font-size) * 0.375)',
-    2: 'calc(var(--tsrd-font-size) * 0.5)',
-    2.5: 'calc(var(--tsrd-font-size) * 0.625)',
-    3: 'calc(var(--tsrd-font-size) * 0.75)',
-    3.5: 'calc(var(--tsrd-font-size) * 0.875)',
-    4: 'calc(var(--tsrd-font-size) * 1)',
-    4.5: 'calc(var(--tsrd-font-size) * 1.125)',
-    5: 'calc(var(--tsrd-font-size) * 1.25)',
-    5.5: 'calc(var(--tsrd-font-size) * 1.375)',
-    6: 'calc(var(--tsrd-font-size) * 1.5)',
-    6.5: 'calc(var(--tsrd-font-size) * 1.625)',
-    7: 'calc(var(--tsrd-font-size) * 1.75)',
-    8: 'calc(var(--tsrd-font-size) * 2)',
-    9: 'calc(var(--tsrd-font-size) * 2.25)',
-    10: 'calc(var(--tsrd-font-size) * 2.5)',
-    11: 'calc(var(--tsrd-font-size) * 2.75)',
-    12: 'calc(var(--tsrd-font-size) * 3)',
-    14: 'calc(var(--tsrd-font-size) * 3.5)',
-    16: 'calc(var(--tsrd-font-size) * 4)',
-    20: 'calc(var(--tsrd-font-size) * 5)',
-    24: 'calc(var(--tsrd-font-size) * 6)',
-    28: 'calc(var(--tsrd-font-size) * 7)',
-    32: 'calc(var(--tsrd-font-size) * 8)',
-    36: 'calc(var(--tsrd-font-size) * 9)',
-    40: 'calc(var(--tsrd-font-size) * 10)',
-    44: 'calc(var(--tsrd-font-size) * 11)',
-    48: 'calc(var(--tsrd-font-size) * 12)',
-    52: 'calc(var(--tsrd-font-size) * 13)',
-    56: 'calc(var(--tsrd-font-size) * 14)',
-    60: 'calc(var(--tsrd-font-size) * 15)',
-    64: 'calc(var(--tsrd-font-size) * 16)',
-    72: 'calc(var(--tsrd-font-size) * 18)',
-    80: 'calc(var(--tsrd-font-size) * 20)',
-    96: 'calc(var(--tsrd-font-size) * 24)',
-  },
-  shadow: {
-    xs: (_: string = 'rgb(0 0 0 / 0.1)') =>
-      `0 1px 2px 0 rgb(0 0 0 / 0.05)` as const,
-    sm: (color: string = 'rgb(0 0 0 / 0.1)') =>
-      `0 1px 3px 0 ${color}, 0 1px 2px -1px ${color}` as const,
-    md: (color: string = 'rgb(0 0 0 / 0.1)') =>
-      `0 4px 6px -1px ${color}, 0 2px 4px -2px ${color}` as const,
-    lg: (color: string = 'rgb(0 0 0 / 0.1)') =>
-      `0 10px 15px -3px ${color}, 0 4px 6px -4px ${color}` as const,
-    xl: (color: string = 'rgb(0 0 0 / 0.1)') =>
-      `0 20px 25px -5px ${color}, 0 8px 10px -6px ${color}` as const,
-    '2xl': (color: string = 'rgb(0 0 0 / 0.25)') =>
-      `0 25px 50px -12px ${color}` as const,
-    inner: (color: string = 'rgb(0 0 0 / 0.05)') =>
-      `inset 0 2px 4px 0 ${color}` as const,
-    none: () => `none` as const,
-  },
-  zIndices: {
-    hide: -1,
-    auto: 'auto',
-    base: 0,
-    docked: 10,
-    dropdown: 1000,
-    sticky: 1100,
-    banner: 1200,
-    overlay: 1300,
-    modal: 1400,
-    popover: 1500,
-    skipLink: 1600,
-    toast: 1700,
-    tooltip: 1800,
-  },
-} as const