Hiyve Components - v1.0.0
    Preparing search index...

    Interface PollsWindowProps

    Props for the PollsWindow component.

    interface PollsWindowProps {
        autoSaveInterval?: number;
        colors?: Partial<PollsWindowColors>;
        disabled?: boolean;
        enableAutoSave?: boolean;
        fileLocation?: string;
        icons?: Partial<PollsWindowIcons>;
        initialFileId?: string;
        initialPolls?: Poll[];
        labels?: Partial<PollsWindowLabels>;
        maxHeight?: string | number;
        onAutoSave?: (fileId: string) => void;
        onAutoSaveError?: (error: Error) => void;
        onPollCreated?: (poll: Poll) => void;
        onPollDeleted?: (pollId: string) => void;
        onPollEnded?: (poll: Poll) => void;
        onPollsChange?: (polls: Poll[]) => void;
        onPollStarted?: (poll: Poll) => void;
        onVoteCast?: (pollId: string, optionIds: string[]) => void;
        ownerOnlyCreate?: boolean;
        readOnly?: boolean;
        renderProps?: PollsWindowRenderProps;
        showHeader?: boolean;
        styles?: Partial<PollsWindowStyles>;
        sx?: SxProps<Theme>;
        title?: string;
    }
    Index

    Properties

    autoSaveInterval? colors? disabled? enableAutoSave? fileLocation? icons? initialFileId? initialPolls? labels? maxHeight? onAutoSave? onAutoSaveError? onPollCreated? onPollDeleted? onPollEnded? onPollsChange? onPollStarted? onVoteCast? ownerOnlyCreate? readOnly? renderProps? showHeader? styles? sx? title?

    Properties

    autoSaveInterval?: number

    Auto-save interval in ms

    colors?: Partial<PollsWindowColors>

    Custom colors

    disabled?: boolean

    Whether the panel is disabled

    enableAutoSave?: boolean

    Enable auto-save

    fileLocation?: string

    File storage location

    icons?: Partial<PollsWindowIcons>

    Custom icons

    initialFileId?: string

    Initial file ID for resuming

    initialPolls?: Poll[]

    Initial polls

    labels?: Partial<PollsWindowLabels>

    Custom labels

    maxHeight?: string | number

    Maximum height before scrolling

    onAutoSave?: (fileId: string) => void

    Callback after auto-save

    onAutoSaveError?: (error: Error) => void

    Callback on auto-save error

    onPollCreated?: (poll: Poll) => void

    Callback when a poll is created

    onPollDeleted?: (pollId: string) => void

    Callback when a poll is deleted

    onPollEnded?: (poll: Poll) => void

    Callback when a poll is ended

    onPollsChange?: (polls: Poll[]) => void

    Callback when polls change

    onPollStarted?: (poll: Poll) => void

    Callback when a poll is started

    onVoteCast?: (pollId: string, optionIds: string[]) => void

    Callback when user votes

    ownerOnlyCreate?: boolean

    Only room owner can create/manage polls

    readOnly?: boolean

    Read-only mode - hides create button, disables voting (for viewing saved sessions)

    renderProps?: PollsWindowRenderProps

    Render props

    showHeader?: boolean

    Show header

    styles?: Partial<PollsWindowStyles>

    Custom styles

    sx?: SxProps<Theme>

    MUI sx prop

    title?: string

    Title for the header

    Settings

    Member Visibility

    On This Page

    Properties