UNPKG

@atlaskit/editor-plugin-placeholder-text

Version:

placeholder text plugin for @atlaskit/editor-core

30 lines (29 loc) 1.2 kB
import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types'; import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics'; import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead'; import type { showPlaceholderFloatingToolbar } from './editor-actions/actions'; export interface PlaceholderTextPluginOptions { allowInserting?: boolean; } /** * @private * @deprecated Use {@link PlaceholderTextPluginOptions} instead. * @see https://product-fabric.atlassian.net/browse/ED-27496 */ export type PlaceholderTextOptions = PlaceholderTextPluginOptions; export interface PlaceholderTextPluginState { allowInserting: boolean; showInsertPanelAt: number | null; } export type PlaceholderTextPluginDependencies = [ OptionalPlugin<typeof analyticsPlugin>, OptionalPlugin<TypeAheadPlugin> ]; export type PlaceholderTextPlugin = NextEditorPlugin<'placeholderText', { actions: { showPlaceholderFloatingToolbar: typeof showPlaceholderFloatingToolbar; }; dependencies: PlaceholderTextPluginDependencies; pluginConfiguration: PlaceholderTextPluginOptions; sharedState: PlaceholderTextPluginState | undefined; }>;