feat: add option sideNavLayout
#2633
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add support for theme option `sideNavLayout`. If set to `factored`,
the side-nav menu will group items that share a common path prefix.
For example, if the default layout for side-nav looked like this:
/config >
/config/alert >
/config/bacnet >
/config/modbus >
/log >
Then the factored side-nav would look like this:
/config >
/log >
and after expanding /config, you'd see:
/config v
GET /config
PUT /config
…/alert >
…/bacnet >
…/modbus >
/log >
Note that this commit also updates the styling to show a vertical line
to the left of all side-bar <ul> lists that are not at the root level.
This probably should be configurable.
It should be possible to collapse a parent item regardless of whether or not it is the currently active item. Prior to this fix, clicking on a parent item's "fold" icon was ignored unless the item was the currently active one. With this fix, the parent node and its children will be collapsed, as expected.
At the end of the loop, we need to append the remaining new children, if there are any.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm wondering if you'd consider adding a feature that allows making the sideNav menu more compact when there are end points sharing the same path prefix. The below is a proof of concept. It seems to work quite well with
redocly preview-docs, but I'm not very familiar withRedocso may be missing things.Add support for theme option
sideNavLayout. If set tofactored, the side-nav menu will group items that share a common path prefix.For example, if the default layout for side-nav looked like this:
Then the factored side-nav would look like this:
and after expanding /config, you'd see:
Note that this commit also updates the styling to show a vertical line to the left of all side-bar
<ul>lists that are not at the root level. This probably should be configurable.Check yourself