leecade/react-native-swiper

update the documentation

Open

#1179 opened on Apr 24, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (10,334 stars) (2,346 forks)batch import
help wanted

Description

Hi, Methods (like scrollTo) are not listed (and explained) in the documentation https://github.com/leecade/react-native-swiper

The documentation should be updated.

Contributor guide

Tech stack
reactreact nativejavascript
Domain
mobilefrontenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic React Native knowledgeunderstanding of component APIs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the source code of the Swiper component (likely in the main component file) to identify all available methods such as scrollTo. Then update the README or relevant documentation file to list and explain each method, including parameters and usage examples. Follow the existing documentation format and check for any similar PRs or issues for reference.