@roomful/cursors
v1.0.14
Published
Prebuilt cursor, presence, and typing UI components for Roomful.
Readme
@roomful/cursors
Prebuilt collaboration UI components for Roomful.
Stable — v1.5. The API is stable and ready for production.
Install
npm install @roomful/cursorsStorybook
- Public Storybook: https://erayates.github.io/roomful/storybook/
- Full component reference: https://github.com/erayates/roomful/blob/main/docs/reference/ui-components.md
Components
| Component | Purpose | Key props |
| -------------------- | ------------------------------------------ | -------------------------------------------------- |
| PeerCursor | Remote cursor marker with label | x, y, color, style, idle, name |
| PresenceBar | Peer chips with avatars and overflow | size, showNames, maxVisible, onUserClick |
| PresenceAvatars | Compact overlapping avatar stack | size, maxVisible, onUserClick |
| TypingIndicator | Inline typing summary with animated dots | peers, ariaLabel |
| LiveIndicator | Pulsing live-activity marker | color, size, ariaLabel |
| CollaborationBadge | Absolute-position badge for active editors | peer, position |
| SelectionHighlight | Remote text selection overlay | peer, selection |
| FloatingReaction | Ephemeral emoji burst animation | emoji, x, y, size, durationMs, delayMs |
Usage
import { PeerCursor, PresenceBar, TypingIndicator } from '@roomful/cursors';Use Storybook for interactive prop exploration and visual regression checks. Use the reference doc for detailed behavior notes and integration examples with @roomful/react.
