Clicking on specification menu somtimes highlight incorrect item

[jonaslagoni]

Describe the bug

When clicking on something like AsyncAPI Object I would expect that menu to be highlighted instead Schema is. https://www.asyncapi.com/docs/reference/specification/v2.6.0#A2SObject

This only happens for some of the links not all.

I have a feeling it's because the article displaying the spec does not take into account the menu is floating once you start scrolling. This means that when I click on AsyncAPI Object I am scrolled to an offset position in the document, instead of placing it in the top of the document, because well there is the menu, hiding the text.

However, the highlighter does not take this into consideration and still finds the nearest heading based on the top of the document, under the menu itself, i.e. finding Schema in this case to be the most likely heading to highlight.

[Savio629]

So AsyncAPI Object comes under Scheme so should the Scheme also be highlighted when it's sub topics is clicked or only it the subtopics like AsyncAPI Object should be highlighted.
@jonaslagoni

[jonaslagoni]

We are not talking about wanting to highlight Schema when AsyncAPI Object is clicked.

Schema should NOT be highlighted when I click AsyncAPI Object instead AsyncAPI Object should be highlighted 🙂

[Savio629]

@jonaslagoni It would only be highlighted when someone clicks on it or it is in it's corresponding div section, right? However, the Schema and AsyncAPI Object may contain different amounts of information, so when a user is in their respective div sections, both may be highlighted depending on the amount of content in each. I apologize for any confusion my previous response may have caused.

[jonaslagoni]

@jonaslagoni It would only be highlighted when someone clicks on it or it is in it's corresponding div section, right?

Yes.

However, the Schema and AsyncAPI Object may contain different amounts of information, so when a user is in their respective div sections, both may be highlighted depending on the amount of content in each

No, there is always just one being highlighted, even if both is in view 🙂

[Savio629]

So in this issue I would look on highlighting the AsyncAPI object when it's clicked rather than highlighting Schema .

[jonaslagoni]

Correct @Savio629 👍

[Savio629]

I'll start working on it!
Thanks for the info.

[Savio629]

@jonaslagoni
The npm package(react-scrollspy) that was being used for rendering the table of content of divs present on the screen by the website is now deprecated.
Should we still keep using it?

[jonaslagoni]

@Savio629 I would ping the codeowners for that question 🙂

[sambhavgupta0705]

@jonaslagoni we can close this issue now

[Savio629]

@sambhavgupta0705 I feel we can close this issue now....

[sambhavgupta0705]

Yes ,@jonaslagoni