useDisconnectButton
function useDisconnectButton(props?): {
buttonProps: DisconnectButtonProps;
};Defined in: packages/react/src/hooks/controlbar/useDisconnectButton.ts:41
The useDisconnectButton hook is used to implement the DisconnectButton or your custom implementation of it. It adds onClick handler to the button to disconnect from the room.
Parameters
| Parameter | Type |
|---|---|
props | UseDisconnectButtonProps |
Returns
{
buttonProps: DisconnectButtonProps;
}buttonProps
buttonProps: DisconnectButtonProps;Example
// Basic — render a custom disconnect button.
const { buttonProps } = useDisconnectButton({ stopTracks: true });
return <button {...buttonProps}>Disconnect</button>;
// Advanced — place disconnect beside room audio controls.
function LeaveControls() {
const { buttonProps } = useDisconnectButton({ stopTracks: true });
return (
<VoiceRoom agent={agent}>
<button {...buttonProps}>Leave room</button>
<RoomAudioRenderer />
</VoiceRoom>
);
}