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

Option/theme to show all overloads at once #1100

Closed
1 task done
jeremymeng opened this issue Sep 20, 2019 · 1 comment
Closed
1 task done

Option/theme to show all overloads at once #1100

jeremymeng opened this issue Sep 20, 2019 · 1 comment
Labels
enhancement Improved functionality

Comments

@jeremymeng
Copy link

There were issues related to discoverability of docs for overloads. But this one is slightly different.

Problem

The current behavior using default theme is that doc is only shown for the first overload. It is hard for new users to discover that they need to click on the other overloads to get docs for them. Also some time it is desirable to have all the docs showing in order to compare the differences.

Suggested Solution

Either add an option to show them them. Or document how to achieve that by customizing the theme styles.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 21, 2019

Unfortunately just changing the styles isn't enough to do this. The overload groups are created by Signature.ts, so to remove them you would have to remove that file from the build and probably also merge the changes in TypeStrong/typedoc-default-themes#49, or something similar. I believe that PR breaks the dropdown functionality currently in place, but I'd like to get the fix for non-js users merged before the next release.

@Gerrit0 Gerrit0 added Component: Theme enhancement Improved functionality labels Dec 26, 2019
@Gerrit0 Gerrit0 added this to To do in Version 0.22 via automation Dec 30, 2020
@Gerrit0 Gerrit0 closed this as completed in c6e9bf9 Jul 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
No open projects
Development

No branches or pull requests

2 participants