styleguidist/react-styleguidist

Status icons in component list

Open

#1,018 建立於 2018年6月15日

在 GitHub 查看
 (2 留言) (2 反應) (0 負責人)TypeScript (1,416 fork)github user discovery
help wanted

倉庫指標

Star
 (11,091 star)
PR 合併指標
 (PR 指標待抓取)

描述

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.

貢獻者指南