communication-react-19
Version:
React library for building modern communication user experiences utilizing Azure Communication Services (React 19 compatible fork)
94 lines • 2.44 kB
TypeScript
import { IIconProps, IStyle, ITooltipHostProps } from '@fluentui/react';
import React from 'react';
/**
* Props for {@link _VideoEffectsItem}
*
* @internal
*/
export interface _VideoEffectsItemProps {
/**
* The key of the Video Background Effect.
* This is used to identify the Video Background Effect and is returned in the onChange event.
* It must be unique within the set of options.
* @example 'blur'
*/
itemKey: string;
/**
* The text to display for the Video effects item.
*/
title?: string;
/**
* Whether the Video effects item is currently in the selected state.
* @default false
*/
isSelected?: boolean;
/**
* Callback to invoke when the Video effects item is selected.
*/
onSelect?: (key: string) => void;
/**
* Whether the Video effects item is disabled.
* @default false
*/
disabled?: boolean;
/**
* The icon to display for the Video effects item.
* @default undefined (no icon)
*/
iconProps?: IIconProps;
/**
* Properties to have a Tooltip display when hovering over the Video effects item.
* @default undefined (no tooltip)
*/
tooltipProps?: ITooltipHostProps;
/**
* Aria label for the Video effects item.
*/
ariaLabel?: string;
/**
* Background to display for the Video effects item.
* @default undefined (no background image)
*/
backgroundProps?: {
/**
* The URL of the background image.
*/
url: string;
};
/**
* Styles for the Video effects item.
*/
styles?: _VideoEffectsItemStyles;
/**
* Imperative handle for calling focus()
*/
componentRef?: React.RefObject<{
focus: () => void;
}>;
}
/**
* Styles for {@link _VideoEffectsItem}
*
* @internal
*/
export interface _VideoEffectsItemStyles {
/**
* Styles for the container of the Video effects item.
*/
root: IStyle;
/**
* Styles for the container of the icon of the Video effects item.
*/
iconContainer: IStyle;
/**
* Styles for the text container of the Video effects item.
*/
textContainer: IStyle;
}
/**
* A component for displaying a Video Background Effect Option.
*
* @internal
*/
export declare const _VideoEffectsItem: (props: _VideoEffectsItemProps) => JSX.Element;
//# sourceMappingURL=VideoEffectsItem.d.ts.map