15 Star 115 Fork 332

react-native-oh-library/usage-docs

Create your Gitee Account
Explore and code with more than 13.5 million developers,Free private repositories !:)
Sign up
文件
Clone or Download
react-native-snap-carousel.md 33.35 KB
Copy Edit Raw Blame History

Template version: v0.2.2

react-native-snap-carousel

Supported platforms License

[!TIP] GitHub address

Installation and Usage

Find the matching version information in the release address of a third-party library: @react-native-oh-library/react-native-snap-carousel Releases.For older versions that are not published to npm, please refer to the installation guide to install the tgz package.

Go to the project directory and execute the following instruction:

npm

npm install @react-native-oh-tpl/react-native-snap-carousel

yarn

yarn add @react-native-oh-tpl/react-native-snap-carousel

The following code shows the basic use scenario of the repository:

[!WARNING] The name of the imported repository remains unchanged.

import React, { useState } from "react";
import { View, Text, Image, StyleSheet } from "react-native";
import Carousel from "react-native-snap-carousel";

export default function SnapCarouselExample(): JSX.Element {
  const ENTRIES1 = [
    {
      title: "Beautiful and dramatic Antelope Canyon",
      subtitle: "Lorem ipsum dolor sit amet et nuncat mergitur",
      url: "https://www-file.huawei.com/-/media/corp2020/images/tech4all/cases1/12/white-headed-langur-en-1.png?la=zh",
    },
    {
      title: "Earlier this morning, NYC",
      subtitle: "Lorem ipsum dolor sit amet",
      url: "https://www-file.huawei.com/-/media/corp2020/images/tech4all/cases1/12/white-headed-langur-en-2.jpg?la=zh",
    },
    {
      title: "White Pocket Sunset",
      subtitle: "Lorem ipsum dolor sit amet et nuncat ",
      url: "https://www-file.huawei.com/-/media/corp2020/images/tech4all/cases1/12/white-headed-langur-en-1.png?la=zh",
    },
    {
      title: "Acrocorinth, Greece",
      subtitle: "Lorem ipsum dolor sit amet et nuncat mergitur",
      url: "https://www-file.huawei.com/-/media/corp2020/images/tech4all/cases1/12/white-headed-langur-en-2.jpg?la=zh",
    },
    {
      title: "The lone tree, majestic landscape of New Zealand",
      subtitle: "Lorem ipsum dolor sit amet",
      url: "https://www-file.huawei.com/-/media/corp2020/images/tech4all/cases1/12/white-headed-langur-en-1.png?la=zh",
    },
    {
      title: "Middle Earth, Germany",
      subtitle: "Lorem ipsum dolor sit amet",
      url: "https://www-file.huawei.com/-/media/corp2020/images/tech4all/cases1/12/white-headed-langur-en-2.jpg?la=zh",
    },
  ];

  const _renderItem = ({ item, index }: any) => {
    return (
      <View>
        <Image source={{ uri: item.url }} style={styles.image} />
      </View>
    );
  };

  return (
    <View>
      <Carousel
        data={ENTRIES1}
        renderItem={_renderItem}
        sliderWidth={300}
        itemWidth={250}
        containerCustomStyle={styles.carouselContainer}
      />
    </View>
  );
}

const styles = StyleSheet.create({
  carouselContainer: {
    height: 200,
    width: "100%",
    marginBottom: 20,
  },
  image: {
    resizeMode: 'cover',
    borderTopLeftRadius: 8,
    borderTopRightRadius: 8,
    width: 250,
    height: 300
  }
});

Constraints

Compatibility

To use this repository, you need to use the correct React-Native and RNOH versions. In addition, you need to use DevEco Studio and the ROM on your phone.

Check the release version information in the release address of the third-party library: @react-native-oh-library/react-native-snap-carousel Releases

Properties

[!TIP] The Platform column indicates the platform where the properties are supported in the original third-party library.

[!TIP] If the value of HarmonyOS Support is yes, it means that the HarmonyOS platform supports this property; no means the opposite; partially means some capabilities of this property are supported. The usage method is the same on different platforms and the effect is the same as that of iOS or Android.

Name Description Type Required Platform HarmonyOS Support
data Array of items to loop on Array yes iOS/Android yes
renderItem Takes an item from data and renders it into the list. The function receives one argument {item, index} (see Usage) and must return a React element. Function yes iOS/Android yes
itemWidth Width in pixels of carousel's items, must be the same for all of them Number yes iOS/Android yes
sliderWidth Width in pixels of the carousel itself Number yes iOS/Android yes
itemHeight Height in pixels of carousel's items, must be the same for all of them Number yes iOS/Android yes
sliderHeight Height in pixels of the carousel itself Number yes iOS/Android yes
loop Enable infinite loop mode. It won't work if enableSnap has been set to false. Boolean no iOS/Android yes
loopClonesPerSide Number of clones to append to each side of the original items. When swiping very quickly, the user will eventually need to pause for a quick second before the scroll is repositioned (this occurs when the end of the set is reached). By increasing this number, the user will be able to scroll more slides before having to stop; but you'll also load more items in memory. This is a trade-off between optimal user experience and performance. Number no iOS/Android yes
autoplay Trigger autoplay on mount. If you enable autoplay, we recommend you to set enableMomentum to false (default) and lockScrollWhileSnapping to true; this will enhance user experience a bit. Boolean no iOS/Android yes
autoplayDelay Delay before enabling autoplay on startup & after releasing the touch Number no iOS/Android yes
autoplayInterval Delay in ms until navigating to the next item Number no iOS/Android yes
layout Define the way items are rendered and animated. Possible values are 'default', 'stack' and 'tinder'. Setting this prop to either 'stack' or 'tinder' will activate useScrollView to prevent rendering bugs with FlatList. Therefore, those layouts won't be suited if you have a large data set since all items are going to be rendered upfront. String no iOS/Android yes
containerCustomStyle Optional styles for Scrollview's global wrapper View Style Object no iOS/Android yes
contentContainerCustomStyle Optional styles for Scrollview's items container View Style Object no iOS/Android yes
inactiveSlideOpacity Value of the opacity effect applied to inactive slides Number no iOS/Android yes
inactiveSlideScale Value of the 'scale' transform applied to inactive slides Number no iOS/Android yes
inactiveSlideShift Value of the 'translate' transform applied to inactive slides (see #204 or the "custom interpolations" doc for an example usage). This prop will have no effect with layouts others than the default one. on Number no iOS/Android yes
layoutCardOffset Use to increase or decrease the default card offset in both 'stack' and 'tinder' layouts. Number no iOS/Android yes
slideStyle Optional style for each item's container (the one whose scale and opacity are animated) Animated View Style Object no iOS/Android yes
scrollInterpolator Used to define custom interpolations. See the dedicated doc. Function no iOS/Android yes
slideInterpolatedStyle Used to define custom interpolations. See the dedicated doc. Function no iOS/Android yes
activeAnimationOptions Custom animation options. Note that useNativeDriver will be enabled by default and that opacity's easing will always be kept linear. Setting this prop to something other than null will trigger custom animations and will completely change the way items are animated: rather than having their opacity and scale interpolated based the scroll value (default behavior), they will now play the custom animation you provide as soon as they become active. This means you cannot use props layout, scrollInterpolator or slideInterpolatedStyle in conjunction with activeAnimationOptions. Object no iOS/Android yes
activeAnimationType Custom animation type: either 'decay', 'spring' or 'timing'. Note that it will only be applied to the scale animation since opacity's animation type will always be set to timing (no one wants the opacity to 'bounce' around). String no iOS/Android yes
activeSlideAlignment Determine active slide's alignment relative to the carousel. Possible values are: 'start', 'center' and 'end'. It is not recommended to use this prop in conjunction with the layout one. String no iOS/Android yes
activeSlideOffset From slider's center, minimum slide distance to be scrolled before being set to active. Number no iOS/Android yes
apparitionDelay FlatList's init is a real mess, with lots of unneeded flickers and slides movement. This prop controls the delay during which the carousel will be hidden when mounted. WARNING: on Android, using it may lead to rendering issues (i.e. images not showing up). Make sure to test thoroughly if you decide on using it. Number no iOS/Android yes
callbackOffsetMargin Scroll events might not be triggered often enough to get a precise measure and, therefore, to provide a reliable callback. This usually is an Android issue, which might be linked to the version of React Native you're using (see "Unreliable callbacks"). To work around this, you can define a small margin that will increase the "sweet spot"'s width. The default value should cover most cases, but you will want to increase it if you experience missed callbacks. Number no iOS/Android yes
enableMomentum See momentum Boolean no iOS/Android yes
enableSnap If enabled, releasing the touch will scroll to the center of the nearest/active item Boolean no iOS/Android yes
firstItem Index of the first item to display. ⚠️ Make sure to use inherited props [getItemLayout](https://reactnative.dev/docs/flatlist#getitemlayout) & [initialScrollIndex](https://reactnative.dev/docs/flatlist#initialscrollindex) if the prop doesn't seem to work. Number no iOS/Android yes
hasParallaxImages Whether the carousel contains components or not. Required for specific data to be passed to children. Boolean no iOS/Android yes
lockScrollTimeoutDuration This prop works in conjunction with lockScrollWhileSnapping. When scroll is locked, a timer is created in order to release the scroll if something goes wrong with the regular callback handling. Normally, you shouldn't have to use this prop. Number no iOS/Android yes
lockScrollWhileSnapping Prevent the user from swiping again while the carousel is snapping to a position. This prevents miscellaneous minor issues (inadvertently tapping an item while scrolling, stopping the scrolling animation if the carousel is tapped in the middle of a snap, clunky behavior on Android when short snapping quickly in opposite directions). The only drawback is that enabling the prop hinders the ability to swipe quickly between items as a little pause between swipes is needed. Note that the prop won't have any effect if enableMomentum is set to true, since it would otherwise impede the natural and expected behavior. Boolean no iOS/Android yes
scrollEnabled When false, the view cannot be scrolled via touch interaction (inherited prop) Boolean no iOS/Android yes
shouldOptimizeUpdates Whether to implement a shouldComponentUpdate strategy to minimize updates Boolean no iOS/Android yes
swipeThreshold Delta x when swiping to trigger the snap Number no iOS/Android yes
useScrollView Whether to use a ScrollView component instead of the default FlatList one. The advantages are to avoid rendering issues that can arise with FlatList and to provide compatibility with React Native pre- 0.43. The major drawbacks are that you won't benefit from any of FlatList's advanced optimizations and that you won't be able to use either VirtualizedList or FlatList's specific props. We recommend activating it only with a small set of slides and to test performance thoroughly in production mode. Since version 3.7.6, this prop also accepts a custom scroll component (see #498 for more info). Boolean no iOS/Android yes
vertical Layout slides vertically instead of horizontally Boolean no iOS/Android yes

Static Methods

[!TIP] The Platform column indicates the platform where the properties are supported in the original third-party library.

[!TIP] If the value of HarmonyOS Support is yes, it means that the HarmonyOS platform supports this property; no means the opposite; partially means some capabilities of this property are supported. The usage method is the same on different platforms and the effect is the same as that of iOS or Android.

Prop Description Type Required Platform HarmonyOS Support
onLayout(event) Exposed View callback; invoked on mount and layout changes Function no All yes
onScroll(event) Exposed ScrollView callback; fired while scrolling Function no All yes
onBeforeSnapToItem(slideIndex) Callback fired when the new active item has been determined, before snapping to it Function no All yes
onSnapToItem(slideIndex) Callback fired after snapping to an item Function no All yes

Known Issues

  • The enableMomentum property does not work effectively on iOS devices, but is normal on HarmonyOS devices: issue#1.

Others

License

This project is licensed under The MIT License (MIT).

Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/react-native-oh-library/usage-docs.git
git@gitee.com:react-native-oh-library/usage-docs.git
react-native-oh-library
usage-docs
usage-docs
master

Search