Haptics Web Implementation

[cameronrr]

Feature Request

Plugin

HapticsWeb (extends WebPlugin implements HapticsPlugin)

Description

Haptics has native implementations, but no web implementation. The web plugin will make use of the web Vibration API to deliver functionality on vibration enabled devices (i.e. mobile). Note that some browsers implement permissions i.e. prompting the user to allow vibration when first run.

Platform(s)

Web

Preferred Solution

A Capacitor plugin which exposes the following functionality:

Vibration	Example Code	Behaviour
Once	navigator.vibrate(1000) or navigator.vibrate([1000])	Vibrate for 1000ms
Sequence	navigator.vibrate([50, 100, 150])	Vibrate for 50ms, still for 100ms, vibrate for 150ms
Cancel	navigator.vibrate(0) or navigator.vibrate([])	Cancels any existing vibrations

New Plugin

export declare type HapticsWebVibratePattern = number | number[]
export declare class HapticsWeb extends WebPlugin implements HapticsPlugin {
    constructor()
    impact(): void;
    notification(): void;
    vibrate(options: HapticsWebVibratePattern): Promise<any>
    selectionStart(): void;
    selectionChanged(): void;
    selectionEnd(): void;
}

Vibrate Functionality

HapticsWeb.prototype.vibrate = function (options) {
    if (!navigator.vibrate) {
        return Promise.reject('Web Haptics API not available');
    }
    return navigator.vibrate(options);
};

Additional Context

W3C Vibration API: https://www.w3.org/TR/vibration/
Google Chrome Samples: https://googlechrome.github.io/samples/vibration/
MDN Web Docs: https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API/

[cameronrr]

node_modules\@capacitor\core\dist\esm\core-plugin-definitions.d.ts contains interface VibrateOptions but this never seems to be assigned anywhere i.e. not to HapticsPlugin.vibrate().

export interface VibrateOptions {
    duration?: number;
}

The Web API requires options (a pattern) to be passed as number | number[]. It might be needed to review the implementation of VibrateOptions in order to use the same vibrate() method consistently across platforms.

[ionitron-bot]

Thanks for the issue! This issue is being locked to prevent comments that are not relevant to the original issue. If this is still an issue with the latest version of the plugin, please create a new issue and ensure the template is fully filled out.