Redocly / Redocly/redoc

Add A Expand All/Collapse All Button For Content Column

Open
#2,464 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the problem to be solved
Expanding and collapsing text in an annoying feature in Redocly. Sometimes users want them all opened, or all closed, For instance, the browser-based search feature (think Chrome), works best if everything is expanded. After that, then be able to collapse them as it makes scrolling easier.

Describe the solution you'd like
Include an expand all/collapse all button for the content column.

Describe alternatives you've considered
Given them being either all expanded or all collapsed, we choose to have them all expanded. That makes searches easier, not navigation. We've also tried writing our own JavaScript but the way it's built makes this very difficult. Either way, the clients do a lot of expanding and collapsing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not identify a file, test, or entry point. Start by tracing the content-column implementation and its existing expand/collapse behavior, then identify the UI state and test coverage involved. Done means users can expand or collapse all content with a dedicated button without breaking individual section controls.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.