1.0.8 • Published 2 years ago

react-native-custom-scroll-indicator v1.0.8

Weekly downloads
11
License
ISC
Repository
github
Last release
2 years ago

react-native-custom-scroll-indicator

React native custom scroll bar (indicator)

RN 自定义滑动指示器(滚动条)

PRs Welcome

Installation / 安装

yarn add react-native-custom-scroll-indicator

Example

codesandbox RN-web 需要点击 Open In New Windows 然后用手机模式查看

Usage / 使用

import ScrollIndicator from "react-native-custom-scroll-indicator";

General / 基础使用

<ScrollIndicator
    viewBoxStyle={{
        alignItems: "center",
        marginTop: 60,
        flex: 1
    }} scrollViewBoxStyle={{
        width: undefined
    }}>
    <Content />
</ScrollIndicator>

Advanced / 进阶用法

<ScrollIndicator
    indicatorBgPadding={6}
    viewBoxStyle={{
        alignItems: "center",
        marginTop: 60
    }}
    indicatorBackgroundStyle={{
        height: 4,
        width: 40,
        borderRadius: 5
    }} indicatorStyle={{
        height: 2,
        width: 40,
        borderRadius: 4
    }} indicatorBoxStyle={{
        marginTop: 10,
        justifyContent: "center",
        alignItems: "center"
    }} scrollViewBoxStyle={{
        borderWidth: 2,
        width: 300,
        borderColor: "red"
    }}>
    <Content />
</ScrollIndicator>

API

PropsDescriptionTypeDefault
viewBoxStyleentire component View style / 整个组件的样式StyleProp\<ViewStyle>
scrollViewBoxStyleScrollView outline style / 被滑动的 ScrollView 外部的 View 的样式StyleProp\<ViewStyle>
scrollViewStyleScrollView style /被滑动的 ScrollView 的样式StyleProp\<ViewStyle>
indicatorBgPaddingThe sum of the two ends of the indicator background / 指示器的背景两端延伸之和number0
indicatorBackgroundStyleIndicator background style / 指示器的背景样式StyleProp\<ViewStyle>width:140; height: 8; *
indicatorStyleIndicator style / 指示器的样式StyleProp\<ViewStyle>width:20; height: 4;
indicatorBoxStyleIndicator outline View style / 指示器外 View 的样式StyleProp\<ViewStyle>*
alwaysIndicatorBounce(iOS)Always turn on the rebound effect of the indicator / 总是开启指示器的回弹效果booleanfalse
animatedScrollViewParamsAnimated.ScrollView params / Animated.ScrollView 的原生参数ScrollViewProps
onScrollListenerCallback when sliding / 滑动时的回调(e: NativeSyntheticEvent\<unknown>) => void

* The length of the indicator background defaults to add the length of the indicator / 指示器背景的长度默认加上指示器的长度