mirror of
https://github.com/supabase/supabase.git
synced 2026-10-12 21:05:06 +03:00
Batuhan Wilhelm
8cfe645f2b
* docs: update Refine svg in HeroFrameworks * docs: use capital R for Refine mentions * docs: use main branch for Refine repository references * docs: update connect interface example code for Refine * docs: update Refine quick start tutorial with Refine v5 * examples(refine-user-management): upgrade to Refine v5 * docs: update Refine getting started tutorial with Refine v5 * chore(studio): update Refine icon on Connect modal * docs: update Refine svg * docs: update welcome screen screenshot in Refine tutorial * docs: update dimensions of welcome screen screenshot in Refine tutorial * chore: remove leftover dist assets from Refine example * chore(linter): add Refine to Rule001 and Rule003 * chore: format getting started with Refine.mdx * chore: remove .prettierrc file from the example
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-cleanedfolder 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.tsxas 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