Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to choose whether to expose all re-exports in sidebar #2685

Closed
ShaitanLyss opened this issue Aug 21, 2024 · 2 comments
Closed

Add option to choose whether to expose all re-exports in sidebar #2685

ShaitanLyss opened this issue Aug 21, 2024 · 2 comments
Labels
enhancement Improved functionality
Milestone

Comments

@ShaitanLyss
Copy link

ShaitanLyss commented Aug 21, 2024

Search Terms

sidebar hierarchy re-exports

Problem

My problem appeared in 0.26.6 due to the decision made in issue #2671.

I export a huge number of symbols at root level and I don't want my sidebar to be full of them with no hierarchy. As a workaround, I've been doing two export per module like so :

export * as Module from './module'
export * from './module'

In 0.26.5, this results in a clean readable hierarchy in the sidebar.
In 0.26.6 however, all re-exports are added to the sidebar, making it cluttered and hard to read.

Suggested Solution

It should be an option to add re-exports to the sidebar. Or if there's a better solution to my problem than doing two exports, please share it with me.

@ShaitanLyss ShaitanLyss added the enhancement Improved functionality label Aug 21, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Aug 21, 2024

The excludeReferences option will prevent typedoc from including them at all - https://typedoc.org/options/input/#excludereferences

Adding an option to exclude them from the sidebar seems reasonable if that's not what you're after.

@ShaitanLyss
Copy link
Author

That's doesn't fit my use case, I'd still like to have the re-exports available in the main page (as they are the primary way to use the library), just not in the sidebar.

@Gerrit0 Gerrit0 added this to the v0.26.7 milestone Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

2 participants