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

Add filter to docs TOC #3719

Closed
natalie-bernhard opened this issue May 6, 2024 · 6 comments · Fixed by #3827
Closed

Add filter to docs TOC #3719

natalie-bernhard opened this issue May 6, 2024 · 6 comments · Fixed by #3827
Assignees
Labels
enhancement Improvements to existing functionality; redesigns

Comments

@natalie-bernhard
Copy link
Contributor

Allow users to filter article titles in the TOC using text input. Originally requested by @ayoho .

@natalie-bernhard natalie-bernhard converted this from a draft issue May 6, 2024
@natalie-bernhard natalie-bernhard added the design needed Waiting for ux/visual design label May 6, 2024
@natalie-bernhard
Copy link
Contributor Author

Possible alternative: provide Expand All button for TOC to expand all nested sections, so users could use page search (Ctrl + F) to find TOC titles with keywords

@natalie-bernhard natalie-bernhard moved this from New (Untriaged) to In Design/Discussion in Website backlog May 8, 2024
@natalie-bernhard
Copy link
Contributor Author

Possible alternative: provide Expand All button for TOC to expand all nested sections, so users could use page search (Ctrl + F) to find TOC titles with keywords

This approach is not a solution. We will implement a text input filter.

@natalie-bernhard
Copy link
Contributor Author

natalie-bernhard commented Jun 5, 2024

As the user types in a filter query, remove titles from the TOC that do not match the query, similar to the function of the filter on the guides page. See if reusing code from guides filter is possible. If title matching query is nested, show in TOC expanded under it's parent topics.

@natalie-bernhard natalie-bernhard moved this from In Design/Discussion to Backlog (Ready to Start) in Website backlog Jun 5, 2024
@natalie-bernhard
Copy link
Contributor Author

Design:

Important Notes:

  • Search bar color: #EEEFF3
  • Search bar font: Asap
  • Corner radius for rectangle: 3

Image

@natalie-bernhard natalie-bernhard added enhancement Improvements to existing functionality; redesigns and removed design needed Waiting for ux/visual design labels Jun 5, 2024
@navaneethsnair1 navaneethsnair1 self-assigned this Jun 13, 2024
@navaneethsnair1 navaneethsnair1 moved this from Backlog (Ready to Start) to In Development in Website backlog Jun 13, 2024
@navaneethsnair1 navaneethsnair1 linked a pull request Jun 27, 2024 that will close this issue
5 tasks
@navaneethsnair1 navaneethsnair1 moved this from In Development to Ready for Review in Website backlog Jun 27, 2024
@SteveSamJacob19
Copy link
Contributor

It would be good to keep the filter bar visible even during scrolling just like the version dropdown, so that it can be accessed anytime

This was referenced Jul 3, 2024
This was referenced Jul 25, 2024
@SteveSamJacob19 SteveSamJacob19 mentioned this issue Aug 7, 2024
5 tasks
@SteveSamJacob19 SteveSamJacob19 linked a pull request Aug 7, 2024 that will close this issue
5 tasks
@github-project-automation github-project-automation bot moved this from Ready for Review to Closed/Done in Website backlog Aug 7, 2024
@ayoho
Copy link
Member

ayoho commented Aug 8, 2024

Changes made for this are exactly what I was hoping for. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements to existing functionality; redesigns
Projects
Status: Closed/Done
Development

Successfully merging a pull request may close this issue.

4 participants