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

Only generate legend for items that are displayed on the page #1136

Closed
1 task done
Raiondesu opened this issue Nov 15, 2019 · 6 comments · Fixed by dbartholomae/redux-dynamic-modules-beacon#25 or gpicron/ssb-subjective-group#1
Labels
enhancement Improved functionality

Comments

@Raiondesu
Copy link

Raiondesu commented Nov 15, 2019

Problem

Currently, the legend at the bottom is cluttered with ALL possible types of exports including some particularly rare ones. This can often lead to a feeling of being lost in some readers, when first looking at the bottom of the page.

For example, if viewing a class that only contains some methods and properties, it's pretty useless for the reader to be reminded about icons for enums, enumeration members or variables...

Suggested Solution

It should be possible to only render legend for the items that are currently present on the page.

This would greatly benefit documentation simplicity of the small packages with short API-s.

@Gerrit0 Gerrit0 added the enhancement Improved functionality label Nov 18, 2019
socsieng added a commit to socsieng/typedoc that referenced this issue Jan 22, 2020
For TypeStrong#1136

Will require another change to typedoc-default-themes
socsieng added a commit to socsieng/typedoc-default-themes that referenced this issue Jan 22, 2020
socsieng added a commit to socsieng/typedoc-default-themes that referenced this issue Jan 22, 2020
socsieng added a commit to socsieng/typedoc that referenced this issue Jan 22, 2020
For TypeStrong#1136

Will require another change to typedoc-default-themes
socsieng added a commit to socsieng/typedoc that referenced this issue Jan 22, 2020
For TypeStrong#1136

Will require another change to typedoc-default-themes
@johansten
Copy link

johansten commented Apr 6, 2020

Is this really working the way it is supposed to? I'm getting a legend that contains far fewer entries in them, but they have virtually no overlap with the types I'm expecting it to display:

Legend:
Screen Shot 2020-04-06 at 16 49 15

My symbols:
Screen Shot 2020-04-06 at 16 48 37

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 6, 2020

That definitely looks like a bug, looks like we are missing Enum, Interface, Class, Function and... whatever that other purple dot is.

There was a bug in a previous version caused by the rename from "External Modules" to "Modules", are you on the latest version?

@johansten
Copy link

I'm using 0.17.4

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 12, 2020

Could you open a new issue with a reproduction? Seems to be working correctly based on a quick test with the symbols I noted are missing that I just did.

@mcmartincerny
Copy link

I have the same problem. Enum and other types are missing. I am using mode "file".
@johansten : have you found a solution to the problem?

@kamtschatka
Copy link

I am having the same issue with the enums. Interestingly the "Enumeration" shows up in my real project and the "Enumeration member" is missing, but in my reproducer both of them are missing.
Is there a way to include all of them again, so we at least have all of them shown properly?

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
5 participants