Skip to content

Add "Expand all" button to Job DSL API Viewer #2551

@sparrowt

Description

@sparrowt

What feature do you want to see added?

When looking for certain functionality in the api-viewer it often requires a lot of clicking on ... buttons to expand all the children to see which one might contain what you are searching for.

For example at this URL on my Jenkins instance:

/plugin/job-dsl/api-viewer/index.html#method/org.jenkinsci.plugins.github_branch_source.GitHubSCMSource.traits

if I expand the single top-level traits there are 40 immediate children with an expand button, but clicking all forty of them by hand is not a fun experience.

I might be searching for a specific term and CTRL + F isn't going to help until I have expanded all the children.

There is of course the "Search methods..." in the top left corner, but the problem with that is if you find what you are looking for, you get thrown straight in to the deep level where it is found, without being able to easily see it in the context of the tree above.

So I suggest it would be helpful to have an Expand all or Expand all at this level button to save.

Looking for a workaround I tried running this in the dev tools console:

Array.from(document.getElementsByClassName('expand-closure')).forEach((el => el.click()

but unfortunately the page does not behave well - you end up with duplicated elements further down the page, while the originals remain unexpanded.

I suppose an alternative / additional useful feature would be a scoped search, i.e. search within this tree, but expand-all would still be useful.

Upstream changes

No response

Are you interested in contributing this feature?

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels
    No fields configured for Enhancement.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions