Docs: rewrite/reorganise carousel docs page #37354
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* start with static/non-autoplaying examples * explicitly mention that carousels currently need to be manually initialized * split out and explain autoplaying and the weird "autoplay after first interaction" behaviour, as well as the pause on hover/focus
patrickhlauke
force-pushed
the
patrickhlauke-docs-carousel-rewrite
branch
from
1ea8e4a
to
ef22a31
Compare
…ncy with last code block on the page
…nested and accessibility paragraph
patrickhlauke
force-pushed
the
patrickhlauke-docs-carousel-rewrite
branch
from
76cbe37
to
25c51fa
Compare
patrickhlauke
force-pushed
the
patrickhlauke-docs-carousel-rewrite
branch
2 times, most recently
from
15d0660
to
a0c5e73
Compare
move the sentence about not double-initialising autoplaying carousels to the callout right at the top instead of talking about `data-bs...` attributes, talk about the "option" instead, as authors may be setting these not via data attributes, but at instatiation time with options in the constructor remove the incorrect statement about pausing when keyboard focus is in the carousel
patrickhlauke
force-pushed
the
patrickhlauke-docs-carousel-rewrite
branch
from
a0c5e73
to
8878334
Compare
7 tasks
* start with static/non-autoplaying examples * explicitly mention that carousels currently need to be manually initialized * split out and explain autoplaying and the weird "autoplay after first interaction" behaviour, as well as the pause on hover/focus
…ncy with last code block on the page
…nested and accessibility paragraph
move the sentence about not double-initialising autoplaying carousels to the callout right at the top instead of talking about `data-bs...` attributes, talk about the "option" instead, as authors may be setting these not via data attributes, but at instatiation time with options in the constructor remove the incorrect statement about pausing when keyboard focus is in the carousel
GeoSot
force-pushed
the
patrickhlauke-docs-carousel-rewrite
branch
from
8878334
to
ee55225
Compare
…com/twbs/bootstrap into patrickhlauke-docs-carousel-rewrite
louismaximepiton
added a commit
to louismaximepiton/bootstrap
that referenced
this pull request
Nov 9, 2022
GeoSot
approved these changes
Nov 12, 2022
Co-authored-by: GeoSot <geo.sotis@gmail.com>
site/assets/js/snippets.js
Outdated
| // Instantiate all non-autoplaying carousels in a docs or StackBlitz page | ||
| document.querySelectorAll('.carousel:not([data-bs-ride="carousel"])') | ||
| .forEach(carousel => { | ||
| bootstrap.getOrCreateInstance.Carousel(carousel) |
There was a problem hiding this comment.
When loading https://deploy-preview-37354--twbs-bootstrap.netlify.app/docs/5.2/components/carousel/, we have this in the console:
Uncaught TypeError: bootstrap.getOrCreateInstance is undefined
<anonymous> https://deploy-preview-37354--twbs-bootstrap.netlify.app/docs/5.2/assets/js/docs.min.js:6
<anonymous> https://deploy-preview-37354--twbs-bootstrap.netlify.app/docs/5.2/assets/js/docs.min.js:6
<anonymous> https://deploy-preview-37354--twbs-bootstrap.netlify.app/docs/5.2/assets/js/docs.min.js:6
Isn't it bootstrap.Carousel.getOrCreateInstance(carousel) here?
Tried a fix via 7fd7a3b. Let you check that. Please revert it if it causes any issue 🙏
Moreover, if I have well understood the discussions in the corresponding issue, this PR also tackles #37546 (newly created). We could mark it as duplicate and close it.
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Make the carousel docs page more sensible/logically structured:
data-bs-ride="carousel"and the weird "autoplay after first interaction"data-bs-ride="true"behaviour, as well as the fact that when animating, these carousels pause on hover/focusIn addition, this now explicitly initialises all carousels, so their touch behaviour will work right after page load (rather than only after the first click on a prev/next button).
Type of changes
Checklist
npm run lint)Live previews
Related issues
Closes #37295