Interface ConfigureWhiteboardModalOptions

interface ConfigureWhiteboardModalOptions {
    isVisible: boolean;
    onConfigureWhiteboardClose: (() => void);
    parameters: ConfigureWhiteboardModalParameters;
    backgroundColor?: string;
    position?: string;
    title?: ReactNode;
    overlayProps?: HTMLAttributes<HTMLDivElement>;
    contentProps?: HTMLAttributes<HTMLDivElement>;
    headerProps?: HTMLAttributes<HTMLDivElement>;
    titleProps?: HTMLAttributes<HTMLHeadingElement>;
    closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    closeIconComponent?: ReactNode;
    headerDividerProps?: HTMLAttributes<HTMLHRElement>;
    bodyProps?: HTMLAttributes<HTMLDivElement>;
    listsWrapperProps?: HTMLAttributes<HTMLDivElement>;
    assignedSectionProps?: HTMLAttributes<HTMLDivElement>;
    pendingSectionProps?: HTMLAttributes<HTMLDivElement>;
    assignedTitleProps?: HTMLAttributes<HTMLHeadingElement>;
    pendingTitleProps?: HTMLAttributes<HTMLHeadingElement>;
    assignedListProps?: HTMLAttributes<HTMLUListElement>;
    pendingListProps?: HTMLAttributes<HTMLUListElement>;
    assignedItemProps?: LiHTMLAttributes<HTMLLIElement>;
    pendingItemProps?: LiHTMLAttributes<HTMLLIElement>;
    assignedActionButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    pendingActionButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    footerProps?: HTMLAttributes<HTMLDivElement>;
    saveButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    actionsWrapperProps?: HTMLAttributes<HTMLDivElement>;
    startButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    updateButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    stopButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    sectionDividerProps?: HTMLAttributes<HTMLHRElement>;
    assignedTitle?: ReactNode;
    pendingTitle?: ReactNode;
    saveButtonLabel?: ReactNode;
    startButtonLabel?: ReactNode;
    updateButtonLabel?: ReactNode;
    stopButtonLabel?: ReactNode;
    addIcon?: ReactNode;
    removeIcon?: ReactNode;
    saveIcon?: ReactNode;
    startIcon?: ReactNode;
    updateIcon?: ReactNode;
    stopIcon?: ReactNode;
    emptyAssignedState?: ReactNode | ((context: {
        participants: Participant[];
    }) => ReactNode);
    emptyPendingState?: ReactNode | ((context: {
        participants: Participant[];
    }) => ReactNode);
    renderTitle?: ((options: {
        defaultTitle: ReactNode;
    }) => ReactNode);
    renderHeader?: ((options: {
        defaultHeader: ReactNode;
    }) => ReactNode);
    renderLists?: ((options: {
        defaultLists: ReactNode;
        assignedParticipants: Participant[];
        pendingParticipants: Participant[];
    }) => ReactNode);
    renderAssignedList?: ((options: {
        defaultAssignedList: ReactNode;
        participants: Participant[];
        removeParticipant: ((participant: Participant) => void);
    }) => ReactNode);
    renderPendingList?: ((options: {
        defaultPendingList: ReactNode;
        participants: Participant[];
        addParticipant: ((participant: Participant) => void);
    }) => ReactNode);
    renderAssignedItem?: ((options: {
        defaultItem: ReactNode;
        participant: Participant;
        remove: (() => void);
        index: number;
    }) => ReactNode);
    renderPendingItem?: ((options: {
        defaultItem: ReactNode;
        participant: Participant;
        add: (() => void);
        index: number;
    }) => ReactNode);
    renderFooter?: ((options: {
        defaultFooter: ReactNode;
        isEditing: boolean;
        canStartWhiteboard: boolean;
    }) => ReactNode);
    renderActions?: ((options: {
        defaultActions: ReactNode;
        isEditing: boolean;
        canStartWhiteboard: boolean;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
    }) => ReactNode);
    renderBody?: ((options: {
        defaultBody: ReactNode;
        isEditing: boolean;
        assignedParticipants: Participant[];
        pendingParticipants: Participant[];
    }) => ReactNode);
    renderContent?: ((options: {
        defaultContent: ReactNode;
        isEditing: boolean;
        canStartWhiteboard: boolean;
    }) => ReactNode);
}

Properties

isVisible onConfigureWhiteboardClose parameters backgroundColor? position? title? overlayProps? contentProps? headerProps? titleProps? closeButtonProps? closeIconComponent? headerDividerProps? bodyProps? listsWrapperProps? assignedSectionProps? pendingSectionProps? assignedTitleProps? pendingTitleProps? assignedListProps? pendingListProps? assignedItemProps? pendingItemProps? assignedActionButtonProps? pendingActionButtonProps? footerProps? saveButtonProps? actionsWrapperProps? startButtonProps? updateButtonProps? stopButtonProps? sectionDividerProps? assignedTitle? pendingTitle? saveButtonLabel? startButtonLabel? updateButtonLabel? stopButtonLabel? addIcon? removeIcon? saveIcon? startIcon? updateIcon? stopIcon? emptyAssignedState? emptyPendingState? renderTitle? renderHeader? renderLists? renderAssignedList? renderPendingList? renderAssignedItem? renderPendingItem? renderFooter? renderActions? renderBody? renderContent?

Properties

isVisible

isVisible: boolean

onConfigureWhiteboardClose

onConfigureWhiteboardClose: (() => void)

parameters

parameters: ConfigureWhiteboardModalParameters

OptionalbackgroundColor

backgroundColor?: string

Optionalposition

position?: string

Optionaltitle

title?: ReactNode

OptionaloverlayProps

overlayProps?: HTMLAttributes<HTMLDivElement>

OptionalcontentProps

contentProps?: HTMLAttributes<HTMLDivElement>

OptionalheaderProps

headerProps?: HTMLAttributes<HTMLDivElement>

OptionaltitleProps

titleProps?: HTMLAttributes<HTMLHeadingElement>

OptionalcloseButtonProps

closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalcloseIconComponent

closeIconComponent?: ReactNode

OptionalheaderDividerProps

headerDividerProps?: HTMLAttributes<HTMLHRElement>

OptionalbodyProps

bodyProps?: HTMLAttributes<HTMLDivElement>

OptionallistsWrapperProps

listsWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalassignedSectionProps

assignedSectionProps?: HTMLAttributes<HTMLDivElement>

OptionalpendingSectionProps

pendingSectionProps?: HTMLAttributes<HTMLDivElement>

OptionalassignedTitleProps

assignedTitleProps?: HTMLAttributes<HTMLHeadingElement>

OptionalpendingTitleProps

pendingTitleProps?: HTMLAttributes<HTMLHeadingElement>

OptionalassignedListProps

assignedListProps?: HTMLAttributes<HTMLUListElement>

OptionalpendingListProps

pendingListProps?: HTMLAttributes<HTMLUListElement>

OptionalassignedItemProps

assignedItemProps?: LiHTMLAttributes<HTMLLIElement>

OptionalpendingItemProps

pendingItemProps?: LiHTMLAttributes<HTMLLIElement>

OptionalassignedActionButtonProps

assignedActionButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalpendingActionButtonProps

pendingActionButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalfooterProps

footerProps?: HTMLAttributes<HTMLDivElement>

OptionalsaveButtonProps

saveButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalactionsWrapperProps

actionsWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalstartButtonProps

startButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalupdateButtonProps

updateButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalstopButtonProps

stopButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalsectionDividerProps

sectionDividerProps?: HTMLAttributes<HTMLHRElement>

OptionalassignedTitle

assignedTitle?: ReactNode

OptionalpendingTitle

pendingTitle?: ReactNode

OptionalsaveButtonLabel

saveButtonLabel?: ReactNode

OptionalstartButtonLabel

startButtonLabel?: ReactNode

OptionalupdateButtonLabel

updateButtonLabel?: ReactNode

OptionalstopButtonLabel

stopButtonLabel?: ReactNode

OptionaladdIcon

addIcon?: ReactNode

OptionalremoveIcon

removeIcon?: ReactNode

OptionalsaveIcon

saveIcon?: ReactNode

OptionalstartIcon

startIcon?: ReactNode

OptionalupdateIcon

updateIcon?: ReactNode

OptionalstopIcon

stopIcon?: ReactNode

OptionalemptyAssignedState

emptyAssignedState?: ReactNode | ((context: {
    participants: Participant[];
}) => ReactNode)

OptionalemptyPendingState

emptyPendingState?: ReactNode | ((context: {
    participants: Participant[];
}) => ReactNode)

OptionalrenderTitle

renderTitle?: ((options: {
    defaultTitle: ReactNode;
}) => ReactNode)

OptionalrenderHeader

renderHeader?: ((options: {
    defaultHeader: ReactNode;
}) => ReactNode)

OptionalrenderLists

renderLists?: ((options: {
    defaultLists: ReactNode;
    assignedParticipants: Participant[];
    pendingParticipants: Participant[];
}) => ReactNode)

OptionalrenderAssignedList

renderAssignedList?: ((options: {
    defaultAssignedList: ReactNode;
    participants: Participant[];
    removeParticipant: ((participant: Participant) => void);
}) => ReactNode)

OptionalrenderPendingList

renderPendingList?: ((options: {
    defaultPendingList: ReactNode;
    participants: Participant[];
    addParticipant: ((participant: Participant) => void);
}) => ReactNode)

OptionalrenderAssignedItem

renderAssignedItem?: ((options: {
    defaultItem: ReactNode;
    participant: Participant;
    remove: (() => void);
    index: number;
}) => ReactNode)

OptionalrenderPendingItem

renderPendingItem?: ((options: {
    defaultItem: ReactNode;
    participant: Participant;
    add: (() => void);
    index: number;
}) => ReactNode)

OptionalrenderFooter

renderFooter?: ((options: {
    defaultFooter: ReactNode;
    isEditing: boolean;
    canStartWhiteboard: boolean;
}) => ReactNode)

OptionalrenderActions

renderActions?: ((options: {
    defaultActions: ReactNode;
    isEditing: boolean;
    canStartWhiteboard: boolean;
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
}) => ReactNode)

OptionalrenderBody

renderBody?: ((options: {
    defaultBody: ReactNode;
    isEditing: boolean;
    assignedParticipants: Participant[];
    pendingParticipants: Participant[];
}) => ReactNode)

OptionalrenderContent

renderContent?: ((options: {
    defaultContent: ReactNode;
    isEditing: boolean;
    canStartWhiteboard: boolean;
}) => ReactNode)

Settings

Member Visibility

On This Page

Properties
isVisibleonConfigureWhiteboardCloseparametersbackgroundColorpositiontitleoverlayPropscontentPropsheaderPropstitlePropscloseButtonPropscloseIconComponentheaderDividerPropsbodyPropslistsWrapperPropsassignedSectionPropspendingSectionPropsassignedTitlePropspendingTitlePropsassignedListPropspendingListPropsassignedItemPropspendingItemPropsassignedActionButtonPropspendingActionButtonPropsfooterPropssaveButtonPropsactionsWrapperPropsstartButtonPropsupdateButtonPropsstopButtonPropssectionDividerPropsassignedTitlependingTitlesaveButtonLabelstartButtonLabelupdateButtonLabelstopButtonLabeladdIconremoveIconsaveIconstartIconupdateIconstopIconemptyAssignedStateemptyPendingStaterenderTitlerenderHeaderrenderListsrenderAssignedListrenderPendingListrenderAssignedItemrenderPendingItemrenderFooterrenderActionsrenderBodyrenderContent