Trevixal API
    Preparing search index...

    Module @trevixal/extension-image

    @trevixal/extension-image

    CI npm types license

    Documentation · Live editor · Changelog · Issues

    The Trevixal editor

    • Pluggable storage: a fetch endpoint, a data URL, or your own backend
    • Drag-and-drop and paste upload, with resize, alignment and captions
    • 9.8 kB minified and gzipped, with TypeScript types in the package

    Images for the Trevixal editor: drag-and-drop, paste and file-picker uploads to whatever storage you use, with progress, cancellation, alignment and resizing.

    npm install @trevixal/extension-image
    
    import { Schema, createEditor, defaultNodes, defaultMarks } from '@trevixal/core'
    import { image, imageNodes, createFetchStorage } from '@trevixal/extension-image'

    const schema = new Schema({
    nodes: { ...defaultNodes(), ...imageNodes() },
    marks: defaultMarks(),
    })

    const editor = createEditor({ schema, element })

    const images = image(editor, {
    storage: createFetchStorage({ endpoint: '/api/uploads' }),
    maxBytes: 5 * 1024 * 1024,
    accept: ['image/png', 'image/jpeg', 'image/webp'],
    onUpload: (status) => showProgress(status),
    onError: (message) => toast(message),
    })

    images.pickFiles() // open the OS file dialog

    Dropping a file on the editor or pasting a screenshot runs the same pipeline automatically.

    The editor holds an ImageStorage and calls upload; the bundled adapters are ordinary implementations of that interface, not special cases.

    Adapter Use it when
    createFetchStorage({ endpoint }) You have your own upload API (multipart POST). Credentials stay on the server.
    createS3PresignedStorage({ sign }) Your server signs, the browser PUTs straight to S3/R2/GCS/Azure.
    createDataURLStorage() Self-contained documents with no server at all.
    createObjectURLStorage() Demos and drafts; nothing survives a reload.
    createFallbackStorage([a, b]) Try the CDN, fall back when it is unreachable.

    Anything else is a two-method object:

    const myStorage: ImageStorage = {
    async upload(file, { onProgress, signal }) {
    const url = await myClient.put(file, { onProgress, signal })
    return { url, key: file.name }
    },
    async delete({ key }) {
    if (key) await myClient.remove(key)
    },
    }

    Set deleteOnRemove: true to call delete when an image leaves the document.

    An upload inserts a placeholder node carrying an uploadId, and the controller finds it again by that id, never by position, so it survives edits made while the bytes are in flight. A failed or cancelled upload removes its placeholder, leaving the document exactly as it was.

    insertImage, updateImage, setImageAlign, resizeImage, deleteImage, plus validateFile if you want to check a file before handing it over.

    Apache-2.0

    ImageController
    UploadError
    CaptureOptions
    CompressOptions
    DrawingData
    DrawingShape
    FetchStorageOptions
    ImageCrop
    ImageHit
    ImageOptions
    ImageResizeHandles
    ImageResizeHandlesOptions
    ImageStorage
    ImageToolbar
    ImageToolbarOptions
    ImageTransform
    MarkupShape
    PresignedUpload
    S3PresignedStorageOptions
    TransformImageOptions
    UploadConstraints
    UploadContext
    UploadResult
    UploadStatus
    DrawingTool
    ImageAlign
    ImageTransformer
    MarkupTool
    DEFAULT_ACCEPT
    DEFAULT_COMPRESS_OPTIONS
    deleteImage
    DRAWING_COLORS
    DRAWING_SIZE
    unwrapGallery
    activeImage
    capturePhoto
    captureScreen
    compressImage
    createDataURLStorage
    createFallbackStorage
    createFetchStorage
    createImageResizeHandles
    createImageToolbar
    createObjectURLStorage
    createS3PresignedStorage
    drawingAt
    drawingFile
    drawingNodes
    drawingSVG
    drawMarkup
    enableDrawingEditing
    enableLightbox
    findImage
    galleryAt
    galleryColumns
    galleryOf
    image
    imageCaptionText
    imageNodes
    insertDrawing
    insertImage
    isSVGFile
    makeGallery
    needsAltText
    openDrawingEditor
    openImageMarkup
    parseDrawing
    promptForAltText
    removeImage
    renderMarkup
    resizeImage
    sanitizeSVG
    sanitizeSVGFile
    selectImage
    setGalleryColumns
    setImageAlign
    setImageAlt
    setImageCaption
    setImageDecorative
    setImageWidth
    toggleImageCaption
    transformImage
    updateDrawing
    updateImage
    validateFile