@placeholderco/placeholder-ui 1.0.12 → 2.1.0

package/dist/editors/tiptap/TipTap.svelte.d.ts

@@ -0,0 +1,54 @@
+import { type AnyExtension } from '@tiptap/core';
+import { type CodeBlocksOptions } from './extensions/index.js';
+import type { CollaborationConfig } from './collaboration.js';
+/** Result returned from a document upload: the link text and its destination URL */
+export interface DocumentUploadResult {
+    /** Visible link text inserted into the editor */
+    label: string;
+    /** Destination URL the hyperlink points to */
+    url: string;
+}
+export interface TipTapProps {
+    /** HTML content value (bindable). Ignored when collaboration is enabled. */
+    value?: string;
+    /** Label text displayed above the editor */
+    label?: string;
+    /** Mark field as required (shows asterisk) */
+    required?: boolean;
+    /** CSS classes for the FormGroup wrapper */
+    groupClass?: string;
+    /** Tooltip text on hover */
+    tooltipText?: string;
+    /** Position of the tooltip */
+    tooltipLocation?: 'top' | 'bottom' | 'left' | 'right';
+    /** Enable editing mode */
+    editable?: boolean;
+    /** Placeholder text when editor is empty */
+    placeholder?: string;
+    /** Additional CSS classes */
+    class?: string;
+    /** Async handler for image uploads, returns URL or null */
+    onImageUpload?: (file: File) => Promise<string | null>;
+    /** Async handler for document uploads. The app uploads the file and returns the
+     * link label and URL, which are inserted as a hyperlink. Returns null to cancel. */
+    onDocumentUpload?: (file: File) => Promise<DocumentUploadResult | null>;
+    /** Callback when content changes */
+    onUpdate?: (html: string) => void;
+    /** Opt-in real-time collaboration config. When provided, content syncs via Yjs. */
+    collaboration?: CollaborationConfig;
+    /** Opt-in rich code blocks: CodeMirror-powered editing with syntax highlighting,
+     * autocompletion and a per-block language picker. Pass true for all languages
+     * or a config to narrow the offered languages and set the default. */
+    codeBlocks?: boolean | CodeBlocksOptions;
+    /** Additional TipTap extensions to register with the editor */
+    extensions?: AnyExtension[];
+}
+declare const TipTap: import("svelte").Component<TipTapProps, {
+    getHTML: () => string;
+    getJSON: () => object;
+    setContent: (html: string) => void;
+    clear: () => void;
+    focus: () => void;
+}, "value">;
+type TipTap = ReturnType<typeof TipTap>;
+export default TipTap;