Get started

Collaborate live props

The generated props of every element on Collaborate live. The guide is where they are explained; this is the whole surface.

PresenceRoster

resource

CollabResource

required

The editor resource whose session's collaborators the roster shows.

strings

PresenceRosterStrings

Overrides the words this surface says, for this surface only.

Folded onto whatever the provider resolved, so an override naming one key leaves the rest of the section alone, and carried down to the rows and pickers this surface mounts. Scoped to the sections it renders: a key it never says is a type error rather than a silent no-op.

PeerLockTooltip

children

ReactElement

required

The one inert control the tooltip attaches to: it takes a ref and spreads props.

lockHolderId

string

required

The user id of the peer holding the entity's lock, whose name the tooltip states.

LockedActionsButton

ariaLabel

string

required

The disabled trigger's accessible name.

lockHolderId

string

required

The user id of the peer holding the entity's lock, whose name the tooltip states.