Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

feat(docsite): add keyboard search shortcut (#3144)

David Petersen3de9b2b2a3e0
diff --git a/apps/docsite/src/__tests__/search-palette.test.ts b/apps/docsite/src/__tests__/search-palette.test.ts
index 7c47748c35..f93204bb5d 100644
--- a/apps/docsite/src/__tests__/search-palette.test.ts
+++ b/apps/docsite/src/__tests__/search-palette.test.ts
@@ -65,4 +65,14 @@ describe('SearchPalette data', () => {
'/components/DropdownMenu',
);
});
+
+ it('finds AppShell when searching for app shell with a space', () => {
+ const items = buildItems();
+ const appShell = items.find(item => item.id === '/components/AppShell');
+ expect(appShell?.label).toBe('App Shell');
+
+ expect(searchItems('app shell').map(item => item.id)).toContain(
+ '/components/AppShell',
+ );
+ });
});
diff --git a/apps/docsite/src/components/SharedTopNav.tsx b/apps/docsite/src/components/SharedTopNav.tsx
index f3f7ea04dd..cbf0539eae 100644
--- a/apps/docsite/src/components/SharedTopNav.tsx
+++ b/apps/docsite/src/components/SharedTopNav.tsx
@@ -2,7 +2,7 @@
'use client';
-import {useState} from 'react';
+import {useEffect, useState} from 'react';
import {usePathname} from 'next/navigation';
import {TopNav, TopNavHeading, TopNavItem} from '@astryxdesign/core/TopNav';
import {Button} from '@astryxdesign/core/Button';
@@ -40,6 +40,27 @@ export function SharedTopNav() {
const pathname = usePathname();
const {mode, toggleMode} = useThemeMode();
+ useEffect(() => {
+ const onKeyDown = (event: KeyboardEvent) => {
+ if (event.defaultPrevented) {
+ return;
+ }
+ if (
+ (event.metaKey || event.ctrlKey) &&
+ !event.shiftKey &&
+ !event.altKey &&
+ event.key.toLowerCase() === 'k'
+ ) {
+ event.preventDefault();
+ trackSearch({target: 'open'});
+ setIsSearchOpen(true);
+ }
+ };
+
+ document.addEventListener('keydown', onKeyDown);
+ return () => document.removeEventListener('keydown', onKeyDown);
+ }, []);
+
// Determine active nav item
const getActiveItem = () => {
if (
diff --git a/apps/docsite/src/components/searchPaletteData.ts b/apps/docsite/src/components/searchPaletteData.ts
index 6789d0bcb2..7b0049a603 100644
--- a/apps/docsite/src/components/searchPaletteData.ts
+++ b/apps/docsite/src/components/searchPaletteData.ts
@@ -29,8 +29,19 @@ function uniqueKeywords(keywords: Array<string | null | undefined>): string[] {
return [...new Set(keywords.filter((kw): kw is string => Boolean(kw)))];
}
+function splitWords(value: string): string {
+ return value.replace(/([a-z0-9])([A-Z])/g, '$1 $2').replace(/[_-]+/g, ' ');
+}
+
export function getSearchItemKeywords(item: SearchItem): string[] {
- return [item.auxiliaryData.group, ...item.auxiliaryData.keywords];
+ return [
+ item.auxiliaryData.group,
+ splitWords(item.label),
+ ...item.auxiliaryData.keywords.flatMap(keyword => [
+ keyword,
+ splitWords(keyword),
+ ]),
+ ];
}
export function buildSearchPaletteItems({
@@ -73,7 +84,9 @@ export function buildSearchPaletteItems({
// Neutral as the default seed; users browse to the specific
// theme they want via the sidebar picker.
items.push({
- id: isTheme ? '/themes' : `/docs/${pkg.name.replace('@astryxdesign/', '')}`,
+ id: isTheme
+ ? '/themes'
+ : `/docs/${pkg.name.replace('@astryxdesign/', '')}`,
label: pkg.displayName,
auxiliaryData: {
group: 'Package',