Editor plugin engagement platform

Typescript ❤️

Engagement platform plugin for @atlaskit/editor-core“

Install

yarn add @atlaskit/editor-plugin-engagement-platform

npm

@atlaskit/editor-plugin-engagement-platform

Source

Bitbucket

Bundle

unpkg.com

Changelog

Latest

3.0.1

Patch Changes

Updated dependencies

Internal Editor Use Only

Editor Plugin Engagement Platform 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 engagement platform plugin used by @atlaskit/editor-core.

Usage

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

type EngagementPlatformPlugin = NextEditorPlugin<
	'engagementPlatform',
	{
		pluginConfiguration: EngagementPlatformPluginOptions;
		dependencies: [];
		sharedState: EngagementPlatformPluginState;
	}
>;

type EngagementPlatformPluginState = {
	epComponents: EpComponents;
	epHooks: EpHooks;
	coordinationClient: CoordinationClient;
} | undefined;

type EngagementPlatformPluginOptions = {
	epComponents: EpComponents;
	epHooks: EpHooks;
	coordinationClient: CoordinationClient;
}

type EpComponents = {
	EngagementProvider: React.ComponentType<PropsWithChildren<{}>>;
	EngagementSpotlight: React.ComponentType<{ engagementId: string }>;
	EngagementInlineDialog: React.ComponentType<PropsWithChildren<{ engagementId: string }>>;
	Coordination: React.ComponentType<PropsWithChildren<{ client: CoordinationClient; messageId: string; fallback: ReactNode }>>;
};

type EpHooks = {
	useCoordination: (client: CoordinationClient, messageId: string) => [boolean, (force?: boolean) => Promise<void>];
};

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.