IFileBrowserOptions

types.IFileBrowserOptions

Hierarchy

zIndex

Optional zIndex: number

Overrides

IViewOptions.zIndex

Defined in

src/types/file-browser.d.ts#90


fullsize

Optional fullsize: boolean

Overrides

IViewOptions.fullsize

Defined in

src/types/file-browser.d.ts#91


showTooltip

Optional showTooltip: boolean

Overrides

IViewOptions.showTooltip

Defined in

src/types/file-browser.d.ts#92


useNativeTooltip

Optional useNativeTooltip: boolean

Overrides

IViewOptions.useNativeTooltip

Defined in

src/types/file-browser.d.ts#93


filter

filter: (item: any, search: any) => boolean

Type declaration

(item, search): boolean

Parameters
Name Type
item any
search any
Returns

boolean

Defined in

src/types/file-browser.d.ts#94


sortBy

sortBy: string

Defined in

src/types/file-browser.d.ts#96


sort

sort: false | (a: any, b: any, sortBy?: string) => number

Defined in

src/types/file-browser.d.ts#98


preview

preview: boolean

Defined in

src/types/file-browser.d.ts#100


showPreviewNavigation

showPreviewNavigation: boolean

Defined in

src/types/file-browser.d.ts#101


showSelectButtonInPreview

showSelectButtonInPreview: boolean

Defined in

src/types/file-browser.d.ts#102


saveStateInStorage

saveStateInStorage: false | { storeLastOpenedFolder?: boolean ; storeView?: boolean ; storeSortBy?: boolean }

Defined in

src/types/file-browser.d.ts#104


contextMenu

contextMenu: boolean

Defined in

src/types/file-browser.d.ts#112


howLongShowMsg

howLongShowMsg: number

Defined in

src/types/file-browser.d.ts#114


pixelOffsetLoadNewChunk

pixelOffsetLoadNewChunk: number

Defined in

src/types/file-browser.d.ts#115


editImage

editImage: boolean

Deprecated

Instead use permissionsPresets.allowImageCrop and permissionsPresets.allowImageResize

Defined in

src/types/file-browser.d.ts#118


createNewFolder

createNewFolder: boolean

Deprecated

Instead use permissionsPresets.allowFolderCreate

Defined in

src/types/file-browser.d.ts#120


deleteFolder

deleteFolder: boolean

Deprecated

Instead use permissionsPresets.allowFolderRemove

Defined in

src/types/file-browser.d.ts#122


renameFolder

renameFolder: boolean

Deprecated

Instead use permissionsPresets.allowFolderRename

Defined in

src/types/file-browser.d.ts#124


moveFolder

moveFolder: boolean

Deprecated

Instead use permissionsPresets.allowFolderMove

Defined in

src/types/file-browser.d.ts#126


moveFile

moveFile: boolean

Deprecated

Instead use permissionsPresets.allowFileMove

Defined in

src/types/file-browser.d.ts#128


permissionsPresets

permissionsPresets: Partial<IPermissions>

Defined in

src/types/file-browser.d.ts#130


showFoldersPanel

showFoldersPanel: boolean

Defined in

src/types/file-browser.d.ts#132


width

width: number

Defined in

src/types/file-browser.d.ts#134


height

height: number

Defined in

src/types/file-browser.d.ts#135


view

view: null | string

Defined in

src/types/file-browser.d.ts#137


isSuccess

isSuccess: (resp: IFileBrowserAnswer) => boolean

Type declaration

(resp): boolean

Parameters
Name Type
resp IFileBrowserAnswer
Returns

boolean

Defined in

src/types/file-browser.d.ts#139


getMessage

getMessage: (resp: IFileBrowserAnswer) => string

Type declaration

(resp): string

Parameters
Name Type
resp IFileBrowserAnswer
Returns

string

Defined in

src/types/file-browser.d.ts#140


showFileName

showFileName: boolean

Defined in

src/types/file-browser.d.ts#141


showFileSize

showFileSize: boolean

Defined in

src/types/file-browser.d.ts#142


showFileChangeTime

showFileChangeTime: boolean

Defined in

src/types/file-browser.d.ts#143


getThumbTemplate

getThumbTemplate: (item: IFileBrowserItem, source: ISource, source_name: string) => string

Type declaration

(item, source, source_name): string

Parameters
Name Type
item IFileBrowserItem
source ISource
source_name string
Returns

string

Defined in

src/types/file-browser.d.ts#145


ajax

ajax: IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#151


create

create: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#152


getLocalFileByUrl

getLocalFileByUrl: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#153


resize

resize: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#155


crop

crop: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#156


fileMove

fileMove: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#158


folderMove

folderMove: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#159


fileRemove

fileRemove: null | IFileBrowserAjaxOptions

AJAX options for delete file

Example

Jodit.make('#editor', {
  filebrowser: {
    fileRemove: {
      url: 'https://xdsoft.net/jodit/connector/index.php?action=fileDelete',
      method: 'POST',
    }
  }
});
Defined in

src/types/file-browser.d.ts#175


folderRemove

folderRemove: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#177


fileRename

fileRename: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#179


folderRename

folderRename: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#180


items

items: IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#182


folder

folder: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#183


permissions

permissions: null | IFileBrowserAjaxOptions

Defined in

src/types/file-browser.d.ts#185


uploader

Optional uploader: IUploaderOptions<IUploader>

Defined in

src/types/file-browser.d.ts#187


debugLanguage

Optional debugLanguage: boolean

Inherited from

IViewOptions.debugLanguage

Defined in

src/types/view.d.ts#37


i18n

Optional i18n: false | IDictionary<IDictionary<string>>

Inherited from

IViewOptions.i18n

Defined in

src/types/view.d.ts#38


toolbar

Optional toolbar: string | boolean | HTMLElement

Inherited from

IViewOptions.toolbar

Defined in

src/types/view.d.ts#42


toolbarButtonSize

Optional Readonly toolbarButtonSize: "small" | "tiny" | "xsmall" | "middle" | "large"

Inherited from

IViewOptions.toolbarButtonSize

Defined in

src/types/view.d.ts#44


textIcons

Optional Readonly textIcons: boolean | (key: string) => boolean

Inherited from

IViewOptions.textIcons

Defined in

src/types/view.d.ts#45


extraButtons

Optional Readonly extraButtons: Buttons

Inherited from

IViewOptions.extraButtons

Defined in

src/types/view.d.ts#47


removeButtons

Optional Readonly removeButtons: string[]

Inherited from

IViewOptions.removeButtons

Defined in

src/types/view.d.ts#48


extraIcons

Optional Readonly extraIcons: IDictionary<string>

Inherited from

IViewOptions.extraIcons

Defined in

src/types/view.d.ts#49


buttons

Optional Readonly buttons: ButtonsOption

Inherited from

IViewOptions.buttons

Defined in

src/types/view.d.ts#51


showTooltipDelay

Optional Readonly showTooltipDelay: number

Inherited from

IViewOptions.showTooltipDelay

Defined in

src/types/view.d.ts#54


direction

Optional Readonly direction: string

Inherited from

IViewOptions.direction

Defined in

src/types/view.d.ts#57


cache

Optional cache: boolean

Use cache for heavy methods

Inherited from

IViewOptions.cache

Defined in

src/types/view.d.ts#66


getIcon

Optional getIcon: (name: string, clearName: string) => CanUndef<string>

Type declaration

(name, clearName): CanUndef<string>

Parameters
Name Type
name string
clearName string
Returns

CanUndef<string>

Inherited from

IViewOptions.getIcon

Defined in

src/types/view.d.ts#68


headerButtons

Optional headerButtons: string | (string | ButtonsGroup | IControlType<IViewBased<IViewOptions> | IJodit | IFileBrowser<IFileBrowserOptions>, IToolbarButton>)[]

Inherited from

IViewOptions.headerButtons

Defined in

src/types/view.d.ts#70


basePath

Optional basePath: string

Inherited from

IViewOptions.basePath

Defined in

src/types/view.d.ts#71


theme

Optional theme: string

Inherited from

IViewOptions.theme

Defined in

src/types/view.d.ts#72


defaultTimeout

Optional defaultTimeout: number

Inherited from

IViewOptions.defaultTimeout

Defined in

src/types/view.d.ts#74


disabled

Optional disabled: boolean

Inherited from

IViewOptions.disabled

Defined in

src/types/view.d.ts#76


readonly

Optional readonly: boolean

Inherited from

IViewOptions.readonly

Defined in

src/types/view.d.ts#77


iframe

Optional iframe: boolean

Inherited from

IViewOptions.iframe

Defined in

src/types/view.d.ts#78


namespace

Optional namespace: string

Inherited from

IViewOptions.namespace

Defined in

src/types/view.d.ts#80


activeButtonsInReadOnly

Optional activeButtonsInReadOnly: string[]

Inherited from

IViewOptions.activeButtonsInReadOnly

Defined in

src/types/view.d.ts#82


allowTabNavigation

Optional allowTabNavigation: boolean

Inherited from

IViewOptions.allowTabNavigation

Defined in

src/types/view.d.ts#84


globalFullSize

Optional globalFullSize: boolean

Inherited from

IViewOptions.globalFullSize

Defined in

src/types/view.d.ts#88


controls

Optional controls: Controls<IViewBased<IViewOptions> | IJodit>

Inherited from

IViewOptions.controls

Defined in

src/types/view.d.ts#90


createAttributes

Optional createAttributes: IDictionary<Attributes | NodeFunction>

Inherited from

IViewOptions.createAttributes

Defined in

src/types/view.d.ts#92


events

Optional events: IDictionary<(...args: any[]) => any>

Inherited from

IViewOptions.events

Defined in

src/types/view.d.ts#94


shadowRoot

Optional shadowRoot: Nullable<ShadowRoot>

Inherited from

IViewOptions.shadowRoot

Defined in

src/types/view.d.ts#96


ownerWindow

Optional ownerWindow: Window

Inherited from

IViewOptions.ownerWindow

Defined in

src/types/view.d.ts#98


language

Optional language: string

Inherited from

IViewOptions.language

Defined in

jodit/src/types/view.d.ts:100

defaultCallback

defaultCallback(data): void

Parameters

Name Type
data IFileBrowserCallBackData

Returns

void

Defined in

jodit/src/types/file-browser.d.ts:189