Skip to content

carousel: add missing to description and fix nextwhenvisible description#31809

Merged
XhmikosR merged 3 commits intotwbs:mainfrom
cankitm:corousel-doc-fix
Oct 5, 2020
Merged

carousel: add missing to description and fix nextwhenvisible description#31809
XhmikosR merged 3 commits intotwbs:mainfrom
cankitm:corousel-doc-fix

Conversation

@cankitm
Copy link
Copy Markdown
Contributor

@cankitm cankitm commented Oct 1, 2020

Added the to method and corrected nextWhenVisible description in Corousel Component documentation.

Fixes #31788

@XhmikosR XhmikosR changed the title docs-Update corousel doc : nextwhenvisible and to carousel: add missing to description and fix nextwhenvisible description Oct 1, 2020
@XhmikosR
Copy link
Copy Markdown
Member

XhmikosR commented Oct 1, 2020

BTW this is duplicate of #31800

@cankitm
Copy link
Copy Markdown
Contributor Author

cankitm commented Oct 1, 2020

BTW this is duplicate of #31800

#31800 was showing several unwanted changes, so opened a new PR, specifically related to the issue.

Comment thread site/content/docs/5.0/components/carousel.md Outdated
</tr>
<tr>
<td><code>nextWhenVisible</code></td>
<td>Don't cycle carousel to next when the page isn't visible or the carousel or its parent isn't visible. <strong>Returns to the caller before the target item has been shown</strong>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mdo or @patrickhlauke for word proofing. I feel like a "the" is missing?

@XhmikosR
Copy link
Copy Markdown
Member

XhmikosR commented Oct 5, 2020

@Johann-S does this need a backport or is the option present only in v5?

@Johann-S
Copy link
Copy Markdown
Member

Johann-S commented Oct 5, 2020

yep we should backport this in v4 too 👍

@XhmikosR
Copy link
Copy Markdown
Member

XhmikosR commented Oct 5, 2020

I don't see the option at all in v4-dev docs, so I guess we'll need to manually backport it. I'll add it to the 4.5.3 project but any patch to backport it is welcome.

@XhmikosR XhmikosR merged commit ce1db01 into twbs:main Oct 5, 2020
@cankitm
Copy link
Copy Markdown
Contributor Author

cankitm commented Oct 7, 2020

I don't see the option at all in v4-dev docs, so I guess we'll need to manually backport it. I'll add it to the 4.5.3 project but any patch to backport it is welcome.

Manual Backport : #31851

@XhmikosR XhmikosR mentioned this pull request Oct 8, 2020
XhmikosR pushed a commit that referenced this pull request Oct 9, 2020
carousel: add missing `to` and `nextwhenvisible` description
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Confusion on the "nextWhenVisible()" method on Carousel Component

4 participants