Files
supabase/apps/studio/components
Jonathan Summers-MuirandIvan Vasilov a09ffd0104 Feat/get layout - Project pages updated to use getLayout (#33365)
* Update AppBannerWrapper.tsx

* full width header layout

* layout fixing for sign in pages

* update

* init

* Update app-state.ts

* Update ProjectLayout.tsx

* init project pages

* Update LayoutHeader.tsx

* sign in layout fixed

* Update AppBannerWrapper.tsx

* Update AppBannerWrapper.tsx

* update

* Update DefaultLayout.tsx

* Update WithSidebar.tsx

* Update ProjectLayout.tsx

* Update DefaultLayout.tsx

* layout header updatefix header

* add fragment back in

* Update ProjectLayout.tsx

* Update ProjectLayout.tsx

* Update ProjectLayout.tsx

* Update ProjectLayout.tsx

* Remove ProjectContextFromParams component (duplicate to ProjectContextProvider).

* Fix the loading state of SignInMfa page.

* Update sign-in-fly-tos.tsx

* Update ProjectLayout.tsx

* Update ProjectLayout.tsx

---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
2025-02-07 15:00:02 +08:00
..
2025-02-07 14:36:11 +10: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