updated carousel docs. #1675
updated carousel docs. #1675
Conversation
siddhantrawal
requested review from
mayank99 and
r100-stack
and removed request for
a team
|
Me and @rohan-kadkol think that this page looks complete. @mayank99 Do you think it is missing something? Not sure whether I should change subcomponents to composition API and define their props instead of them showing in a table? |
Co-authored-by: Rohan Kadkol <[email protected]>
…win/iTwinUI into siddhant/update_carousel_docs
There was a problem hiding this comment.
Carousel.Navigation has a JSDoc comment saying the Carousel.Navigation must be placed before the slides (Carousel.Slider or custom slides) in DOM (#1626, #1626 (comment)). So the "Navigation" should likely mention that.
Another mention in Carousel's JSDocs:
UPDATE: Just realized that we have such comments in DotsList's JSDocs too. So probably need to mention this under the "DotsList" subheading too
Co-authored-by: Rohan Kadkol <[email protected]>
…win/iTwinUI into siddhant/update_carousel_docs
Added. |
| @@ -61,13 +61,13 @@ This component uses a composition approach, similar to most of the other compone | |||
|
|
|||
| ### Navigation | |||
|
|
|||
| The `Carousel.Navigation` component by default consists of the `PreviousButton` and `NextButton` shown on the left and right, and the `Carousel.DotsList` component shown in the middle. `children` can be specified to override what is shown in this navigation section. | |||
| The `Carousel.Navigation` component by default consists of the `PreviousButton` and `NextButton` shown on the left and right and the `Carousel.DotsList` component shown in the middle. The navigation section must be present before the slides in DOM order.`children` can be specified to override what is shown in this navigation section. | |||
There was a problem hiding this comment.
Can the "must" part somehow be given more emphasis? Maybe we create an alert type component for this important piece of information? E.g. from the Astro Docs (link):
To do this, maybe we can re-purpose the <Placeholder>?
But for this PR at least, in the interest of time, you can just make the "must" portion emphasized some way. Maybe bold text? The Alert type can come later. Maybe we can make a mention of this idea in #961 to remember for the future.
There was a problem hiding this comment.
New paragraph starting with a bold "Important:"?
Co-authored-by: Mayank <[email protected]>
Co-authored-by: Mayank <[email protected]>
Co-authored-by: Mayank <[email protected]>
Co-authored-by: Mayank <[email protected]>
Co-authored-by: Mayank <[email protected]>
Co-authored-by: Mayank <[email protected]>
Co-authored-by: Mayank <[email protected]>
Co-authored-by: Mayank <[email protected]>
Changes
Updated documentation for the Carousel component.
Testing
Docs