Important
This repository has been merged into @capacitor-community/volume-buttons, where is it going to be actively maintained
Hardware volume buttons listener for Capacitor
npm install capacitor-custom-button
npx cap sync useEffect(() => {
const onCustomButtonPressed = ({ isLongPress }: CustomButtonPressed) => {
console.log(key);
};
const listener = CustomButton.addListener('customButtonPressed', onCustomButtonPressed);
return () => {
listener.remove();
};
}, []);addListener('pttButtonPressed', ...)addListener('headsetButtonPressed', ...)removeAllListeners()- Interfaces
- Type Aliases
addListener(event: 'pttButtonPressed', listenerFunc: ButtonPressedListener) => Promise<PluginListenerHandle> & PluginListenerHandleListen for presses on the hardware CUSTOM PTT button
| Param | Type |
|---|---|
event |
'pttButtonPressed' |
listenerFunc |
ButtonPressedListener |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
Since: 1.0.0
addListener(event: 'headsetButtonPressed', listenerFunc: ButtonPressedListener) => Promise<PluginListenerHandle> & PluginListenerHandleListen for presses on the hardware HEADSET PTT button
| Param | Type |
|---|---|
event |
'headsetButtonPressed' |
listenerFunc |
ButtonPressedListener |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
Since: 1.0.0
removeAllListeners() => Promise<void>Removes all listeners for this plugin
Since: 1.0.0
| Prop | Type |
|---|---|
remove |
() => Promise<void> |
({ isLongPress }: ButtonPressed): void
{ isLongPress: boolean }