Interface MiniCardOptions

Interface defining the props for the MiniCard component.

MiniCard is a compact display component for showing participant avatars/initials with optional media status icons in grid layouts or sidebar views.

MiniCardOptions

Display Properties:

interface MiniCardOptions {
    initials?: string;
    fontSize?: number;
    customStyle?: StyleProp<ViewStyle>;
    imageSource?: string;
    roundedImage?: boolean;
    imageStyle?: StyleProp<ImageStyle>;
    showVideoIcon?: boolean;
    showAudioIcon?: boolean;
    name?: string;
    customMiniCard?: CustomMiniCardType;
    parameters?: any;
    style?: object;
    renderContent?: ((options: {
        defaultContent: ReactNode;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
    renderContainer?: ((options: {
        defaultContainer: ReactNode;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

initials? fontSize? customStyle? imageSource? roundedImage? imageStyle? showVideoIcon? showAudioIcon? name? customMiniCard? parameters? style? renderContent? renderContainer?

Properties

Optionalinitials

initials?: string

Participant initials to display when no image is available (e.g., "AB" for "Alice Brown"). Used as fallback when imageSource is not provided.

OptionalfontSize

fontSize?: number

Font size for the initials text

OptionalcustomStyle

customStyle?: StyleProp<ViewStyle>

Custom React Native styles for the card container

OptionalimageSource

imageSource?: string

URI or URL of the participant's avatar image

OptionalroundedImage

roundedImage?: boolean

Whether to display image with rounded corners

OptionalimageStyle

imageStyle?: StyleProp<ImageStyle>

Custom React Native styles for the image element

Status Icons:

OptionalshowVideoIcon

showVideoIcon?: boolean

Whether to display video status icon overlay

OptionalshowAudioIcon

showAudioIcon?: boolean

Whether to display audio status icon overlay

Styling Properties:

Optionalname

name?: string

Full name of the participant (may be used for accessibility or tooltips)

Image Properties:

OptionalcustomMiniCard

customMiniCard?: CustomMiniCardType

Custom render function for complete card replacement. When provided, this function receives all MiniCardOptions and returns custom JSX.Element. This allows full control over the mini card's appearance and behavior.

Advanced Render Overrides:

Optionalparameters

parameters?: any

Additional parameters that can be passed to custom components

Optionalstyle

style?: object

Additional style object for the container

Custom UI Override:

OptionalrenderContent

renderContent?: ((options: {
    defaultContent: ReactNode;
    dimensions: {
        width: number;
        height: number;
    };
}) => ReactNode)

Function to wrap or replace the default card content while preserving container

OptionalrenderContainer

renderContainer?: ((options: {
    defaultContainer: ReactNode;
    dimensions: {
        width: number;
        height: number;
    };
}) => ReactNode)

Function to wrap or replace the entire card container

Additional Parameters:

Settings

Member Visibility

On This Page

Properties