96 lines
3.2 KiB
TypeScript
96 lines
3.2 KiB
TypeScript
import { PluginKey } from '@tiptap/pm/state';
|
|
import { Editor, Extension } from '@tiptap/core';
|
|
import { Node } from '@tiptap/pm/model';
|
|
|
|
/**
|
|
* The viewport positions tracked by the placeholder plugin.
|
|
* `null` means "no viewport info yet" — the decoration callback falls back to
|
|
* a full document scan until the scroll handler fires.
|
|
*/
|
|
interface ViewportState {
|
|
topPos: number | null;
|
|
bottomPos: number | null;
|
|
}
|
|
interface PlaceholderOptions {
|
|
/**
|
|
* **The class name for the empty editor**
|
|
* @default 'is-editor-empty'
|
|
*/
|
|
emptyEditorClass: string;
|
|
/**
|
|
* **The class name for empty nodes**
|
|
*
|
|
* You can use a function to return a dynamic class name or a string.
|
|
* @default 'is-empty'
|
|
*/
|
|
emptyNodeClass: ((EmptyNodeClassProps: {
|
|
editor: Editor;
|
|
node: Node;
|
|
pos: number;
|
|
hasAnchor: boolean;
|
|
}) => string) | string;
|
|
/**
|
|
* **The data-attribute used for the placeholder label**
|
|
* Will be prepended with `data-` and converted to kebab-case and cleaned of special characters.
|
|
* @default 'placeholder'
|
|
*/
|
|
dataAttribute: string;
|
|
/**
|
|
* **The placeholder content**
|
|
*
|
|
* You can use a function to return a dynamic placeholder or a string.
|
|
* @default 'Write something …'
|
|
*/
|
|
placeholder: ((PlaceholderProps: {
|
|
editor: Editor;
|
|
node: Node;
|
|
pos: number;
|
|
hasAnchor: boolean;
|
|
}) => string) | string;
|
|
/**
|
|
* **Checks if the placeholder should be only shown when the editor is editable.**
|
|
*
|
|
* If true, the placeholder will only be shown when the editor is editable.
|
|
* If false, the placeholder will always be shown.
|
|
* @default true
|
|
*/
|
|
showOnlyWhenEditable: boolean;
|
|
/**
|
|
* **Checks if the placeholder should be only shown when the current node is empty.**
|
|
*
|
|
* If true, the placeholder will only be shown when the current node is empty.
|
|
* If false, the placeholder will be shown when any node is empty.
|
|
* @default true
|
|
*/
|
|
showOnlyCurrent: boolean;
|
|
/**
|
|
* **Controls if the placeholder should be shown for all descendants.**
|
|
*
|
|
* If true, the placeholder will be shown for all descendants.
|
|
* If false, the placeholder will only be shown for the current node.
|
|
* @default false
|
|
*/
|
|
includeChildren: boolean;
|
|
}
|
|
|
|
/** The default data attribute label */
|
|
declare const DEFAULT_DATA_ATTRIBUTE = "placeholder";
|
|
/** The plugin key used to store and read the placeholder viewport state */
|
|
declare const PLUGIN_KEY: PluginKey<ViewportState>;
|
|
|
|
/**
|
|
* This extension allows you to add a placeholder to your editor.
|
|
* A placeholder is a text that appears when the editor or a node is empty.
|
|
* @see https://www.tiptap.dev/api/extensions/placeholder
|
|
*/
|
|
declare const Placeholder: Extension<PlaceholderOptions, any>;
|
|
|
|
/**
|
|
* Prepares the placeholder attribute by ensuring it is properly formatted.
|
|
* @param attr - The placeholder attribute string.
|
|
* @returns The prepared placeholder attribute string.
|
|
*/
|
|
declare function preparePlaceholderAttribute(attr: string): string;
|
|
|
|
export { DEFAULT_DATA_ATTRIBUTE, PLUGIN_KEY, Placeholder, type PlaceholderOptions, type ViewportState, preparePlaceholderAttribute };
|