Editor plugin collab edit

Typescript ❤️

Collab Edit plugin for @atlaskit/editor-core

Install

yarn add @atlaskit/editor-plugin-collab-edit

npm

@atlaskit/editor-plugin-collab-edit

Source

Bitbucket

Bundle

unpkg.com

Changelog

Latest

3.2.1

Patch Changes

Updated dependencies

Internal Editor Use Only

Editor Plugin Collab Edit is intended for internal use by the Editor Platform as a plugin dependency of the Editor within your product.

Direct use of this component is not supported.

Consider using Editor Core instead.

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.

This package includes the collab-edit plugin used by @atlaskit/editor-core.

Usage

The dependencies, configuration, state, actions, and commands of the plugin are defined below:

type CollabEditPlugin = NextEditorPlugin<
  'collabEdit',
  {
    pluginConfiguration: PrivateCollabEditOptions;
    dependencies: [
      OptionalPlugin<FeatureFlagsPlugin>,
      OptionalPlugin<AnalyticsPlugin>,
    ];
    sharedState:
      | {
          activeParticipants: ReadOnlyParticipants | undefined;
          sessionId: string | undefined;
        }
      | undefined;
    actions: {
      getAvatarColor: (str: string) => { index: number; backgroundColor: string, textColor: string };
    };
  }
>;

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.