https://github.com/netyouli/react-native-whc-banner
A react native module to banner auto play loop component, it works on iOS and Android
https://github.com/netyouli/react-native-whc-banner
banner page react react-native react-native-whc-banner swiper view viewpager
Last synced: 4 days ago
JSON representation
A react native module to banner auto play loop component, it works on iOS and Android
- Host: GitHub
- URL: https://github.com/netyouli/react-native-whc-banner
- Owner: netyouli
- License: mit
- Created: 2018-02-07T05:16:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-23T04:29:05.000Z (almost 7 years ago)
- Last Synced: 2025-10-05T02:47:09.910Z (17 days ago)
- Topics: banner, page, react, react-native, react-native-whc-banner, swiper, view, viewpager
- Language: JavaScript
- Homepage: https://github.com/netyouli/react-native-whcapp
- Size: 3.64 MB
- Stars: 59
- Watchers: 4
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-native-whc-banner
A react native module to banner auto play loop component, it works on iOS and Android.
[ ](https://github.com/netyouli/react-native-whc-banner/releases)
[ ](https://github.com/netyouli/react-native-whc-banner/pulls)
[ ](https://www.npmjs.com/package/react-native-whc-banner)
[](https://raw.githubusercontent.com/crazycodeboy/react-native-whc-loading/master/LICENSE)
[ ](https://github.com/netyouli/react-native-whc-banner/blob/master/README.zh.md)
## Content
- [Installation](#installation)
- [Demo](#demo)
- [Getting started](#getting-started)
- [API](#api)
- [Contribution](#contribution)
## Installation
* 1.Run `npm i react-native-whc-banner --save`
* 2.`import Banner, {IndicaterAlign, IndicaterType} from 'react-native-whc-banner'`
## Demo
* [Example](https://github.com/netyouli/react-native-whc-banner/tree/master/example)
## Getting started
Add `react-native-whc-banner` to your js file.
`import Banner, {IndicaterAlign, IndicaterType} from 'react-native-whc-banner'`
Your component's render method, use Banner:
```jsx
render() {
return (
);
}
```
### Basic usage
```javascript
render() {
return (
);
}
```
### Custom Banner
```javascript
render() {
return (
);
}
```
## API
IndicaterType | Description
----------------- | -----------
IndicaterType.none | There is no indicator
IndicaterType.circle | Circle number indicator
IndicaterType.number | Number indicator
IndicaterType.title | Title text indicator
IndicaterType.number_title | Number and title text indicator
IndicaterType.dot | Dot indicator
IndicaterAlign | Description
----------------- | -----------
IndicaterAlign.left | Indicator element left alignment
IndicaterAlign.center | Indicator element center alignment
IndicaterAlign.right | Indicator element right alignment
Props | Type | Optional | Default | Description
----------------- | -------- | -------- | ----------- | -----------
style | ViewPropTypes.style |true | {} | Custom banner style
indicaterStyle | ViewPropTypes.style | true | {} | Custom banner indicater style
dotStyle | ViewPropTypes.style | true | {} | Custom indicater for dot style
currentDotStyle | ViewPropTypes.style | true | {} | Custom indicater current dot style
circleStyle | ViewPropTypes.style | true | {} | Custom indicater for circle style
numberStyle | Text.propTypes.style | true | {} | Custom indicater for number style
titleStyle | Text.propTypes.style | true | {} | Custom indicater for title style
titles | PropTypes.array | true | [] | When indicater for title type show title
autoPlay | PropTypes.bool | true | true | Is auto play for banner
autoLoop | PropTypes.bool | true | true | Is auto loop for banner
indicaterType | IndicaterType | true | IndicaterType.dot | Custom indicater type
indicaterAlign | IndicaterAlign | true | IndicaterAlign.center | Custom indicater align type
duration | PropTypes.number | true | 5000 | Custom banner auto play duration
## Contribution
Issues are welcome. Please add a screenshot of bug and code snippet. Quickest way to solve issue is to reproduce it on one of the examples.
Pull requests are welcome. If you want to change API or making something big better to create issue and discuss it first.
---
**MIT Licensed**