Files
supabase/apps/studio/components/interfaces/App/CommandMenu/ContextSearchCommands.tsx
T
Joshen Lim 09a1f431bc Mass update for all lucide icon imports to use the component with Icon suffix (#51659)
## Context

This is largely just a mechanical change here:
Opting to use lucide icons with the `Icon` suffix across all icon
imports within `studio`
- so that it’s clearer which components are icons + reduces the
possibility of name collision with our own components
- e.g <User /> vs <UserIcon />

Also added a eslint rule for this:
<img width="1069" height="167" alt="image"
src="https://github.com/user-attachments/assets/7f36f443-5ca2-4bf6-8d22-86e774513bfc"
/>

And updated `AGENTS.md` as such:
```
Icons come from `lucide-react`, always imported with the `Icon` suffix (`import { CheckIcon, Trash2Icon } from 'lucide-react'`) — never the bare names (`Check`) or `Check as CheckIcon` aliases (lint-enforced).
```
2026-10-14 12:56:55 +02:00

165 lines
4.8 KiB
TypeScript

'use client'
import { useDebounce } from '@uidotdev/usehooks'
import { IS_PLATFORM } from 'common'
import { Auth, EdgeFunctions, Storage } from 'icons'
import { DatabaseIcon } from 'lucide-react'
import { useMemo, useState } from 'react'
import type { ICommand } from 'ui-patterns/CommandMenu'
import {
CommandHeader,
CommandMenuInput,
CommandWrapper,
PageType,
useQuery,
useRegisterCommands,
useRegisterPage,
useSetPage,
} from 'ui-patterns/CommandMenu'
import { COMMAND_MENU_SECTIONS } from './CommandMenu.utils'
import { ContextSearchResults } from './ContextSearchResults'
import { orderCommandSectionsByPriority } from './ordering'
import type { SearchContextValue } from './SearchContext.types'
import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
interface SearchContextOption {
value: SearchContextValue
label: string
pageName: string
placeholder: string
icon: React.ComponentType<React.SVGProps<SVGSVGElement>>
}
const SEARCH_CONTEXT_OPTIONS: SearchContextOption[] = [
{
value: 'database-tables',
label: 'Database Tables',
pageName: 'Search Database Tables',
placeholder: 'Search database schema or tables...',
icon: DatabaseIcon,
},
{
value: 'auth-policies',
label: 'RLS Policies',
pageName: 'Search RLS Policies',
placeholder: 'Search rls policies...',
icon: Auth,
},
{
value: 'edge-functions',
label: 'Edge Functions',
pageName: 'Search Edge Functions',
placeholder: 'Search edge functions...',
icon: EdgeFunctions,
},
{
value: 'storage',
label: 'Storage',
pageName: 'Search Storage',
placeholder: 'Search buckets...',
icon: Storage,
},
]
function ContextSearchPage({
context,
placeholder,
}: {
context: SearchContextValue
placeholder: string
}) {
const query = useQuery()
const [filterString, setFilterString] = useState('')
const debouncedFilterString = useDebounce(filterString, 300)
return (
<CommandWrapper shouldFilter={context !== 'database-tables'}>
<CommandHeader>
<CommandMenuInput
placeholder={placeholder}
value={filterString}
onValueChange={setFilterString}
/>
</CommandHeader>
<ContextSearchResults
context={context}
query={query}
debouncedFilterString={debouncedFilterString}
/>
</CommandWrapper>
)
}
export function useContextSearchCommands() {
const { data: project } = useSelectedProjectQuery()
const setPage = useSetPage()
const {
projectAuthAll: authEnabled,
projectEdgeFunctionAll: edgeFunctionsEnabled,
projectStorageAll: storageEnabled,
} = useIsFeatureEnabled(['project_auth:all', 'project_edge_function:all', 'project_storage:all'])
const pageDefinitions = [
{ title: 'Search Database Tables', context: 'database-tables' as const },
{ title: 'Search RLS Policies', context: 'auth-policies' as const },
{ title: 'Search Edge Functions', context: 'edge-functions' as const },
{ title: 'Search Storage', context: 'storage' as const },
]
// Register pages - pageDefinitions is constant, so hooks are called in consistent order
for (const { title, context } of pageDefinitions) {
const placeholder =
SEARCH_CONTEXT_OPTIONS.find((opt) => opt.value === context)?.placeholder ?? ''
// eslint-disable-next-line react-hooks/rules-of-hooks
useRegisterPage(title, {
type: PageType.Component,
component: () => <ContextSearchPage context={context} placeholder={placeholder} />,
})
}
const contextCommands = useMemo(() => {
return SEARCH_CONTEXT_OPTIONS.filter((option) => {
let isFeatureEnabled = false
switch (option.value) {
case 'database-tables':
isFeatureEnabled = true
break
case 'auth-policies':
isFeatureEnabled = authEnabled
break
case 'edge-functions':
isFeatureEnabled = edgeFunctionsEnabled
break
case 'storage':
isFeatureEnabled = storageEnabled
break
}
if (!isFeatureEnabled) return false
// If self-hosted, show if feature is enabled
if (!IS_PLATFORM) {
return true
}
// only show when inside a project if not self-hosted
return !!project
}).map((option) => ({
id: `search-${option.value}`,
name: `Search ${option.label}...`,
action: () => setPage(option.pageName),
icon: () => <option.icon className="h-4 w-4" strokeWidth={1.5} />,
})) as ICommand[]
}, [setPage, authEnabled, edgeFunctionsEnabled, storageEnabled, project])
useRegisterCommands(COMMAND_MENU_SECTIONS.QUERY, contextCommands, {
orderSection: orderCommandSectionsByPriority,
sectionMeta: { priority: 3 },
enabled: !IS_PLATFORM || !!project,
})
}