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.

Sign up for GitHub

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

Jump to bottom

Use scrollspy in docs ToC #24383

Closed
JamesPierce82 opened this issue Oct 15, 2017 · 13 comments
Closed

Use scrollspy in docs ToC #24383

JamesPierce82 opened this issue Oct 15, 2017 · 13 comments
Assignees
@XhmikosR @Johann-S
Labels
docs v4

Comments

@JamesPierce82
Copy link

Hello,

I was recently browsing the BootStrap 4 docs and found that the scrollspy example does not appear to work in the docs. I remember seeing it work properly in the docs for Bootstrap 3 so was surprised to see it no longer working in the BS4 docs.

As I usually look to the docs for my examples, I hope this issue is able to be resolved.

Thanks in advance for any assistance.

James
@Johann-S
Copy link
Member

Sorry @JamesPierce82 but our examples works perfectly in our documentation 🤔
https://getbootstrap.com/docs/4.0/components/scrollspy/#example-in-navbar
https://getbootstrap.com/docs/4.0/components/scrollspy/#example-with-list-group

@bkdotcom
Copy link
Contributor

I'm guessing that @JamesPierce82 is referring to the right-side navigation (.section-nav), which doesn't implement scrollspy

@Johann-S
Copy link
Member

I think you're right @bkdotcom but I'll wait a bit ☺️

@XhmikosR
Copy link
Member

@Johann-S: what do we need for this to work?

@XhmikosR
Copy link
Member

It seems we have <body class="bd-docs" data-spy="scroll" data-target=".bd-sidenav-active"> which is useless in v4, right?

@XhmikosR
Copy link
Member

/CC @mdo for thoughts

@mdo mdo mentioned this issue Oct 18, 2017
Merged
@mdo
Copy link
Member

mdo commented Oct 18, 2017

Scrollspy isn't implemented in the docs, and it cannot be as we do not control the output of that menu—it's from a Jekyll plugin. I opened #24408 to address @XhmikosR's comment about that <body> element's attributes.

@bkdotcom bkdotcom mentioned this issue Oct 18, 2017
Closed
@bkdotcom
Copy link
Contributor

Jekyll-TOC just released v0.9.0 which might addresses this
https://github.com/toshimaru/jekyll-toc/releases/tag/v0.9.0

@XhmikosR
Copy link
Member

XhmikosR commented Oct 29, 2018 •
edited
Loading

Yeah, I already updated it in #27540, still waiting for the ID support.

I already discussed this with @Johann-S so instead of me making a new issue let's re-open this one.

@XhmikosR XhmikosR reopened this Oct 29, 2018
@XhmikosR XhmikosR changed the title ScrollSpy in Docs not working Use scrollspy in docs ToC Nov 4, 2018
@mdo
Copy link
Member

mdo commented Dec 14, 2018

Is this still an issue?

@XhmikosR
Copy link
Member

Yup. I don't know if we'll ever manage to fix it, but let's keep it open for a little more.

@SevereOverfl0w
Copy link

I'm interested in scrollspy support in my own ToC (based on the bootstrap one).

The docs do specify that:

It must be used on a Bootstrap nav component or list group.

But I don't think this needs to be a constant necessarily does it? Without the hierarchy functionality, it can work on near enough anything. With the hierarchy functionality, I think it can be inferred from the toc form.

@mdo
Copy link
Member

mdo commented Jun 3, 2019

Right now scrollspy requires particular markup. I have a new docs design for v5 that eliminates the right side ToC for a central ToC. For now though, given the lack of movement on this issue, going to close this out regardless.

@mdo mdo closed this as completed Jun 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@XhmikosR XhmikosR

@Johann-S Johann-S

Labels
docs v4
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@mdo @XhmikosR @Johann-S @bkdotcom @SevereOverfl0w @JamesPierce82