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

feat(Demo) - Navigation aware sidebar #21

Open
devfreddy opened this issue Jan 16, 2020 · 0 comments
Open

feat(Demo) - Navigation aware sidebar #21

devfreddy opened this issue Jan 16, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@devfreddy
Copy link
Contributor

Summary

The original design https://www.figma.com/proto/YAkXjlXfvOZaWaKtIEQynq/NR1-Community?node-id=1%3A1372&viewport=-306%2C237%2C0.8856343030929565&scaling=min-zoom calls for a sidebar navigation allowing for easier access to headers in the documentation.

Desired Behaviour

  • A user is contextually aware based on the currently highlighted item in the sidebar navigation
  • Clicking one of the items in the sidebar takes the user to that header in the documentation

Possible Solution

Assuming a similar structure to what we have currently we would need to:

  • Define a set of headers/children for navigation items from the main body of example code
  • Derive an aggregate of headers included in the README.md of the component
  • Merge these two together into one navigation tree for the sidebar
  • Add visibility awareness in the documentation to both
  • Upon become visible or being clicked, navigate to the correct header

Currently we have some visibility awareness handler/callbacks for the Markdown headers.

@devfreddy devfreddy added the enhancement New feature or request label Jan 16, 2020
@devfreddy devfreddy changed the title Demo - Add sidebar navigation feat(Demo) - Navigation aware sidebar Jan 27, 2020
@jpvajda jpvajda added this to Feature Backlog in NR1 3rd Party Nerdpack Community Jun 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

No branches or pull requests

1 participant