Files
Alaister YoungandAlaister Young ca2b50a0a7 chore(ui-patterns): collapse the admonition shim into ui-patterns/Admonition (#48377)
Follow-up to #48344: collapses the two resolution paths for the
Admonition module into one.

`src/admonition.tsx` was a back-compat shim re-exporting
`src/Admonition/`. Two ways to resolve one module is exactly what
produced the macOS self-import bug fixed in #48344, and the local
typecheck errors that #48374 worked around. This removes the shim and
standardizes on the PascalCase subpath, matching every other export in
the package.

**Changed:**

- Codemodded all 246 `ui-patterns/admonition` imports to
`ui-patterns/Admonition` (240 `.tsx`, 5 `.mdx`, 1 `.ts` across studio,
docs, www, design-system, and lite-studio)
- Pointed the 5 internal `'../admonition'` imports back at the
`'../Admonition'` directory

**Removed:**

- `packages/ui-patterns/src/admonition.tsx`, and its `./admonition`
entry in the exports map (regenerated with `pnpm gen:exports`)

## To test

- `grep -r "ui-patterns/admonition" --include='*.ts*'` → no hits
- `pnpm test:case-hazards` → passes
- `pnpm typecheck` → all 15 tasks green
- `pnpm --filter studio run lint:ratchet` → passes
- `pnpm --filter ui-patterns vitest run src/Admonition` → 11 tests pass

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
* Standardized Admonition component imports across the application and
documentation.
* Improved compatibility with case-sensitive environments by using the
canonical component path.
  * Removed the legacy Admonition import entry point.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-07-29 00:48:56 +08:00

326 lines
11 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import { useDebounce } from '@uidotdev/usehooks'
import { LOCAL_STORAGE_KEYS, useParams } from 'common'
import { AnimatePresence, motion } from 'framer-motion'
import { toPng } from 'html-to-image'
import { Camera, CircleCheck, Image as ImageIcon, Upload, X } from 'lucide-react'
import { useRouter } from 'next/router'
import { ChangeEvent, useEffect, useRef, useState } from 'react'
import { toast } from 'sonner'
import {
Button,
cn,
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuSeparator,
DropdownMenuTrigger,
PopoverSeparator,
TextArea,
} from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
import {
convertB64toBlob,
isLikelySupportRequest,
uploadAttachment,
} from './FeedbackDropdown.utils'
import { SupportLink } from '@/components/interfaces/Support/SupportLink'
import { InlineLinkClassName } from '@/components/ui/InlineLink'
import { useFeedbackCategoryQuery } from '@/data/feedback/feedback-category'
import { useSendFeedbackMutation } from '@/data/feedback/feedback-send'
import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
import { timeout } from '@/lib/helpers'
import { useProfile } from '@/lib/profile'
import { useTrack } from '@/lib/telemetry/track'
interface FeedbackWidgetProps {
onClose: () => void
onSwitchToIssueOptions: () => void
}
export const FeedbackWidget = ({ onClose, onSwitchToIssueOptions }: FeedbackWidgetProps) => {
const router = useRouter()
const { profile } = useProfile()
const { ref, slug } = useParams()
const track = useTrack()
const uploadButtonRef = useRef(null)
const [feedback, setFeedback] = useState('')
const [isSending, setSending] = useState(false)
const [isSavingScreenshot, setIsSavingScreenshot] = useState(false)
const [isFeedbackSent, setIsFeedbackSent] = useState(false)
const debouncedFeedback = useDebounce(feedback, 500)
const [storedFeedback, setStoredFeedback] = useLocalStorageQuery<string | null>(
LOCAL_STORAGE_KEYS.FEEDBACK_WIDGET_CONTENT,
null
)
const [screenshot, setScreenshot, { isSuccess }] = useLocalStorageQuery<string | null>(
LOCAL_STORAGE_KEYS.FEEDBACK_WIDGET_SCREENSHOT,
null
)
const { data: category } = useFeedbackCategoryQuery({ prompt: debouncedFeedback })
// Use client-side heuristic for immediate feedback, AI result takes precedence when available
const isLikelySupport = isLikelySupportRequest(feedback)
const effectiveCategory = category ?? (isLikelySupport ? 'support' : null)
const { mutate: submitFeedback } = useSendFeedbackMutation({
onSuccess: () => {
setIsFeedbackSent(true)
setFeedback('')
setStoredFeedback(null)
setScreenshot(null)
setSending(false)
},
onError: (error) => {
toast.error(`Failed to submit feedback: ${error.message}`)
setSending(false)
},
})
const captureScreenshot = async () => {
setIsSavingScreenshot(true)
function filter(node: HTMLElement) {
if ((node?.children ?? []).length > 0) {
return node.children[0].id !== 'feedback-widget'
}
return true
}
// Give time for dropdown to close
await timeout(100)
toPng(document.body, { filter })
.then((dataUrl: any) => setScreenshot(dataUrl))
.catch(() => toast.error('Failed to capture screenshot'))
.finally(() => setIsSavingScreenshot(false))
}
const onFilesUpload = async (event: ChangeEvent<HTMLInputElement>) => {
event.persist()
const [file] = event.target.files || (event as any).dataTransfer.items
const reader = new FileReader()
reader.onload = function (event) {
const dataUrl = event.target?.result
if (typeof dataUrl === 'string') setScreenshot(dataUrl)
}
reader.readAsDataURL(file)
event.target.value = ''
}
const handlePasteEvent = async () => {
// [Joshen] Support pasting images via Cmd / Ctrl + V
const [data] = await navigator.clipboard.read()
if (screenshot === undefined && data.types[0] === 'image/png') {
const blob = await data.getType('image/png')
const reader = new FileReader()
reader.onload = function (event) {
const dataUrl = event.target?.result
if (typeof dataUrl === 'string') setScreenshot(dataUrl)
}
reader.readAsDataURL(blob)
}
}
const sendFeedback = async () => {
if (feedback.length === 0 && screenshot !== undefined) {
return toast.error('Please include a message in your feedback.')
} else if (feedback.length > 0) {
setSending(true)
const attachmentUrl =
screenshot && profile?.gotrue_id
? await uploadAttachment({
image: screenshot,
userId: profile.gotrue_id,
})
: undefined
const formattedFeedback =
attachmentUrl !== undefined ? `${feedback}\n\nAttachments:\n${attachmentUrl}` : feedback
submitFeedback({
projectRef: ref,
organizationSlug: slug,
message: formattedFeedback,
pathname: router.asPath,
})
}
}
// Hydrate form from localStorage once it's ready; deps intentionally omit storedFeedback/screenshot
// so we don't overwrite user edits when those values change after initial load.
useEffect(() => {
if (storedFeedback) setFeedback(storedFeedback)
if (screenshot) setScreenshot(screenshot)
// eslint-disable-next-line react-hooks/exhaustive-deps -- hydrate once when localStorage is ready only
}, [isSuccess])
// Persist debounced input to localStorage; only re-run when debounced value changes.
useEffect(() => {
if (debouncedFeedback.length > 0) setStoredFeedback(debouncedFeedback)
// eslint-disable-next-line react-hooks/exhaustive-deps -- setStoredFeedback is stable; only sync on debounced value
}, [debouncedFeedback])
const ThanksMessageView = () => (
<>
<div className="py-6 px-4 grid gap-4 text-center text-foreground-light">
<CircleCheck className="mx-auto text-brand-500" size={24} />
<div className="flex flex-col gap-1">
<p className="text-foreground text-base">Your feedback has been sent. Thanks!</p>
<p className="text-sm text-balance">
We don’t always respond to feedback. If you need help with your project, use the button
below.
</p>
</div>
</div>
<PopoverSeparator />
<div className="px-4 pt-4 pb-4 flex flex-row items-center justify-between">
<Button variant="default" size="tiny" onClick={onSwitchToIssueOptions}>
Get help
</Button>
<Button variant="default" size="tiny" onClick={onClose}>
Close
</Button>
</div>
</>
)
return isFeedbackSent ? (
<ThanksMessageView />
) : (
<>
<div className="p-4">
<TextArea
placeholder="My idea for improving Supabase is..."
rows={6}
value={feedback}
onChange={(e) => setFeedback(e.target.value)}
onPaste={handlePasteEvent}
className="text-sm mb-1 resize-none"
/>
</div>
<AnimatePresence>
{effectiveCategory === 'support' && (
<motion.div
key="support-alert"
initial={{ opacity: 0, y: 16 }}
animate={{ opacity: 1, y: 0 }}
exit={{ opacity: 0, y: 16 }}
transition={{ duration: 0.2 }}
>
<Admonition
type="caution"
title="This looks like an issue that’s better handled by support"
className="rounded-none border-x-0 border-b-0"
>
<p>
Please{' '}
<SupportLink
className={cn(InlineLinkClassName)}
queryParams={{ projectRef: slug, message: feedback }}
>
open a support ticket
</SupportLink>{' '}
to get help, as we do not reply to all product feedback.
</p>
</Admonition>
</motion.div>
)}
</AnimatePresence>
<PopoverSeparator />
<div className="px-4 pt-4 pb-4 flex flex-row items-center justify-between">
<Button variant="default" size="tiny" onClick={onSwitchToIssueOptions}>
Get help instead
</Button>
<div className="flex items-center gap-2 flex-row">
{!!screenshot ? (
<div
style={{ backgroundImage: `url("${screenshot}")` }}
onClick={() => {
const blob = convertB64toBlob(screenshot)
const blobUrl = URL.createObjectURL(blob)
window.open(blobUrl, '_blank')
}}
className="cursor-pointer rounded-sm h-[26px] w-[26px] border border-control relative bg-cover bg-center bg-no-repeat"
>
<button
type="button"
tabIndex={0}
aria-label="Remove screenshot"
className={[
'cursor-pointer rounded-full bg-red-900 h-3 w-3',
'flex items-center justify-center absolute -top-1 -right-1',
].join(' ')}
onClick={(event) => {
event.stopPropagation()
setScreenshot(null)
}}
>
<X size={8} strokeWidth={3} />
</button>
</div>
) : (
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button
variant="default"
disabled={isSavingScreenshot}
loading={isSavingScreenshot}
className="w-7"
icon={<ImageIcon size={14} />}
/>
</DropdownMenuTrigger>
<DropdownMenuContent side="bottom" align="end" className="w-fit">
<DropdownMenuItem
className="flex gap-2"
key="upload-screenshot"
onSelect={() => {
if (uploadButtonRef.current) (uploadButtonRef.current as any).click()
}}
>
<Upload size={14} />
Upload screenshot
</DropdownMenuItem>
<DropdownMenuSeparator />
<DropdownMenuItem
className="flex gap-2"
key="capture-screenshot"
onSelect={() => captureScreenshot()}
>
<Camera size={14} />
Capture screenshot
</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
)}
<input
type="file"
ref={uploadButtonRef}
className="hidden"
accept="image/png"
onChange={onFilesUpload}
/>
<Button
disabled={feedback.length === 0 || isSending}
loading={isSending}
onClick={() => {
sendFeedback()
track('send_feedback_button_clicked')
}}
>
Send
</Button>
</div>
</div>
</>
)
}