@eslam-elmeniawy/react-native-common-components v1.5.2
@eslam-elmeniawy/react-native-common-components
Common
ReactNativecomponents packed in library for usage in projects.
Installation
yarn add @eslam-elmeniawy/react-native-common-componentsThe 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-contextAs 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.
Using .svg props available in some components
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 @d11/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-controller to your project and follow the installation steps as well.
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
Example is available in example folder.
To run the example run the following commands:
# setup project by installing dependencies.
yarn
# start the Metro server for the example app.
yarn example start
# run the example app on Android.
yarn example android
# run the example app on iOS.
yarn example iosUsage
Each component has its own usage part in the documentation.
Components
- AlertDialog
- Button
- Checkbox
- Dialog
- FlatList
- IconButton
- ImagePlaceholder
- LoadingDialog
- RadioButton
- ScrollView
- SelectDialog
- Text
- TextInput
Utils
Types
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
MIT