Interface MenuModalOptions

Interface defining the options (props) for the MenuModal component.

MenuModal provides access to meeting information, custom actions, and sharing capabilities.

MenuModalOptions

Display Control:

interface MenuModalOptions {
    backgroundColor?: string;
    isVisible: boolean;
    onClose: (() => void);
    customButtons?: CustomButton[];
    shareButtons?: boolean;
    position?:
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    roomName: string;
    adminPasscode: string;
    islevel: string;
    eventType: EventType;
    localLink?: string;
    style?: object;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

backgroundColor? isVisible onClose customButtons? shareButtons? position? roomName adminPasscode islevel eventType localLink? style? renderContent? renderContainer?

Properties

OptionalbackgroundColor

backgroundColor?: string

Background color of the modal content area

isVisible

isVisible: boolean

Whether the modal is currently visible/open

onClose

onClose: (() => void)

Callback function invoked when modal is closed

OptionalcustomButtons

customButtons?: CustomButton[]

Array of custom action buttons to display Each button can have custom icon, text, color, and action handler

OptionalshareButtons

shareButtons?: boolean

Whether to display built-in share buttons

Advanced Render Overrides:

Optionalposition

position?:
    | "topLeft"
    | "topRight"
    | "bottomLeft"
    | "bottomRight"

Screen position where the modal should appear

Styling:

roomName

roomName: string

Name/ID of the current room/meeting

adminPasscode

adminPasscode: string

Admin passcode for the meeting (displayed to authorized users)

islevel

islevel: string

User's level/role (e.g., '0'=participant, '1'=moderator, '2'=host)

eventType

eventType: EventType

Type of event ('conference', 'webinar', 'broadcast', etc.)

OptionallocalLink

localLink?: string

Optional link to the Community Edition server

Custom Content:

Optionalstyle

style?: object

Additional custom styles for the modal container

Meeting Information:

OptionalrenderContent

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

Function to wrap or replace the default modal content

OptionalrenderContainer

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

Function to wrap or replace the entire modal container

Settings

Member Visibility

On This Page

Properties