mirror of
https://github.com/supabase/supabase.git
synced 2026-10-08 02:45:07 +03:00
Gildas Garcia
3669fef749
## Problem The tooltip comment we have about removing the `aria-describedby` attribute to avoid screen readers reading the same text twice is wrong. ## Solution Make it clear why we do that so that future devs don't remove it. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Accessibility** * Clarified accessibility guidance for tooltips and screen-reader labels across code blocks, database controls, function editors, hooks, and table actions. * **Documentation** * Updated internal comments to more clearly explain why duplicate tooltip text is avoided for screen readers. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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 — use a named export, not a default export
export const ComponentA = ({ sampleProp }: ComponentAProps) => {
return <div>ComponentA: {sampleProp}</div>
}