reactjs-tiptap-editor/lib/extensions/Video/Video.d.ts

A modern WYSIWYG rich text editor based on tiptap and shadcn ui for React

import { Node } from '@tiptap/core';
import { GeneralOptions, VideoAlignment } from '../../types';
export * from './components/RichTextVideo';
/**
 * Represents the interface for video options, extending GeneralOptions.
 */
export interface VideoOptions extends GeneralOptions<VideoOptions> {
    /**
     * Indicates whether fullscreen play is allowed
     *
     * @default true
     */
    allowFullscreen: boolean;
    /**
     * Indicates whether to display the frameborder
     *
     * @default false
     */
    frameborder: boolean;
    /**
     * Width of the video, can be a number or string
     *
     * @default VIDEO_SIZE['size-medium']
     */
    width: number | string;
    /** HTML attributes object for passing additional attributes */
    HTMLAttributes: {
        [key: string]: any;
    };
    /** Function for uploading files */
    upload?: (file: File) => Promise<string>;
    /** The source URL of the video */
    resourceVideo: 'upload' | 'link' | 'both';
    /**
     * List of allowed video hosting providers
     * Use ['.'] to allow any URL, or specify providers like ['youtube', 'vimeo']
     *
     * @default ['.']
     */
    videoProviders?: string[];
}
/**
 * Represents the type for setting video options
 */
interface SetVideoOptions {
    /** The source URL of the video */
    src: string;
    /** The width of the video */
    width: string | number;
    align: VideoAlignment;
}
declare module '@tiptap/core' {
    interface Commands<ReturnType> {
        video: {
            /**
             * Add an video
             */
            setVideo: (options: Partial<SetVideoOptions>) => ReturnType;
            /**
             * Update an video
             */
            updateVideo: (options: Partial<SetVideoOptions>) => ReturnType;
        };
    }
}
export declare const Video: Node<VideoOptions, any>;