Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tiaanduplessis/react-native-phone-call
Initiate a phone call in React Native
https://github.com/tiaanduplessis/react-native-phone-call
call phone-call react-native
Last synced: about 1 month ago
JSON representation
Initiate a phone call in React Native
- Host: GitHub
- URL: https://github.com/tiaanduplessis/react-native-phone-call
- Owner: tiaanduplessis
- License: mit
- Created: 2017-01-23T13:27:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T13:24:45.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T04:50:45.554Z (5 months ago)
- Topics: call, phone-call, react-native
- Language: JavaScript
- Size: 232 KB
- Stars: 169
- Watchers: 5
- Forks: 27
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-native - react-native-phone-call ★76 - A simple way to initiate a phone call in React Native (Components / System)
- awesome-react-native - react-native-phone-call ★76 - A simple way to initiate a phone call in React Native (Components / System)
- awesome-react-native - react-native-phone-call ★76 - A simple way to initiate a phone call in React Native (Components / System)
- awesome-react-native - react-native-phone-call ★76 - A simple way to initiate a phone call in React Native (Components / System)
README
# react-native-phone-call
[](https://npmjs.org/package/react-native-phone-call)
[](https://npmjs.org/package/react-native-phone-call)
[](https://github.com/RichardLitt/standard-readme)
[](https://npmjs.org/package/react-native-phone-call)
[](http://makeapullrequest.com)
Initiate a phone call in React Native.
## Table of Contents
- [react-native-phone-call](#react-native-phone-call)
- [Background](#background)
- [Running on iOS simulator](#running-on-ios-simulator)
- [Running on Android SDK 30+](#running-on-android-sdk-30)
- [Limitations](#limitations)
- [Install](#install)
- [Usage](#usage)
- [Example with phone and extension.](#example-with-phone-and-extension)
- [API](#api)
- [Contributing](#contributing)
- [License](#license)
## Background
This is a small wrapper that allows you to initiate a phone call in React Native.
### Running on iOS simulator
When running on the iOS simulator, you will get a `the URL is invalid` error. This will work on an actual device. **The iOS simulator does not have access to the dialer app.**.
### Running on Android SDK 30+
Android SDK 30 introduced changes around how apps can query and interact with other apps. This means `Linking.canOpenURL` returns false for all links unless a `` element is added to `AndroidManifest.xml`. Adding the following intent to `android/app/src/main/AndroidManifest.xml` should resolve the issue:
```groovy
```
### Limitations
This module only provides a simple wrapper around the Linking API and is thus limited in the functionality it can provide. If you are looking for additional functionality, such as being able to initiate a phone call without user confirmation, please use other packages like [react-native-immediate-phone-call](https://github.com/wumke/react-native-immediate-phone-call).
## Install
Install the package locally within you project folder with your package manager:
With `npm`:
```sh
npm install react-native-phone-call
```
With `yarn`:
```sh
yarn add react-native-phone-call
```
## Usage
To use the module, call the function with an object containing the number to call as a argument.
```js
import call from 'react-native-phone-call'
const args = {
number: '9093900003', // String value with the number to call
prompt: false, // Optional boolean property. Determines if the user should be prompted prior to the call
skipCanOpen: true // Skip the canOpenURL check
}
call(args).catch(console.error)
```
### Example with phone and extension.
Use commas to add time between pressing different digits. (ex. dial a number and wait to be connected and menu to start being read. Press a number for an extension. Even wait longer for another menus and press another number for another extension.)
```js
const args = {
number: '9093900003,,,3,,,274', // Use commas to add time between digits.
prompt: false
}
call(args).catch(console.error)
```
## API
For all configuration options, please see the [API docs](https://paka.dev/npm/react-native-phone-call).
## Contributing
Got an idea for a new feature? Found a bug? Contributions are welcome! Please [open up an issue](https://github.com/tiaanduplessis/react-native-phone-call/issues) or [make a pull request](https://makeapullrequest.com/).
## License
[MIT © Tiaan du Plessis](./LICENSE)