mirror of
https://github.com/supabase/supabase.git
synced 2026-10-13 21:29:08 +03:00
Monica KhouryandTerry Sutton
538b59b698
* Draft: Docs Search * Add: Command_Shadcn_ * Fix: typecheck error * Fix: typecheck null error * Fix: docs search when the subject field is emptied * Make the design more compact and show only 5 results * Add inset around results * Fix inset * Fix conflict errors * Fix hover effect * replace commands with links * Fix broken links * Nudges --------- Co-authored-by: Terry Sutton <saltcod@gmail.com>
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