Interface PollModalOptions

Configuration options for the PollModal component.

PollModalOptions

Modal Control:

interface PollModalOptions {
    isPollModalVisible: boolean;
    onClose: (() => void);
    position?:
        | "center"
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    backgroundColor?: string;
    member: string;
    islevel: string;
    polls: Poll[];
    poll: Poll;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    roomName: string;
    showAlert?: ShowAlert;
    updateIsPollModalVisible: ((isVisible: boolean) => void);
    handleCreatePoll: HandleCreatePollType;
    handleEndPoll: HandleEndPollType;
    handleVotePoll: HandleVotePollType;
    style?: object;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

isPollModalVisible onClose position? backgroundColor? member islevel polls poll socket roomName showAlert? updateIsPollModalVisible handleCreatePoll handleEndPoll handleVotePoll style? renderContent? renderContainer?

Properties

isPollModalVisible

isPollModalVisible: boolean

Controls modal visibility

onClose

onClose: (() => void)

Callback when modal is closed

Optionalposition

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

Modal position on screen

OptionalbackgroundColor

backgroundColor?: string

Modal background color

member

member: string

Current user's name/ID

islevel

islevel: string

User level ('0'=participant, '1'=co-host, '2'=host) - determines if create/end poll buttons are shown

Session Context:

polls

polls: Poll[]

Array of all polls in the room

poll

poll: Poll

Currently active/selected poll

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io instance for real-time poll synchronization

roomName

roomName: string

Room identifier for poll events

OptionalshowAlert

showAlert?: ShowAlert

Alert display function for user feedback

Customization:

updateIsPollModalVisible

updateIsPollModalVisible: ((isVisible: boolean) => void)

Updates modal visibility state

Poll Management:

handleCreatePoll

handleCreatePoll: HandleCreatePollType

Handler for creating new polls (host/co-host only)

handleEndPoll

handleEndPoll: HandleEndPollType

Handler for ending active polls (host/co-host only)

handleVotePoll

handleVotePoll: HandleVotePollType

Handler for voting in polls

User Context:

Optionalstyle

style?: object

Additional custom styles for modal container

Advanced Render Overrides:

OptionalrenderContent

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

Custom render function for modal content

OptionalrenderContainer

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

Custom render function for modal container

Settings

Member Visibility

On This Page

Properties