Files
supabase/studio/components
Kevin Grüneberg 5941e6756c chore: show/elaborate disk size (#12125)
- Emphasize that billing is based on **daily** average database size
- Add a few notes in the docs regarding preoccupied space and disk size vs database size
- Added link to docs on usage page and an info about current disk size / auto scaling
- Streamlined wording (disk size instead of database storage, database size instead of database space)
2023-02-13 10:37:57 +01:00
..
2023-02-13 15:05:49 +08:00
2023-02-13 12:14:53 +08:00
2021-12-02 22:36:13 -05: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

import { FC } from 'react'
import { observer } from 'mobx-react-lite'

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

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

// Observer is so that components listen to mobx store changes
export default observer(ComponentA)