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

    Interface WhiteboardToolbarProps

    Whiteboard toolbar component props

    interface WhiteboardToolbarProps {
        addinButtons?: ToolbarButton[];
        canRedo: boolean;
        canUndo: boolean;
        colors?: Partial<WhiteboardColors>;
        currentColor: string;
        currentTool: WhiteboardTool;
        currentWidth: number;
        hasSelection: boolean;
        hasUnsavedChanges?: boolean;
        icons?: Partial<WhiteboardIcons>;
        isSaving?: boolean;
        labels?: Partial<WhiteboardLabels>;
        onAddFilledShape?: (type: "circle" | "rect" | "triangle") => void;
        onAddOutlinedShape?: (type: "circle" | "rect" | "triangle") => void;
        onClear: () => void;
        onClose?: () => void;
        onColorChange: (color: string) => void;
        onDelete: () => void;
        onRedo: () => void;
        onSave?: () => void;
        onToolChange: (tool: WhiteboardTool) => void;
        onUndo: () => void;
        onWidthChange: (width: number) => void;
        readOnly: boolean;
        styles?: Partial<WhiteboardStyles>;
        sx?: SxProps<Theme>;
    }
    Index

    Properties

    addinButtons? canRedo canUndo colors? currentColor currentTool currentWidth hasSelection hasUnsavedChanges? icons? isSaving? labels? onAddFilledShape? onAddOutlinedShape? onClear onClose? onColorChange onDelete onRedo onSave? onToolChange onUndo onWidthChange readOnly styles? sx?

    Properties

    addinButtons?: ToolbarButton[]

    Additional toolbar buttons from add-ins

    canRedo: boolean

    Whether redo is available

    canUndo: boolean

    Whether undo is available

    colors?: Partial<WhiteboardColors>
    currentColor: string

    Current drawing color

    currentTool: WhiteboardTool

    Currently selected tool

    currentWidth: number

    Current stroke width

    hasSelection: boolean

    Whether an object is selected

    hasUnsavedChanges?: boolean

    Whether there are unsaved changes (deprecated — save moved to EditableTitle)

    icons?: Partial<WhiteboardIcons>
    isSaving?: boolean

    Whether saving is in progress (deprecated — save moved to EditableTitle)

    labels?: Partial<WhiteboardLabels>
    onAddFilledShape?: (type: "circle" | "rect" | "triangle") => void

    Called when add filled shape

    onAddOutlinedShape?: (type: "circle" | "rect" | "triangle") => void

    Called when add outlined shape

    onClear: () => void

    Called when clear is triggered

    onClose?: () => void

    Called when close is triggered. If omitted, no close button is rendered.

    onColorChange: (color: string) => void

    Called when color changes

    onDelete: () => void

    Called when delete is triggered

    onRedo: () => void

    Called when redo is triggered

    onSave?: () => void

    Called when save is triggered (deprecated — save moved to EditableTitle)

    onToolChange: (tool: WhiteboardTool) => void

    Called when tool is selected

    onUndo: () => void

    Called when undo is triggered

    onWidthChange: (width: number) => void

    Called when stroke width changes

    readOnly: boolean

    Whether the whiteboard is read-only

    styles?: Partial<WhiteboardStyles>
    sx?: SxProps<Theme>

    Additional MUI sx props

    Settings

    Member Visibility

    On This Page

    Properties