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

Expandable Hierarchy Section #2744

Open
mrfigg opened this issue Oct 9, 2024 · 2 comments · May be fixed by #2749
Open

Expandable Hierarchy Section #2744

mrfigg opened this issue Oct 9, 2024 · 2 comments · May be fixed by #2749
Labels
enhancement Improved functionality help wanted Contributions are especially encouraged

Comments

@mrfigg
Copy link
Contributor

mrfigg commented Oct 9, 2024

Search Terms

hierarchy

Problem

Having to go to a separate page (hierarchy.html) to view the full hierarchy of a declaration is inconvenient, and frankly the fact that hierarchy.html does not cleanly fit into the site navigation just gets under my skin (in a pet peeve sense).

Suggested Solution

Make the hierarchy section on a declaration page expandable.

Here's a working example of how to do this with only html & css: Codepen

@mrfigg mrfigg added the enhancement Improved functionality label Oct 9, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 11, 2024

Once the integration of the DMT lands (#2335) there will be a button in the navigation which shows the full hierarchy

I don't think including the entire hierarchy for a given class in every rendered page is a good idea - depending on the class hierarchy of the project this could reintroduce issues where the rendered size of the documentation balloons to >10x what it is today (previously caused by including the navigation on each page).

I could see saving the hierarchy to another assets file so that it the view full link could be replaced/augmented with an expand option dynamically if the user has JS enabled, but am unlikely to spend what time I have for typedoc on this anytime soon.

@Gerrit0 Gerrit0 added the help wanted Contributions are especially encouraged label Oct 11, 2024
@mrfigg
Copy link
Contributor Author

mrfigg commented Oct 11, 2024

Ah shoot, I didn't think about the file size. I was almost done with a PR with a strait forward implementation of this. I'll look into mimicking the approach that the search/navigation takes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality help wanted Contributions are especially encouraged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants