Files
supabase/apps/studio/components/interfaces/HomePageActions.tsx
Gildas Garcia 96d43099bb chore: refactor Button API so that it can be used a standard button (#46880)
## Problem

Our `<Button>` component breaks the default `button` contract by
redefining the `type` prop to set its variant (`primary`, `default`,
etc) instead of the button type (`submit`, `button`, etc).
This is confusing and forces to write more code when using it with
shadcn components that expect/inject the standard button props.

## Solution

- rename the `type` prop to `variant`
- rename the `htmlType` prop to `type`
- propagate the changes where necessary
- format code

## How to test

As this is just prop renaming, if it builds it's ok

---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
2026-06-16 23:59:58 +02:00

167 lines
6.0 KiB
TypeScript

import { keepPreviousData } from '@tanstack/react-query'
import { useDebounce } from '@uidotdev/usehooks'
import { LOCAL_STORAGE_KEYS, useParams } from 'common'
import { Grid, List, Loader2, Plus, Search, X } from 'lucide-react'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { parseAsArrayOf, parseAsString, parseAsStringLiteral, useQueryState } from 'nuqs'
import { useEffect, useRef } from 'react'
import { Button, ToggleGroup, ToggleGroupItem } from 'ui'
import { Input } from 'ui-patterns/DataInputs/Input'
import { FilterPopover } from '../ui/FilterPopover'
import { SortDropdown } from '../ui/SortDropdown'
import {
PROJECT_LIST_SORT_VALUES,
type ProjectListSort,
} from '@/components/interfaces/Home/ProjectList/ProjectListSort.utils'
import { Shortcut } from '@/components/ui/Shortcut'
import { useOrgProjectsInfiniteQuery } from '@/data/projects/org-projects-infinite-query'
import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
import { PROJECT_STATUS } from '@/lib/constants'
import { onSearchInputEscape } from '@/lib/keyboard'
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
import { useShortcut } from '@/state/shortcuts/useShortcut'
interface HomePageActionsProps {
slug?: string
hideNewProject?: boolean
}
export const HomePageActions = ({ slug: _slug, hideNewProject = false }: HomePageActionsProps) => {
const { slug: urlSlug } = useParams()
const router = useRouter()
const projectCreationEnabled = useIsFeatureEnabled('projects:create')
const slug = _slug ?? urlSlug
const [search, setSearch] = useQueryState('search', parseAsString.withDefault(''))
const debouncedSearch = useDebounce(search, 500)
const [filterStatus, setFilterStatus] = useQueryState(
'status',
parseAsArrayOf(parseAsString, ',').withDefault([])
)
const [sort, setSort] = useQueryState(
'sort',
parseAsStringLiteral(PROJECT_LIST_SORT_VALUES).withDefault('name_asc')
)
const [viewMode, setViewMode] = useLocalStorageQuery(LOCAL_STORAGE_KEYS.PROJECTS_VIEW, 'grid')
const [filterStatusStorage, setFilterStatusStorage, { isSuccess: isSuccessFilterStatusStorage }] =
useLocalStorageQuery<string[]>(LOCAL_STORAGE_KEYS.PROJECTS_FILTER, [])
const [sortStorage, setSortStorage, { isSuccess: isSuccessSortStorage }] =
useLocalStorageQuery<ProjectListSort>(LOCAL_STORAGE_KEYS.PROJECTS_SORT, 'name_asc')
const { isFetching: isFetchingProjects } = useOrgProjectsInfiniteQuery(
{
slug,
sort,
search: search.length === 0 ? search : debouncedSearch,
statuses: filterStatus,
},
{ placeholderData: keepPreviousData }
)
const searchInputRef = useRef<HTMLInputElement>(null)
useShortcut(SHORTCUT_IDS.ORG_PROJECTS_SEARCH, () => {
searchInputRef.current?.focus()
})
useEffect(() => {
if (isSuccessFilterStatusStorage && !!slug) setFilterStatus(filterStatusStorage)
}, [filterStatusStorage, isSuccessFilterStatusStorage, setFilterStatus, slug])
useEffect(() => {
if (isSuccessSortStorage && slug) setSort(sortStorage)
}, [sortStorage, isSuccessSortStorage, setSort, slug])
return (
<div className="flex flex-wrap items-center justify-between gap-2 w-full">
<div className="flex flex-col gap-2 min-w-0 flex-1 basis-full md:basis-auto sm:flex-row sm:flex-wrap sm:items-center">
<Input
ref={searchInputRef}
placeholder="Search for a project"
icon={<Search />}
size="tiny"
className="w-full sm:w-32 md:w-64"
value={search}
onChange={(event) => setSearch(event.target.value)}
onKeyDown={onSearchInputEscape(search, (v) => setSearch(v))}
actions={[
search && (
<Button
key="clear"
size="tiny"
variant="text"
icon={<X />}
onClick={() => setSearch('')}
className="p-0 h-5 w-5"
/>
),
]}
/>
<div className="flex items-center gap-2">
<FilterPopover
name="Status"
title="Filter projects by status"
options={[
{ key: PROJECT_STATUS.ACTIVE_HEALTHY, label: 'Active' },
{ key: PROJECT_STATUS.INACTIVE, label: 'Paused' },
]}
activeOptions={filterStatus}
valueKey="key"
labelKey="label"
onSaveFilters={(options) => setFilterStatusStorage(options)}
/>
<SortDropdown
options={[
{ label: 'name', value: 'name' },
{ label: 'creation date', value: 'created' },
]}
value={sort}
setValue={(val) => setSortStorage(val as ProjectListSort)}
/>
{isFetchingProjects && <Loader2 className="animate-spin" size={14} />}
</div>
</div>
<div className="flex items-center gap-2 shrink-0">
{viewMode && setViewMode && (
<ToggleGroup
type="single"
size="sm"
value={viewMode}
onValueChange={(value) => value && setViewMode(value as 'grid' | 'table')}
>
<ToggleGroupItem value="grid" size="sm" className="h-[26px] w-[26px] p-0">
<Grid size={14} strokeWidth={1.5} />
</ToggleGroupItem>
<ToggleGroupItem value="table" size="sm" className="h-[26px] w-[26px] p-0">
<List size={14} strokeWidth={1.5} />
</ToggleGroupItem>
</ToggleGroup>
)}
{projectCreationEnabled && !hideNewProject && (
<Shortcut
id={SHORTCUT_IDS.ORG_PROJECTS_NEW}
onTrigger={() => {
if (slug) router.push(`/new/${slug}`)
}}
side="bottom"
>
<Button asChild icon={<Plus />} variant="primary" size="tiny">
<Link href={`/new/${slug}`}>New project</Link>
</Button>
</Shortcut>
)}
</div>
</div>
)
}