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

    Interface UseLaserPointerOptions

    Options for the useLaserPointer hook

    interface UseLaserPointerOptions {
        broadcastUpdate: (
            payload: {
                color?: string;
                event: string;
                isEndBatch?: boolean;
                position?: Position;
                positions?: TimestampedPosition[];
            },
        ) => void;
        colors?: Partial<WhiteboardColors>;
        isActive: boolean;
        readOnly?: boolean;
        styles?: Partial<WhiteboardStyles>;
        userId: string;
    }
    Index

    Properties

    broadcastUpdate: (
        payload: {
            color?: string;
            event: string;
            isEndBatch?: boolean;
            position?: Position;
            positions?: TimestampedPosition[];
        },
    ) => void

    Broadcast function from sync hook

    colors?: Partial<WhiteboardColors>

    Custom colors

    isActive: boolean

    Whether laser pointer is the active tool

    readOnly?: boolean

    Whether in read-only mode

    styles?: Partial<WhiteboardStyles>

    Custom styles

    userId: string

    User ID