mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 18:05:11 +03:00
Joshen Lim
30375c55a0
* Reinstate API docs files and pages * Add API side panel back to feature preview * Nav bar to link to api page if feature is not toggled * Hide API docs button behind feature preview for auth users, storage and edge functions * Use new API side panel for table editor, and update the language selector to make it more apparent * Fix feature preview modal styling * Merge master resolve conflicts * Add URL to graphiql in API docs side panel, which links to /api/graphiql without the docs layout menu * Add auth enabled flag for user management section in Docs * Add realtime enabled flag for subscribe to changes section in Docs * Add realtime enabled flag for API docs side panel * Update redirect next config
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
import { observer } from 'mobx-react-lite'
// Declare the prop types of your component
interface ComponentAProps {
sampleProp: string
}
// Name your component accordingly
const ComponentA = ({ sampleProp }: ComponentAProps) => {
return <div>ComponentA: {sampleProp}</div>
}
// Observer is so that components listen to mobx store changes
export default observer(ComponentA)