Skip to content
Roomful
Search
Ctrl
K
Cancel
GitHub
Version
Latest
v1.0
Getting Started
Installation
Quickstart
Rooms and Transports
Reference Guides
API Reference
Core API
Presence Engine
Cursor Engine
State, Awareness, and Events
React Adapter (`@roomful/react`)
Vue Adapter (`@roomful/vue`)
Svelte Adapter (`@roomful/svelte`)
Advanced Features
UI Components (`@roomful/cursors`)
Devtools and Debugging
Performance Guide
Type Reference
API Reference
API Reference
core
@roomful/core
classes
Class: RoomfulError
functions
Function: createCoreHealth()
Function: createRoom()
interfaces
Interface: AwarenessEngine
Interface: AwarenessSelection
Interface: AwarenessState
Interface: CoreHealth
Interface: CursorBasePosition
Interface: CursorEngine\<TCursor\>
Interface: CursorOptions
Interface: CursorRenderOptions
Interface: DebugOptions
Interface: EventEngine\<TPresence\>
Interface: EventOptions
Interface: PresenceEngine\<TPresence\>
Interface: ReconnectOptions
Interface: Room\<TPresence\>
Interface: RoomDiagnostics
Interface: RoomDiagnosticsDebug
Interface: RoomDiagnosticsEncryption
Interface: RoomDiagnosticsEvents
Interface: RoomDiagnosticsNetwork
Interface: RoomDiagnosticsPeers
Interface: RoomDiagnosticsPresence
Interface: RoomDiagnosticsState
Interface: RoomDiagnosticsTransport
Interface: RoomEventMap\<TPresence\>
Interface: RoomfulYjsProvider
Interface: RoomfulYjsProviderEventMap
Interface: RoomOptions\<TPresence\>
Interface: StateChangeMeta
Interface: StateEngine\<T\>
Interface: StateOptions\<T\>
Interface: WebRTCDataChannelOptions
Interface: WebRTCOptions
Interface: WebSocketOptions
type-aliases
Type Alias: CursorData
Type Alias: CursorPosition\<TCursor\>
Type Alias: EncryptionOptions
Type Alias: Peer\<TPresence\>
Type Alias: PresenceData
Type Alias: RelayAuthToken
Type Alias: RoomEventHandler()\<TPresence, TEvent\>
Type Alias: RoomEventName
Type Alias: RoomfulErrorCode
Type Alias: RoomfulYjsProviderEventHandler()\<TEvent\>
Type Alias: RoomfulYjsProviderEventName
Type Alias: RoomfulYjsProviderStatus
Type Alias: RoomStatus
Type Alias: TransportMode
Type Alias: Unsubscribe()
react
@roomful/react
functions
Function: createReactHealth()
Function: RoomfulProvider()
Function: useAwareness()
Function: useConnectionStatus()
Function: useCursors()
Function: useEvent()
Function: usePeers()
Function: usePresence()
Function: useRoom()
Function: useSharedState()
interfaces
Interface: ReactHealth
Interface: RoomfulProviderProps\<TPresence\>
Interface: UseAwarenessResult
Interface: UseCursorsResult\<TCursor\>
Interface: UsePresenceResult\<TPresence\>
vue
@roomful/vue
functions
Function: useAwareness()
Function: useCursors()
Function: useEvent()
Function: usePresence()
Function: useSharedState()
interfaces
Interface: RoomfulPluginOptions\<TPresence\>
Interface: UseAwarenessResult
Interface: UseCursorsResult\<TCursor\>
Interface: UsePresenceResult\<TPresence\>
type-aliases
Type Alias: ReadonlyRef\<T\>
Type Alias: RoomfulCursorsDirective
Type Alias: SharedStateSetter()\<T\>
Type Alias: SharedStateUpdater\<T\>
variables
Variable: RoomfulPlugin
svelte
@roomful/svelte
functions
Function: roomful()
interfaces
Interface: AwarenessStore
Interface: AwarenessStoreValue
Interface: CursorStore\<TCursor\>
Interface: EventChannelStore\<TPayload, TPresence\>
Interface: EventChannelValue\<TPayload, TPresence\>
Interface: EventsNamespace\<TPresence\>
Interface: PresenceStore\<TPresence\>
Interface: PresenceStoreValue\<TPresence\>
Interface: RoomfulAdapter\<TPresence, TCursor\>
Interface: StateNamespace
cursors
@roomful/cursors
functions
Function: CollaborationBadge()
Function: FloatingReaction()
Function: LiveIndicator()
Function: PeerCursor()
Function: PresenceAvatars()
Function: PresenceBar()
Function: SelectionHighlight()
Function: TypingIndicator()
interfaces
Interface: CollaborationBadgePosition
Interface: CollaborationBadgeProps\<TPresence\>
Interface: FloatingReactionProps
Interface: LiveIndicatorProps
Interface: PeerCursorProps
Interface: PresenceBarProps\<TPresence\>
Interface: SelectionHighlightProps\<TPresence\>
Interface: SelectionRange
Interface: TypingIndicatorProps\<TPresence\>
type-aliases
Type Alias: PeerCursorStyle
Type Alias: PresenceAvatarsProps\<TPresence\>
Type Alias: PresenceSize
relay
@roomful/relay
classes
Class: RelayJwtVerificationError
functions
Function: createRelayServer()
Function: verifyJWT()
interfaces
Interface: RelayAuthorizeContext
Interface: RelayJwtPayload
Interface: RelayServer
Interface: RelayServerOptions
type-aliases
Type Alias: RelayAuthHandler()
devtools
@roomful/devtools
functions
Function: diffSerializedState()
Function: isDevtoolsRoomSnapshot()
Function: isDevtoolsRoomSummary()
Function: serializeDevtoolsValue()
interfaces
Interface: DevtoolsBridge
Interface: DevtoolsCommandResult
Interface: DevtoolsDiffOptions
Interface: DevtoolsEventLogEntry
Interface: DevtoolsPeerSnapshot
Interface: DevtoolsRoomSnapshot
Interface: DevtoolsRoomSummary
Interface: DevtoolsSerializationOptions
Interface: DevtoolsSerializedRecord
Interface: DevtoolsStateDiffEntry
Interface: DevtoolsStateSnapshot
type-aliases
Type Alias: DevtoolsDiffKind
Type Alias: DevtoolsEventDirection
Type Alias: DevtoolsRoomStatus
Type Alias: DevtoolsSerializedScalar
Type Alias: DevtoolsSerializedValue
Type Alias: DevtoolsStateReason
Type Alias: DevtoolsStateStrategy
Type Alias: DevtoolsTransportKind
variables
Variable: DEVTOOLS\_BRIDGE\_GLOBAL
Variable: DEVTOOLS\_BRIDGE\_VERSION
Variable: DEVTOOLS\_MAX\_EVENT\_LOG\_ENTRIES
Recipes
Recipe: Collaborative Editor
Recipe: Multiplayer Canvas
Recipe: Live Voting
Recipe: Presence-Aware Navigation
Project
Repository Structure
Development Setup
Code Conventions
Code Quality Guidelines
WebRTC Validation
Release Process
Labeling and Triage
Execution Plan
Documentation Style Guide
Launch Kit
Publish Readiness Roadmap
Release Completion Audit
Playground
Community
Overview
Discussions
Issues
GitHub
Version
Latest
v1.0
Roomful is in
public beta
— install with the
@beta
tag.
Share feedback →
@roomful/react
@roomful/react
@roomful/react
Section titled “@roomful/react”
Interfaces
Section titled “Interfaces”
ReactHealth
RoomfulProviderProps
UseAwarenessResult
UseCursorsResult
UsePresenceResult
Functions
Section titled “Functions”
createReactHealth
RoomfulProvider
useAwareness
useConnectionStatus
useCursors
useEvent
usePeers
usePresence
useRoom
useSharedState
