Files
supabase/apps/studio/components
Bobbie Soedirgo 226d05fb83 fix: warning message on upgrade guards (#36646)
* fix: warning message on upgrade guards

When users are blocked from an upgrade because they have objects that
need to be dropped, the message in the warning is incorrect. It asks
users to "drop these extensions". But they're not extensions, they're
user-defined tables, foreign keys, etc. This will cause confusion.

Here we use a different messaging when users need to drop their objects.

* chore: prettier
2025-06-25 16:06:47 +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