Common React Native components used by Roqay packed in library for usage in future projects.
yarn add roqay-react-native-common-components
The package depends on some third party packages that needs to be installed on the project as well. To install them you can use the following commands:
yarn add react-native-paper react-native-safe-area-context
As the package depends on react-native-paper
, your root component must be wrapped with Provider
from react-native-paper
.
See React Native Paper Getting Started for more details about adding react-native-paper
to your project.
As mentioned in React Native Paper Getting Started, react-native-paper
also depends on react-native-vector-icons
so make sure to add it to your project as well.
If you intend using .svg
images for components that support them then make sure to add react-native-vector-image
to your project and follow the installation steps as well.
Using ImagePlaceholder
component
If you intend using ImagePlaceholder
component then make sure to add react-native-fast-image
, react-native-progress
and react-native-svg
to your project.
Using ScrollView
component
If you intend using ScrollView
component then make sure to add react-native-keyboard-aware-scroll-view
to your project.
Using LogUtils
If you intend using LogUtils
then make sure to add reactotron-react-native
as a dev dependency and both @react-native-firebase/app
and @react-native-firebase/crashlytics
as dependencies to your project and follow the instruction for them.
Example is available in example folder. To run the example run the following commands:
cd example
yarn
yarn android
yarn ios
Each component has its own usage part in the documentation.
- AlertDialog
- Button
- Card
- Checkbox
- Dialog
- FlatList
- IconButton
- ImagePlaceholder
- LoadingDialog
- RadioButton
- ScrollView
- SelectDialog
- Text
- TextInput
See the contributing guide to learn how to contribute to the repository and the development workflow.
MIT