Files
supabase/apps/studio/components/ui/DownloadResultsButton.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

181 lines
5.1 KiB
TypeScript

import { IS_PLATFORM, useParams } from 'common'
import saveAs from 'file-saver'
import { ChevronDown, Copy, Download, Settings } from 'lucide-react'
import Link from 'next/link'
import { usePathname } from 'next/navigation'
import { useMemo } from 'react'
import { toast } from 'sonner'
import {
Button,
copyToClipboard,
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
KeyboardShortcut,
} from 'ui'
import {
convertResultsToCSV,
convertResultsToJSON,
convertResultsToMarkdown,
} from '@/components/interfaces/SQLEditor/UtilityPanel/Results.utils'
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
import { useShortcut } from '@/state/shortcuts/useShortcut'
interface DownloadResultsButtonProps {
iconOnly?: boolean
variant?: 'text' | 'default'
text?: string
align?: 'start' | 'center' | 'end'
results: any[]
fileName: string
enableCopyShortcuts?: boolean
onDownloadAsCSV?: () => void
onCopyAsMarkdown?: () => void
onCopyAsJSON?: () => void
onCopyAsCSV?: () => void
}
export const DownloadResultsButton = ({
iconOnly = false,
variant = 'default',
text = 'Export',
align = 'start',
results,
fileName,
enableCopyShortcuts = true,
onDownloadAsCSV,
onCopyAsMarkdown,
onCopyAsJSON,
onCopyAsCSV,
}: DownloadResultsButtonProps) => {
const { ref } = useParams()
const pathname = usePathname()
const isLogs = pathname?.includes?.('/logs') ?? false
const isEmpty = useMemo(() => results.length === 0, [results])
const downloadAsCSV = () => {
const csv = convertResultsToCSV(results)
if (!csv) {
toast('Results are empty')
return
}
const blob = new Blob([csv], { type: 'text/csv;charset=utf-8;' })
saveAs(blob, `${fileName}.csv`)
toast.success('Downloading results as CSV')
onDownloadAsCSV?.()
}
const copyAsMarkdown = () => {
const markdownData = convertResultsToMarkdown(results)
if (!markdownData) {
toast('Results are empty')
return
}
copyToClipboard(markdownData, () => {
toast.success('Copied Markdown to clipboard')
onCopyAsMarkdown?.()
})
}
const copyAsJSON = () => {
const jsonData = convertResultsToJSON(results)
if (!jsonData) {
toast('Results are empty')
return
}
copyToClipboard(jsonData, () => {
toast.success('Copied JSON to clipboard')
onCopyAsJSON?.()
})
}
const copyAsCSV = () => {
const csv = convertResultsToCSV(results)
if (!csv) {
toast('Results are empty')
return
}
copyToClipboard(csv, () => {
toast.success('Copied CSV to clipboard')
onCopyAsCSV?.()
})
}
useShortcut(SHORTCUT_IDS.RESULTS_COPY_MARKDOWN, copyAsMarkdown, {
enabled: !isEmpty && enableCopyShortcuts,
conflictBehavior: 'allow',
registerInCommandMenu: true,
})
useShortcut(SHORTCUT_IDS.RESULTS_COPY_JSON, copyAsJSON, {
enabled: !isEmpty && enableCopyShortcuts,
conflictBehavior: 'allow',
registerInCommandMenu: true,
})
useShortcut(SHORTCUT_IDS.RESULTS_COPY_CSV, copyAsCSV, {
enabled: !isEmpty && enableCopyShortcuts,
conflictBehavior: 'allow',
registerInCommandMenu: true,
})
useShortcut(SHORTCUT_IDS.RESULTS_DOWNLOAD_CSV, downloadAsCSV, {
enabled: !isEmpty,
registerInCommandMenu: true,
})
return (
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button
variant={variant}
icon={iconOnly ? <Download /> : undefined}
iconRight={iconOnly ? undefined : <ChevronDown />}
disabled={results.length === 0}
className={iconOnly ? 'w-7' : ''}
>
{!iconOnly && text}
</Button>
</DropdownMenuTrigger>
<DropdownMenuContent align={align} className="w-60">
{isLogs && IS_PLATFORM && (
<DropdownMenuItem asChild className="gap-x-2">
<Link href={`/project/${ref}/settings/log-drains`}>
<Settings size={14} />
<p>Add a Log Drain</p>
</Link>
</DropdownMenuItem>
)}
<DropdownMenuItem onClick={copyAsMarkdown} className="gap-x-2">
<Copy size={14} />
<p>Copy as Markdown</p>
<span className="ml-auto">
<KeyboardShortcut keys={['Shift', 'Meta', 'm']} />
</span>
</DropdownMenuItem>
<DropdownMenuItem onClick={copyAsJSON} className="gap-x-2">
<Copy size={14} />
<p>Copy as JSON</p>
<span className="ml-auto">
<KeyboardShortcut keys={['Shift', 'Meta', 'j']} />
</span>
</DropdownMenuItem>
<DropdownMenuItem onClick={copyAsCSV} className="gap-x-2">
<Copy size={14} />
<p>Copy as CSV</p>
<span className="ml-auto">
<KeyboardShortcut keys={['Shift', 'Meta', 'c']} />
</span>
</DropdownMenuItem>
<DropdownMenuItem className="gap-x-2" onClick={() => downloadAsCSV()}>
<Download size={14} />
<p>Download CSV</p>
<span className="ml-auto">
<KeyboardShortcut keys={['Shift', 'Meta', 'd']} />
</span>
</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
)
}