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 full)

Properties

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

Properties

Optionalposition

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

The position of the active user.

Example

const userPosition = activeUser.position;
console.log(userPosition);

Optional Readonlyzoom

zoom?: number

The zoom level of the active user.

Example

const userZoom = activeUser.zoom;
console.log(userZoom);

Readonlyid

id: string

The unique identifier of the user.

Example

const userId = user.id;
console.log(userId);

Optional Readonlyname

name?: string

The name of the user.

Example

const userName = user.name;
console.log(userName);

Optional ReadonlyavatarUrl

avatarUrl?: string

The URL of the user's avatar image.

Example

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

Readonlycolor

color: string

The color associated with the user.

Example

const userColor = user.color;
console.log(userColor);

Optional ReadonlysessionId

sessionId?: string

The session ID of the user.

Example

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

Settings

Member Visibility

On This Page

Properties