From 231e55430028a8ba8c26e23ad36d15e766dc7d80 Mon Sep 17 00:00:00 2001 From: Chris Date: Tue, 31 Oct 2023 15:03:16 -0700 Subject: [PATCH 1/2] docs(preact-components-carousel): update carousel readme to use correct swiper version doc links --- .../src/components/Molecules/Carousel/readme.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/snap-preact-components/src/components/Molecules/Carousel/readme.md b/packages/snap-preact-components/src/components/Molecules/Carousel/readme.md index 7ab93d74c..321352726 100644 --- a/packages/snap-preact-components/src/components/Molecules/Carousel/readme.md +++ b/packages/snap-preact-components/src/components/Molecules/Carousel/readme.md @@ -1,14 +1,14 @@ # Carousel -Renders a carousel of slides using children, built with [Swiper](https://swiperjs.com/) +Renders a carousel of slides using children, built with [Swiper](https://swiper6.vercel.app) ## Sub-components - Icon ## Usage -Additional [Swiper Component Props](https://swiperjs.com/react#swiper-props) can be specified, but may need to be camelCased where appropriate. -Additional [Swiper Modules](https://swiperjs.com/swiper-api#modules) can be provided via the `modules` prop; these may need additional props and or stylesheets. +Additional [Swiper Component Props](https://swiper6.vercel.app/swiper-api#parameters) can be specified, but may need to be camelCased where appropriate. +Additional [Swiper Modules](https://swiper6.vercel.app/swiper-api#modules) can be provided via the `modules` prop; these may need additional props and or stylesheets. ```jsx {children} @@ -21,7 +21,7 @@ The `loop` prop enables 'infinite' looping through the result set when swiping o ``` ### pagination -The `pagination` prop can take a bool to enable pagination dots, or an object containing a SwiperOptions.pagination config object. Types can be found in [swiper docs](https://swiperjs.com/swiper-api#param-pagination-dynamicBullets). +The `pagination` prop can take a bool to enable pagination dots, or an object containing a SwiperOptions.pagination config object. Types can be found in [swiper docs](https://swiper6.vercel.app/swiper-api#pagination). ```jsx {children} @@ -97,7 +97,7 @@ The `onInit` prop can be used to tie into the initialization event for swiper. ``` ### modules -The `modules` prop accepts additional [Swiper Modules](https://swiperjs.com/swiper-api#modules) - these may need additional props and or stylesheets to function. We include `Navigation` and `Pagination` modules by default. +The `modules` prop accepts additional [Swiper Modules](https://swiper6.vercel.app/swiper-api#modules) - these may need additional props and or stylesheets to function. We include `Navigation` and `Pagination` modules by default. ```jsx import { Scrollbar } from 'swiper'; @@ -112,7 +112,7 @@ An object that modifies the responsive behavior of the carousel at various viewp The object key specified the viewport for when the parameters will be applied. -The default configuration contains the following properties, however **`any Carousel props`** or [Swiper API parameters](https://swiperjs.com/swiper-api#parameters) can also be specified. +The default configuration contains the following properties, however **`any Carousel props`** or [Swiper API parameters](https://swiper6.vercel.app/swiper-api#parameters) can also be specified. `slidesPerView` - number of products to display per page From a502c0964925179f3061a9efae6e819e79c92deb Mon Sep 17 00:00:00 2001 From: Chris Date: Tue, 31 Oct 2023 15:31:04 -0700 Subject: [PATCH 2/2] docs(preact-components-carousel): more swiper doc tweaks --- .../src/components/Molecules/Carousel/readme.md | 4 ++-- .../src/components/Organisms/Recommendation/readme.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/packages/snap-preact-components/src/components/Molecules/Carousel/readme.md b/packages/snap-preact-components/src/components/Molecules/Carousel/readme.md index 321352726..fd83c33ca 100644 --- a/packages/snap-preact-components/src/components/Molecules/Carousel/readme.md +++ b/packages/snap-preact-components/src/components/Molecules/Carousel/readme.md @@ -1,6 +1,6 @@ # Carousel -Renders a carousel of slides using children, built with [Swiper](https://swiper6.vercel.app) +Renders a carousel of slides using children, built with [Swiper v6.8.4](https://swiper6.vercel.app) ## Sub-components - Icon @@ -101,7 +101,7 @@ The `modules` prop accepts additional [Swiper Modules](https://swiper6.vercel.ap ```jsx import { Scrollbar } from 'swiper'; -{children} +{children} ``` ### autoAdjustSlides diff --git a/packages/snap-preact-components/src/components/Organisms/Recommendation/readme.md b/packages/snap-preact-components/src/components/Organisms/Recommendation/readme.md index 1c1a2028e..9696cc354 100644 --- a/packages/snap-preact-components/src/components/Organisms/Recommendation/readme.md +++ b/packages/snap-preact-components/src/components/Organisms/Recommendation/readme.md @@ -13,8 +13,8 @@ Any modification to the results array and data are recommended to be made using ## Usage -Additional [Swiper Component Props](https://swiperjs.com/react#swiper-props) can be specified, but may need to be camelCased where appropriate. -Additional [Swiper Modules](https://swiperjs.com/swiper-api#modules) can be provided via the `modules` prop; these may need additional props and or stylesheets. +Additional [Swiper Component Props](https://swiper6.vercel.app/swiper-api#parameters) can be specified, but may need to be camelCased where appropriate. +Additional [Swiper Modules](https://swiper6.vercel.app/swiper-api#modules) can be provided via the `modules` prop; these may need additional props and or stylesheets. ### controller The required `controller` prop specifies a reference to the RecommendationController @@ -81,11 +81,11 @@ The `nextButton` prop specifies the next button element of the carousel. This ca ``` ### modules -The `modules` prop accepts additional [Swiper Modules](https://swiperjs.com/swiper-api#modules) - these may need additional props and or stylesheets to function. We include `Navigation` and `Pagination` modules by default. +The `modules` prop accepts additional [Swiper Modules](https://swiper6.vercel.app/swiper-api#modules) - these may need additional props and or stylesheets to function. We include `Navigation` and `Pagination` modules by default. ```jsx import { Scrollbar } from 'swiper'; - + ``` ### breakpoints @@ -93,7 +93,7 @@ An object that modifies the responsive behavior of the carousel at various viewp The object key specified the viewport for when the parameters will be applied. -The default configuration contains the following properties, however **`any Recommendation props`**, or [Swiper API parameters](https://swiperjs.com/swiper-api#parameters) can also be specified. +The default configuration contains the following properties, however **`any Recommendation props`**, or [Swiper API parameters](https://swiper6.vercel.app/swiper-api#parameters) can also be specified. `slidesPerView` - number of products to display per page