mirror of
https://github.com/supabase/supabase.git
synced 2026-05-08 01:40:13 -04:00
678aec3845
## Screenshots ### Table editor: foreign record selector Before: <img width="802" height="213" alt="image" src="https://github.com/user-attachments/assets/82ee3ce6-ac72-4b49-b1b0-2e635688cbb1" /> After: <img width="609" height="194" alt="image" src="https://github.com/user-attachments/assets/e9cc09c1-1c6b-4099-8cae-abe08f50fda9" /> ### Account - Add TOTP Before: <img width="527" height="679" alt="image" src="https://github.com/user-attachments/assets/b9f4a626-e24b-46e3-8385-700ef181308b" /> After: <img width="531" height="684" alt="image" src="https://github.com/user-attachments/assets/549745a7-9655-4a7d-9e0e-51f75b6a1c61" /> ### Organisation Audit Logs Details Before: <img width="673" height="1321" alt="image" src="https://github.com/user-attachments/assets/0bb360cf-6f27-4574-b9af-485a3836b17b" /> After: <img width="669" height="1273" alt="image" src="https://github.com/user-attachments/assets/0382c662-e270-41fd-a8ee-08528dedfce3" /> ### Data API Integration Docs Before: <img width="1115" height="891" alt="image" src="https://github.com/user-attachments/assets/db0c7698-53b7-4422-aac3-5e674b0bf151" /> After: <img width="1193" height="1272" alt="image" src="https://github.com/user-attachments/assets/927e5c43-413b-49c1-9b71-8ab628179c70" /> ### Edge Function Edit Secret Before: <img width="599" height="255" alt="image" src="https://github.com/user-attachments/assets/d6aa2f87-e247-4724-9e43-02b71933241c" /> After: <img width="596" height="261" alt="image" src="https://github.com/user-attachments/assets/d94acb41-07e1-497f-9697-830390526f4a" /> ### JWT Key Details Before: <img width="536" height="549" alt="image" src="https://github.com/user-attachments/assets/43672adc-dc0e-4e65-b7d4-b4537d22f6ea" /> After: <img width="523" height="517" alt="image" src="https://github.com/user-attachments/assets/e501e8a8-7f41-46a0-bb69-d240cea594f0" /> ### Realtime Filter Popover Before: <img width="403" height="576" alt="image" src="https://github.com/user-attachments/assets/73842450-ba87-456b-98fc-625b99149449" /> After: <img width="387" height="564" alt="image" src="https://github.com/user-attachments/assets/f2b35035-947c-4342-84dd-3548f9bd5e9f" /> ### Realtime broadcast message dialog Before: <img width="520" height="393" alt="image" src="https://github.com/user-attachments/assets/4f4a1a93-e0cf-4268-ae4e-baf8b8a62e74" /> After: <img width="525" height="392" alt="image" src="https://github.com/user-attachments/assets/e1c1934a-1812-4013-8606-9b846dc2498d" /> ### Impersonation Popover Before: <img width="604" height="501" alt="image" src="https://github.com/user-attachments/assets/9abdc604-94f8-4ed4-9a95-4688e6504e76" /> <img width="587" height="599" alt="image" src="https://github.com/user-attachments/assets/5293c80c-9abd-43eb-899f-da759c83b598" /> After: <img width="594" height="585" alt="image" src="https://github.com/user-attachments/assets/5eaf2162-2d7f-444c-9052-c9afb00080f6" /> <img width="590" height="597" alt="image" src="https://github.com/user-attachments/assets/149dc7c1-689c-4e0f-a884-c6f5b0228ebc" /> ### Storage move item Before: <img width="521" height="285" alt="image" src="https://github.com/user-attachments/assets/7d0f945f-add5-412b-813a-9325b260ab28" /> After: <img width="529" height="274" alt="image" src="https://github.com/user-attachments/assets/ab0891a1-b31b-40b6-be53-92afc95095ea" /> ### Table Editor - Spreadsheet import Before: <img width="673" height="506" alt="image" src="https://github.com/user-attachments/assets/7a722908-10c2-4c04-95fb-b12d3c23557c" /> After: <img width="671" height="638" alt="image" src="https://github.com/user-attachments/assets/689b1fb6-031c-4a02-9e7f-739356c1453d" /> ### Org Billing downgrade survey Before: <img width="788" height="655" alt="image" src="https://github.com/user-attachments/assets/c7a0d4c6-e9b9-4c6c-9cf1-e7d05016233f" /> After: <img width="1630" height="1354" alt="image" src="https://github.com/user-attachments/assets/e3f5473b-db9a-42b1-9242-40480c25fc02" /> ### Project API Docs Before: <img width="1030" height="396" alt="image" src="https://github.com/user-attachments/assets/95643b21-811a-4ba7-918a-5e655c262ac1" /> After: <img width="1012" height="457" alt="image" src="https://github.com/user-attachments/assets/d5559646-bb89-43b6-ad62-c5684b54b3fb" /> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * Standardized form field layouts across panels, dialogs, and modals for a more consistent editing and reading experience. * Replaced several Input-based textareas with dedicated TextArea/ExpandingTextArea controls and aligned labels with wrapper layouts for clearer accessibility. * Introduced grouped/composable input controls, added additional read-only detail fields and labeled value/copy blocks, and tightened header/layout spacing and control alignment. * Swapped notice styles for improved warning/admonition presentation. * **Chores** * Removed a deprecated AutoTextArea component. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
156 lines
5.8 KiB
TypeScript
156 lines
5.8 KiB
TypeScript
import { PermissionAction } from '@supabase/shared-types/out/constants'
|
|
import { useParams } from 'common'
|
|
import { Copy } from 'lucide-react'
|
|
import { useEffect, useState } from 'react'
|
|
import { Button, copyToClipboard } from 'ui'
|
|
import { Input } from 'ui-patterns/DataInputs/Input'
|
|
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
|
|
|
|
import ContentSnippet from '../ContentSnippet'
|
|
import { DOCS_CONTENT } from '../ProjectAPIDocs.constants'
|
|
import type { ContentProps } from './Content.types'
|
|
import { getKeys, useAPIKeysQuery } from '@/data/api-keys/api-keys-query'
|
|
import { useProjectSettingsV2Query } from '@/data/config/project-settings-v2-query'
|
|
import { useSendEventMutation } from '@/data/telemetry/send-event-mutation'
|
|
import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
|
|
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
|
|
|
|
export const Introduction = ({ showKeys, language, apikey, endpoint }: ContentProps) => {
|
|
const { ref } = useParams()
|
|
const { can: canReadAPIKeys } = useAsyncCheckPermissions(PermissionAction.SECRETS_READ, '*')
|
|
const { data: apiKeys } = useAPIKeysQuery({ projectRef: ref }, { enabled: canReadAPIKeys })
|
|
useProjectSettingsV2Query({ projectRef: ref })
|
|
const { data: org } = useSelectedOrganizationQuery()
|
|
const { mutate: sendEvent } = useSendEventMutation()
|
|
|
|
const [copied, setCopied] = useState<'anon' | 'service'>()
|
|
|
|
useEffect(() => {
|
|
if (copied !== undefined) setTimeout(() => setCopied(undefined), 2000)
|
|
}, [copied])
|
|
|
|
const { anonKey, serviceKey } = getKeys(apiKeys)
|
|
const anonApiKey = anonKey?.api_key
|
|
const serviceApiKey = serviceKey?.api_key ?? 'SUPABASE_CLIENT_SERVICE_KEY'
|
|
|
|
return (
|
|
<>
|
|
<ContentSnippet
|
|
selectedLanguage={language}
|
|
apikey={apikey}
|
|
endpoint={endpoint}
|
|
snippet={DOCS_CONTENT.init}
|
|
>
|
|
<div className="px-4 space-y-6">
|
|
<div className="flex flex-col space-x-4 mt-8">
|
|
<FormItemLayout isReactForm={false} layout="horizontal" label="Project URL">
|
|
<Input disabled readOnly copy size="small" value={endpoint} className="w-full" />
|
|
</FormItemLayout>
|
|
</div>
|
|
<div className="flex flex-col space-x-4">
|
|
<FormItemLayout
|
|
isReactForm={false}
|
|
layout="horizontal"
|
|
label="Client API key"
|
|
description="This key is safe to use in a browser if you have enabled Row Level Security (RLS) for your tables and configured policies."
|
|
>
|
|
<Input
|
|
disabled
|
|
readOnly
|
|
size="small"
|
|
value={showKeys ? apikey : 'Reveal API keys via dropdown in the header'}
|
|
actions={[
|
|
<Button
|
|
key="copy"
|
|
type="default"
|
|
icon={<Copy />}
|
|
onClick={() => {
|
|
setCopied('anon')
|
|
copyToClipboard(anonApiKey ?? 'SUPABASE_CLIENT_ANON_KEY')
|
|
sendEvent({
|
|
action: 'api_docs_code_copy_button_clicked',
|
|
properties: {
|
|
title: 'Client API key',
|
|
selectedLanguage: language,
|
|
},
|
|
groups: {
|
|
project: ref ?? 'Unknown',
|
|
organization: org?.slug ?? 'Unknown',
|
|
},
|
|
})
|
|
}}
|
|
>
|
|
{copied === 'anon' ? 'Copied' : 'Copy'}
|
|
</Button>,
|
|
]}
|
|
/>
|
|
</FormItemLayout>
|
|
</div>
|
|
<div className="flex flex-col space-x-4">
|
|
<FormItemLayout
|
|
isReactForm={false}
|
|
layout="horizontal"
|
|
label="Service key"
|
|
description={
|
|
<p>
|
|
This key has the ability to bypass Row Level Security.{' '}
|
|
<span className="text-amber-900">Never share it publicly.</span>
|
|
</p>
|
|
}
|
|
>
|
|
<Input
|
|
disabled
|
|
readOnly
|
|
size="small"
|
|
value={
|
|
showKeys
|
|
? (serviceApiKey ?? 'SUPABASE_CLIENT_SERVICE_KEY')
|
|
: 'Reveal API keys via dropdown in the header'
|
|
}
|
|
actions={[
|
|
<Button
|
|
key="copy"
|
|
type="default"
|
|
icon={<Copy />}
|
|
onClick={() => {
|
|
setCopied('service')
|
|
copyToClipboard(serviceApiKey)
|
|
sendEvent({
|
|
action: 'api_docs_code_copy_button_clicked',
|
|
properties: {
|
|
title: 'Service key',
|
|
selectedLanguage: language,
|
|
},
|
|
groups: {
|
|
project: ref ?? 'Unknown',
|
|
organization: org?.slug ?? 'Unknown',
|
|
},
|
|
})
|
|
}}
|
|
>
|
|
{copied === 'service' ? 'Copied' : 'Copy'}
|
|
</Button>,
|
|
]}
|
|
/>
|
|
</FormItemLayout>
|
|
</div>
|
|
</div>
|
|
</ContentSnippet>
|
|
|
|
<ContentSnippet
|
|
selectedLanguage={language}
|
|
apikey={apikey}
|
|
endpoint={endpoint}
|
|
snippet={DOCS_CONTENT.clientApiKeys}
|
|
/>
|
|
|
|
<ContentSnippet
|
|
selectedLanguage={language}
|
|
apikey={showKeys ? serviceApiKey : 'SUPABASE_CLIENT_SERVICE_KEY'}
|
|
endpoint={endpoint}
|
|
snippet={DOCS_CONTENT.serviceApiKeys}
|
|
/>
|
|
</>
|
|
)
|
|
}
|