@atlaskit/editor-plugin-placeholder
Version:
Placeholder plugin for @atlaskit/editor-core.
27 lines (26 loc) • 1.28 kB
TypeScript
import type { DocNode } from '@atlaskit/adf-schema';
import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
import type { CompositionPlugin } from '@atlaskit/editor-plugin-composition';
import type { FocusPlugin } from '@atlaskit/editor-plugin-focus';
import type { ShowDiffPlugin } from '@atlaskit/editor-plugin-show-diff';
import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
export interface PlaceholderPluginOptions {
emptyLinePlaceholder?: string;
enableLoadingSpinner?: boolean;
isPlaceholderHidden?: boolean;
isRovoLLMEnabled?: boolean;
placeholder?: string;
placeholderADF?: DocNode;
placeholderBracketHint?: string;
placeholderPrompts?: string[];
withEmptyParagraph?: boolean;
}
export type PlaceholderPlugin = NextEditorPlugin<'placeholder', {
commands: {
setAnimatingPlaceholderPrompts: (placeholderPrompts: string[]) => EditorCommand;
setPlaceholder: (placeholder: string) => EditorCommand;
setPlaceholderHidden: (isPlaceholderHidden: boolean) => EditorCommand;
};
dependencies: [FocusPlugin, CompositionPlugin, TypeAheadPlugin, OptionalPlugin<ShowDiffPlugin>];
pluginConfiguration: PlaceholderPluginOptions | undefined;
}>;