@atlaskit/editor-plugin-avatar-group
v9.0.3
Published
Avatar Group plugin for @atlaskit/editor-core.
Readme
Editor Plugin Avatar Group
Avatar Group plugin for @atlaskit/editor-core
Note: This component is designed for internal Atlassian development. External contributors will be able to use this component but will not be able to submit issues.
Overview
The Avatar Group plugin displays active collaborators in the editor toolbar. It integrates with the collaboration editing system to show real-time participant avatars and provides an optional "Invite to Edit" button for sharing the document with others.
Key features
- Real-time participant display - Shows avatars of active collaborators in the current editing session
- Toolbar integration - Seamlessly integrates into the primary toolbar through the editor plugin system
- Invite to edit - Provides optional invite-to-edit functionality with customizable components and handlers
- Collaboration state tracking - Monitors collaboration edit plugin state to display active participants
- Analytics integration - Tracks avatar group interactions and visibility events
Install
- Install - yarn add @atlaskit/editor-plugin-avatar-group
- npm - @atlaskit/editor-plugin-avatar-group
- Source - Bitbucket
- Bundle - unpkg.com
Usage
Internal use only
@atlaskit/editor-plugin-avatar-group is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
Direct use of this component is not supported.
Please see Atlaskit - Editor plugin avatar group for documentation and examples for this package.
Support
For internal Atlassian, visit the slack channel #help-editor for support or visit go/editor-help to submit a bug.
License
Please see Atlassian Frontend - License for more licensing information.
