Files
supabase/apps/studio/components
Ivan Vasilov bf49d8ab7d chore: Fix the local studio tests (#32836)
* Set a fixed version of ubuntu for running the local studio tests.

* Fix a possible yaml issue.

* Revert to ubuntu-latest. Try bumping the playwright package.

* Add init script to force the navigation menu to not expand.

* Another try.

* Extend the timeout.

* Another try.

* Try.

* T.

* T.

* Revert some of the unneeded changes.
2025-01-16 18:54:06 +01:00
..
2025-01-14 11:21:35 -03:30
2025-01-15 11:42:06 +01:00
2025-01-15 10:22:57 +01: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