mirror of
https://github.com/status-im/react-native.git
synced 2025-01-09 17:15:54 +00:00
2cfe774a56
Summary: This is a revised follow up version from #8574 ( originally implemented in `objc` ) This PR change the implementation in JS suggested by javache **motivation** To supports vibration pattern like android. The [iOS vibration implementation link](http://stackoverflow.com/questions/12966467/are-there-apis-for-custom-vibrations-in-ios/13047464#13047464) mentioned by skv-headless at https://github.com/facebook/react-native/pull/6061#discussion_r54062592, which will not be accepted by apple since that implementation uses a private API. Thus, I use pure public API `NSTimer` to implement it. **Note** Since vibration time on iOS is not configurable, there are slightly differences with android. for example: **Android Usage:** `Vibration.vibrate([0, 500, 200, 500])` ==> V(0.5s) --wait(0.2s)--> V(0.5s) `Vibration.vibrate([300, 500, 200, 500])` ==> --wait(0.3s)--> V(0.5s) --wait(0.2s)--> V(0.5s) **iOS Usage:** if first argument is 0, it will not be included in pattern array. ( vibration Closes https://github.com/facebook/react-native/pull/9233 Differential Revision: D3775085 Pulled By: javache fbshipit-source-id: 370495857d5581399de32d2bed1ea1bcce193e9d
112 lines
2.9 KiB
JavaScript
112 lines
2.9 KiB
JavaScript
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*
|
|
* @providesModule Vibration
|
|
* @flow
|
|
*/
|
|
'use strict';
|
|
|
|
var RCTVibration = require('NativeModules').Vibration;
|
|
var Platform = require('Platform');
|
|
|
|
/**
|
|
* The Vibration API is exposed at `Vibration.vibrate()`.
|
|
* The vibration is asynchronous so this method will return immediately.
|
|
*
|
|
* There will be no effect on devices that do not support Vibration, eg. the simulator.
|
|
*
|
|
* **Note for android**
|
|
* add `<uses-permission android:name="android.permission.VIBRATE"/>` to `AndroidManifest.xml`
|
|
*
|
|
* **Android Usage:**
|
|
*
|
|
* [0, 500, 200, 500]
|
|
* V(0.5s) --wait(0.2s)--> V(0.5s)
|
|
*
|
|
* [300, 500, 200, 500]
|
|
* --wait(0.3s)--> V(0.5s) --wait(0.2s)--> V(0.5s)
|
|
*
|
|
* **iOS Usage:**
|
|
* if first argument is 0, it will not be included in pattern array.
|
|
*
|
|
* [0, 1000, 2000, 3000]
|
|
* V(fixed) --wait(1s)--> V(fixed) --wait(2s)--> V(fixed) --wait(3s)--> V(fixed)
|
|
*/
|
|
|
|
var _vibrating: boolean = false;
|
|
var _id: number = 0; // _id is necessary to prevent race condition.
|
|
|
|
function vibrateByPattern(pattern: Array<number>, repeat: boolean = false) {
|
|
if (_vibrating) {
|
|
return;
|
|
}
|
|
_vibrating = true;
|
|
if (pattern[0] === 0) {
|
|
RCTVibration.vibrate();
|
|
pattern = pattern.slice(1);
|
|
}
|
|
if (pattern.length === 0) {
|
|
_vibrating = false;
|
|
return;
|
|
}
|
|
setTimeout(() => vibrateScheduler(++_id, pattern, repeat, 1), pattern[0]);
|
|
}
|
|
|
|
function vibrateScheduler(id, pattern: Array<number>, repeat: boolean, nextIndex: number) {
|
|
if (!_vibrating || id !== _id) {
|
|
return;
|
|
}
|
|
RCTVibration.vibrate();
|
|
if (nextIndex >= pattern.length) {
|
|
if (repeat) {
|
|
nextIndex = 0;
|
|
} else {
|
|
_vibrating = false;
|
|
return;
|
|
}
|
|
}
|
|
setTimeout(() => vibrateScheduler(id, pattern, repeat, nextIndex+1), pattern[nextIndex]);
|
|
}
|
|
|
|
var Vibration = {
|
|
vibrate: function(pattern: number | Array<number> = 400, repeat: boolean = false) {
|
|
if (Platform.OS === 'android') {
|
|
if (typeof pattern === 'number') {
|
|
RCTVibration.vibrate(pattern);
|
|
} else if (Array.isArray(pattern)) {
|
|
RCTVibration.vibrateByPattern(pattern, repeat ? 0 : -1);
|
|
} else {
|
|
throw new Error('Vibration pattern should be a number or array');
|
|
}
|
|
} else {
|
|
if (_vibrating) {
|
|
return;
|
|
}
|
|
if (typeof pattern === 'number') {
|
|
RCTVibration.vibrate();
|
|
} else if (Array.isArray(pattern)) {
|
|
vibrateByPattern(pattern, repeat);
|
|
} else {
|
|
throw new Error('Vibration pattern should be a number or array');
|
|
}
|
|
}
|
|
},
|
|
/**
|
|
* Stop vibration
|
|
*/
|
|
cancel: function() {
|
|
if (Platform.OS === 'ios') {
|
|
_vibrating = false;
|
|
} else {
|
|
RCTVibration.cancel();
|
|
}
|
|
}
|
|
};
|
|
|
|
module.exports = Vibration;
|