Документирование компонента, который экспортируется из другого интерфейса - PullRequest
0 голосов
/ 23 января 2020

Мы используем Material UI для разработки нашей внутренней библиотеки, но есть несколько компонентов, которые мы хотим использовать как есть. Поэтому я просто делаю следующее в CircularIndicator.tsx export { CircularProgress as CircularIndicator } from '@material-ui/core';

В файле Readme.md, когда я пытаюсь проверить документ, я ничего не вижу, но получаю это предупреждение.

Предупреждение: ui / app / gtComponents / ReactionComponents / LoadingIndicator / CircularIndicator.tsx соответствует шаблону, определенному в параметрах «компонентов» или «разделов» в конфигурации руководства по стилю, но не экспортирует компонент.

Обычно это происходит при использовании сторонних библиотек, см. Возможные решения здесь: https://react-styleguidist.js.org/docs/thirdparties.html

Глядя на do c Я попробовал аннотацию / ** @component * / но это тоже не работает. Я также попытался импортировать компонент в Readme. Я что-то здесь упускаю?

...