Penpot plugins API
    Preparing search index...

    Interface ActiveUser

    Represents an active user in Penpot, extending the User interface. This interface includes additional properties specific to active users.

    interface ActiveUser {
        position?: { x: number; y: number };
        zoom?: number;
        id: string;
        name?: string;
        avatarUrl?: string;
        color: string;
        sessionId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    position? zoom? id name? avatarUrl? color sessionId?

    Properties

    position?: { x: number; y: number }

    The position of the active user.

    const userPosition = activeUser.position;
    console.log(userPosition);
    zoom?: number

    The zoom level of the active user.

    const userZoom = activeUser.zoom;
    console.log(userZoom);
    id: string

    The unique identifier of the user.

    const userId = user.id;
    console.log(userId);
    name?: string

    The name of the user.

    const userName = user.name;
    console.log(userName);
    avatarUrl?: string

    The URL of the user's avatar image.

    const avatarUrl = user.avatarUrl;
    console.log(avatarUrl);
    color: string

    The color associated with the user.

    const userColor = user.color;
    console.log(userColor);
    sessionId?: string

    The session ID of the user.

    const sessionId = user.sessionId;
    console.log(sessionId);

    Settings

    Member Visibility

    On This Page

    Properties