react-native-reanimated-carousel icon indicating copy to clipboard operation
react-native-reanimated-carousel copied to clipboard

Mismatch between website documentation and implementation

Open mkhalila opened this issue 1 year ago • 5 comments

Hey, I'm new to using RNRC and I'm on version 3.5.1. The docs (https://reanimated-carousel.dev/usage) on this page mention two things that I can't seem to use in the current version:

  1. onConfigurePanGesture: when I try pass this prop in I get a Property 'onConfigurePanGesture' does not exist.... I'd like to get this working because I am rendering multiple horizontal carousels within a vertical ScrollView and I'd like vertical scrolls to be handled by the ScrollView and not be 'hijacked' by the Carousel.
  2. Pagination: when I try to import it like the docs, I get a: Module '"react-native-reanimated-carousel"' has no exported member 'Pagination'.
import ReanimatedCarousel, {
  ICarouselInstance,
  Pagination
} from "react-native-reanimated-carousel";

Thanks in advance.

mkhalila avatar Jun 03 '24 14:06 mkhalila

Hey there, @mkhalila! I'm here to help you with any bugs, questions, or contributions you may have. Let's see what's going on with the React Native Reanimated Carousel and get it sorted out for you.

The issues you are encountering are likely due to the version of react-native-reanimated-carousel you are using. The features onConfigurePanGesture and Pagination are not available in version 3.5.1, but they are present in version 4.0.0-alpha.12.

To resolve these issues, you need to upgrade to version 4.0.0-alpha.12. You can do this by updating your package.json or running the following command:

yarn add [email protected]

After upgrading, you should be able to use the onConfigurePanGesture prop and import Pagination as shown in the documentation.

Here is the corrected import statement:

import ReanimatedCarousel, {
  ICarouselInstance,
  Pagination
} from "react-native-reanimated-carousel";

And you can use the onConfigurePanGesture prop like this:

<ReanimatedCarousel
  onConfigurePanGesture={(e) => {
    // Your configuration logic here
  }}
  // other props
/>

Make sure to follow the documentation for any additional setup or usage instructions specific to version 4.0.0-alpha.12 [1].

To continue talking to Dosu, mention @dosu.

dosubot[bot] avatar Jun 03 '24 14:06 dosubot[bot]

Had the same issue. Using version 4.0.0-alpha.12 worked for me.

haeniya avatar Aug 02 '24 09:08 haeniya

same issue, any updates on this ?

milan-vala avatar Aug 12 '24 08:08 milan-vala

same for me

hungnm2VPBankS avatar Aug 15 '24 02:08 hungnm2VPBankS

Why is the documentation site using alpha releases?

Should the static Github workflow be changed to use the v3.x.x branch instead of main?

https://github.com/dohooo/react-native-reanimated-carousel/blob/5e77b660451bf00a2a4c5c6283cb52234c64922e/.github/workflows/static.yml#L7

traviswimer avatar Oct 02 '24 00:10 traviswimer

Hi, @mkhalila. I'm Dosu, and I'm helping the react-native-reanimated-carousel team manage their backlog. I'm marking this issue as stale.

Issue Summary:

  • You reported a discrepancy between the documentation and RNRC version 3.5.1 regarding the onConfigurePanGesture prop and Pagination component.
  • I suggested upgrading to version 4.0.0-alpha.12, which user haeniya confirmed resolves the issue.
  • Other users, including milan-vala and hungnm2VPBankS, reported similar issues.
  • User traviswimer questioned the use of alpha releases in documentation and suggested updating the GitHub workflow.

Next Steps:

  • Please confirm if this issue is still relevant to the latest version of the react-native-reanimated-carousel repository. If so, you can keep the discussion open by commenting here.
  • If there is no further activity, this issue will be automatically closed in 7 days.

Thank you for your understanding and contribution!

dosubot[bot] avatar Feb 21 '25 16:02 dosubot[bot]