Open
Description
The docs have since existed as the base for which typescript documentation has formed. Now that most components are using this, it's time to phase out the component ref.md and simply link to the component itself (using a url to this repo) for people to read how components are used.
All components will come with this format:
type Props = {
/** describe when to use it */
propName: string;
};
/**
* ## Componentname
* brief explanation
*
* @see https://github.com/tgstation/tgui-core/blob/main/lib/components/ComponentName.tsx
*/
function ComponentName(props: Props){
This lets users scroll over individual props to get on-hover documentation, or over the component itself to get the link.
Metadata
Metadata
Assignees
Labels
No labels