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

Closing/Opening Classes/Modules to minimize size of left hand panel. #57

Closed
backspaces opened this issue Jan 25, 2021 · 7 comments
Closed
Assignees

Comments

@backspaces
Copy link

Is your feature request related to a problem? Please describe.

Because I'm documenting many classes/modules with several functions/methods, I'd like to be able to "close" classes/files in the left side index of functions.

Example: https://agentscript.org/docs/
The top class is AgentArray. I'd like to close it by clicking on the name, an accordion style action.

Ditto for the rest of the top level classes/modules.

Describe the solution you'd like

Clicking on a top level item closes it, showing only the top level name. I think "accordion" is the css term.

Describe alternatives you've considered

Possibly separate pages per top level group. So the left hand side has links to the separate page.

Not sure how to do this with jsDoc.

Additional context

I think the url above should do the trick.

And I gotta THANK YOU for this terrific tool. Wow!

@backspaces
Copy link
Author

Here's an example with this behavior:
https://clenemt.github.io/docdash/module-ink_collector-ACollector.html

@ankitskvmdam
Copy link
Owner

Sorry for the late reply!
I think we can add accordions for this. Something like GitHub docs: https://docs.github.com/en/github and by default all the accordions are collapsed.
What your take on this?

@ankitskvmdam
Copy link
Owner

Screenshot 2021-01-31 at 4 58 54 PM

@backspaces
Copy link
Author

Yes, that's exactly what I had in mind!

@ankitskvmdam
Copy link
Owner

I'll try to work on it this week! Expect this feature to land in the next release by the end coming week.

@ankitskvmdam ankitskvmdam self-assigned this Jan 31, 2021
@backspaces
Copy link
Author

Wow, thanks!

@ankitskvmdam
Copy link
Owner

Added this feature and released v3.0.7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants