@atlaskit/editor-plugin-tasks-and-decisions
Version:
Tasks and decisions plugin for @atlaskit/editor-core
38 lines (37 loc) • 2.17 kB
TypeScript
import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
import type { BlockMenuPlugin } from '@atlaskit/editor-plugin-block-menu';
import type { ContextIdentifierPlugin } from '@atlaskit/editor-plugin-context-identifier';
import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
import type { TaskDecisionProvider } from '@atlaskit/task-decision/types';
import type { insertTaskDecisionCommand } from './pm-plugins/insert-commands';
import type { getIndentCommand, getUnindentCommand } from './pm-plugins/keymaps';
import type { TaskAndDecisionsSharedState, TasksAndDecisionsPluginOptions } from './types';
export type TasksAndDecisionsPluginDependencies = [
OptionalPlugin<TypeAheadPlugin>,
OptionalPlugin<AnalyticsPlugin>,
OptionalPlugin<ContextIdentifierPlugin>,
OptionalPlugin<EditorViewModePlugin>,
OptionalPlugin<BlockMenuPlugin>,
OptionalPlugin<SelectionPlugin>,
OptionalPlugin<ToolbarPlugin>
];
export type TasksAndDecisionsPlugin = NextEditorPlugin<'taskDecision', {
actions: {
indentTaskList: ReturnType<typeof getIndentCommand>;
insertTaskDecision: ReturnType<typeof insertTaskDecisionCommand>;
outdentTaskList: ReturnType<typeof getUnindentCommand>;
setProvider: (provider: Promise<TaskDecisionProvider>) => Promise<boolean>;
};
commands: {
toggleTaskList: (targetType?: 'orderedList' | 'bulletList' | 'paragraph') => EditorCommand;
updateEditPermission: (hasEditPermission: boolean | undefined) => EditorCommand;
updateHasRequestedEditPermission: (hasRequestedEditPermission: boolean) => EditorCommand;
};
dependencies: TasksAndDecisionsPluginDependencies;
pluginConfiguration: TasksAndDecisionsPluginOptions | undefined;
sharedState: TaskAndDecisionsSharedState | undefined;
}>;