communication-react-19
Version:
React library for building modern communication user experiences utilizing Azure Communication Services (React 19 compatible fork)
49 lines • 1.2 kB
TypeScript
/// <reference types="react" />
import { ControlBarButtonProps } from './ControlBarButton';
/**
*@public
*/
export interface HoldButtonProps extends ControlBarButtonProps {
/**
* Utility property for using this component with communication react handlers
* Holds the call or resumes it based on call state.
*/
onToggleHold: () => Promise<void>;
/**
* Optional strings to override in component
*/
strings?: HoldButtonStrings;
}
/**
* Strings for the hold button labels
* @public
*/
export interface HoldButtonStrings {
/**
* Label for when action is to resume call.
*/
onLabel?: string;
/**
* Label for when action is to hold call.
*/
offLabel?: string;
/**
* Content for when button is checked
*/
tooltipOnContent?: string;
/**
* Content for when button is unchecked
*/
tooltipOffContent?: string;
}
/**
* a button to hold or resume a ongoing call.
*
* Can be used with {@link ControlBar}
*
* @param props - properties for the hold button.
* @returns
* @public
*/
export declare const HoldButton: (props: HoldButtonProps) => JSX.Element;
//# sourceMappingURL=HoldButton.d.ts.map