{"library":"react-docgen-annotation-resolver","title":"React Docgen Annotation Resolver","description":"A resolver for react-docgen that enables parsing of exports annotated with @component JSDoc tag as React components. Version 2.0.0 is stable; the package is released on npm as needed. Unlike default react-docgen resolvers that infer components from patterns like displayName or propTypes, this resolver explicitly marks any export with a @component annotation as a component, giving developers control over what gets documented.","language":"javascript","status":"active","last_verified":"Sat Apr 25","install":{"commands":["npm install react-docgen-annotation-resolver"],"cli":null},"imports":["import annotationResolver from 'react-docgen-annotation-resolver';","import annotationResolver from 'react-docgen-annotation-resolver';","import annotationResolver from 'react-docgen-annotation-resolver';"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import annotationResolver from 'react-docgen-annotation-resolver';\nimport reactDocgen from 'react-docgen';\n\nconst sourceCode = `\n/** @component */\nexport default function MyButton() { return <button />; }\n`;\n\nconst doc = reactDocgen.parse(sourceCode, undefined, annotationResolver);\nconsole.log(doc); // [{ description: '', ... }]","lang":"typescript","description":"Shows how to use the annotation resolver with react-docgen's parse function to extract documentation from a component annotated with @component.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}