Type Parameters

  • T

Hierarchy

  • IUploaderOptions

Properties

buildData? contentType data defaultHandlerError defaultHandlerSuccess error filesVariableName format getMessage headers? imagesExtensions insertImageAsBase64URI isSuccess method pathVariableName prepareData process queryBuild? url withCredentials

Methods

getDisplayName processFileName

Properties

Optional buildData

buildData?: ((this: T, formData: any) => BuildDataResult)

Type declaration

contentType

contentType: ((this: T, requestData: any) => string | false)

Type declaration

    • (this: T, requestData: any): string | false

    • Parameters

      • this: T
      • requestData: any

      Returns string | false

data

data: null | object

defaultHandlerError

defaultHandlerError: HandlerError

defaultHandlerSuccess

defaultHandlerSuccess: HandlerSuccess

error

error: ((this: T, e: Error) => void)

Type declaration

    • (this: T, e: Error): void

    • Parameters

      Returns void

filesVariableName

filesVariableName: ((i: number) => string)

Type declaration

    • (i: number): string

    • Parameters

      • i: number

      Returns string

format

format: string

getMessage

getMessage: ((this: T, resp: IUploaderAnswer) => string)

Type declaration

Optional headers

headers?: null | IDictionary<string, string> | ((this: IAjax<any>) => CanPromise<null | IDictionary<string, string>>)

imagesExtensions

imagesExtensions: string[]

List of extensions for images

Default

['jpg', 'png', 'jpeg', 'gif']

Example

Jodit.make('#editor', {
    uploader: {
        insertImageAsBase64URI: true,
        imagesExtensions: ['jpg', 'png', 'jpeg', 'gif', 'svg', 'webp']
    }
});

insertImageAsBase64URI

insertImageAsBase64URI: boolean

isSuccess

isSuccess: ((this: T, resp: IUploaderAnswer) => boolean)

Type declaration

method

method: string

pathVariableName

pathVariableName: string

prepareData

prepareData: ((this: T, formData: FormData) => any)

Type declaration

    • (this: T, formData: FormData): any

    • Parameters

      Returns any

process

process: ((this: T, resp: IUploaderAnswer) => IUploaderData)

Type declaration

Optional queryBuild

queryBuild?: ((obj: string | FormData | IDictionary<string | object, string>, prefix?: string) => string | FormData)

Type declaration

url

url: string | ((request: string | IDictionary<string, string> | FormData) => string)

withCredentials

withCredentials: boolean

Methods

getDisplayName

  • The method can be used to change the displayed name of the uploaded file

    Jodit.make('#editor', {
        uploader: {
            url: 'https://sitename.net/jodit/connector/index.php?action=fileUpload',
            getDisplayName: (_, name) => 'File:' + name
        }
    });

    Parameters

    • this: T
    • baseurl: string
    • filename: string

    Returns string

processFileName

  • The method can be used to change the name of the uploaded file This is the name the file will have when it is sent to the server

    Jodit.make('#editor', {
     uploader: {
       url: 'some-connector.php',
       processFileName: (key, file, name) => {
         return [key, file, 'some-prefix_' + name];
       }
     }
    });

    Parameters

    • this: T
    • key: string
    • file: File
    • name: string

    Returns [string, File, string]

Jodit PRO

If you like Jodit - try Jodit PRO