Files
supabase/apps/studio/components
Alaister Young c7de8411cf Merge remote-tracking branch 'origin/master' into alaister/tanstack-start
Resolve conflicts:
- apps/studio/package.json: drop @supabase/postgres-meta (replaced by
  @supabase/pg-meta on master) while keeping tanstack/tailwind v4 dev deps
- pnpm-lock.yaml: take master's and reconcile via pnpm install

Bump tanstack deps to latest available (post supply-chain unpublish):
- @tanstack/react-devtools ^0.10.2 -> ^0.10.3
- @tanstack/react-hotkeys ^0.9.1 -> ^0.10.0
- @tanstack/react-query / -devtools ^5.0.0 -> ^5.100.10 (studio/docs/ui-library)
2026-05-15 13:39:15 +08:00
..

Writing components

Where to create your components

  • For components that declare the general structure and layout of a page:
    • /components/layouts/xxx
  • For components that are tightly coupled to a specific interface:
    • /components/interfaces/xxx
  • For components that are meant to be reusable across multiple pages:
    • /components/ui/xxx
  • Note: We're gradually moving files out of the to-be-cleaned folder into the respective folders as we refactor

Component structure

  • If a component has constants and utility methods that are tightly coupled to itself, keep them close to the component and enclose them in a folder with an index.tsx as an entry point
  • Otherwise it can just be a file on its own
  • For example:
    • components/ui
      - SampleComponentA
        - SampleComponentA.tsx
        - SampleComponentA.constants.ts
        - SampleComponentA.utils.ts
        - SampleComponentA.types.ts
        - index.ts
      - SampleComponentB.tsx
      

Template for building components


// Declare the prop types of your component
interface ComponentAProps {
  sampleProp: string
}

// Name your component accordingly
const ComponentA = ({ sampleProp }: ComponentAProps) => {
  return <div>ComponentA: {sampleProp}</div>
}

export default ComponentA