search

styleguidist / react-styleguidist

Isolated React component development environment with a living style guide
https://react-styleguidist.js.org/
MIT License
10.85k stars 1.44k forks source link

Documenting a component that is exported from another interface #1526

Closed tusharchutanigt closed 4 years ago

tusharchutanigt commented 4 years ago

We are making use of Material UI to develop our internal library but there are a few components that we want to use as is. So I am just doing the following in CircularIndicator.tsx export { CircularProgress as CircularIndicator } from '@material-ui/core';

In the Readme.md when I try to test document the element I don't see anything but I do get this warning.

Warning: ui/app/gtComponents/reactComponents/LoadingIndicator/CircularIndicator.tsx matches a pattern defined in “components” or “sections” options in your style guide config but doesn’t export a component.

It usually happens when using third-party libraries, see possible solutions here: https://react-styleguidist.js.org/docs/thirdparties.html

Looking at the doc I tried an annotation of /* @component / but that doesn't work either. I also tried to import the component in Readme. Am I missing something here?

EDIT: I am working in ts

stale[bot] commented 4 years ago

😴 This issue has been automatically marked as stale because it has not had recent activity. It will be closed in a week without any further activity. Consider opening a pull request if you still have this issue or want this feature.

alexcanessa commented 4 years ago

@tusharchutanigt were you able to solve this?

mustafaKamal-fe commented 3 years ago

@tusharchutanigt were you able to solve this?

I have the same issue and have just yarn removed styleguidist !!