styleguidist/react-styleguidist

Status icons in component list

Open

#1,018 opened on 2018年6月15日

GitHub で見る
 (2 comments) (2 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wanted

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

説明

The problem

No idea which items in the component list are new, deprecated, or under development/experimental. A good example would be GitHub's guide: https://styleguide.github.com/primer/

Proposed solution

Update ComponentsListRenderer to display the status based on docblock tags, like @new, @deprecated, and @experimental. Tag descriptions would be shown in a tooltip.

Alternative solutions

N/A

Additional context

I'm testing this currently by overriding SG components. Will report back.

コントリビューターガイド