Skip to content

Allow categorizing exported types in the sidebar #1532

@thislooksfun

Description

@thislooksfun

Search Terms

sidebar, category, exports, class, interface

Problem

When exporting a large project the sidebar quickly gets overloaded with semi-internal types that 99% of users won't use, thus burying the types that are actually relevant.

Suggested Solution

It would be great if adding @category foo-bar to an exported type would split the sidebar into groups. This would then allow for use cases such as:

  • having a single main export (function/class/etc) that is prominently separated from all the helper types
  • logically grouping like types that have disparate names
  • segregating away all the types that are only exposed for the <1% of people who might need them

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedContributions are especially encouraged

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions