IFileBrowser | Jodit Editor - v3.24.5

Type Parameters

T extends IFileBrowserOptions = IFileBrowserOptions

Hierarchy

IViewWithToolbar<T>
IDlgs
- IFileBrowser

Implemented by

FileBrowser

Properties

`Readonly` OPTIONS

OPTIONS: T

`Readonly` async

async: IAsync

`Readonly` basePath

basePath: string

`Readonly` buffer

buffer: IStorage<StorageValueType>

`Readonly` c

`Readonly` componentName

componentName: string

`Readonly` componentStatus

componentStatus: ComponentStatus

`Readonly` components

components: Set<IComponent<IViewBased<IViewOptions>>>

container

container: HTMLElement

`Readonly` create

create: ICreate

`Readonly` dataProvider

dataProvider: IFileBrowserDataProvider

`Readonly` defaultTimeout

defaultTimeout: number

`Readonly` e

e: IEventEmitter

`Readonly` events

events: IEventEmitter

`Readonly` files

files: IUIGroup

`Readonly` id

id: string

ID attribute for source element, id add {id}_editor it's editor's id

`Readonly` isDestructed

isDestructed: boolean

`Readonly` isFullSize

isFullSize: boolean

`Readonly` isInDestruct

isInDestruct: boolean

`Readonly` isLocked

isLocked: boolean

isOpened

isOpened: boolean

`Readonly` isReady

isReady: boolean

`Readonly` isView

isView: true

message

message: IMessages

mods

mods: IDictionary<ModType, string>

`Readonly` o

o: T

`Readonly` od

`Readonly` options

options: T

`Readonly` ow

`Readonly` ownerDocument

ownerDocument: Document

`Readonly` ownerWindow

ownerWindow: Window

`Readonly` parent

parent: Nullable<IViewBased<IViewOptions>>

`Readonly` progressbar

progressbar: IProgressBar

registeredButtons

registeredButtons: Set<IPluginButton>

`Readonly` state

state: IFileBrowserState & IObservable

`Readonly` storage

storage: IStorage<StorageValueType>

toolbar

toolbar: IToolbarCollection

toolbarContainer

toolbarContainer: HTMLElement

`Readonly` tree

`Readonly` uid

uid: string

Methods

afterSetMod

afterSetMod(name: string, value: ModType): void
Parameters
- name: string
- value: ModType
Returns void

alert

alert(msg: string | HTMLElement, title?: string | (() => false | void), callback?: string | ((dialog: IDialog) => false | void), className?: string): IDialog
Parameters
- msg: string | HTMLElement
- Optional title: string | (() => false | void)
- Optional callback: string | ((dialog: IDialog) => false | void)
- Optional className: string
Returns IDialog

bindDestruct

bindDestruct(component: IComponent<IViewBased<IViewOptions>>): IFileBrowser<T>
Parameters
- component: IComponent<IViewBased<IViewOptions>>
Returns IFileBrowser<T>

className

className(): string
Returns string

close

close(): void
Returns void

confirm

confirm(msg: string, title: undefined | string | ((yes: boolean) => void), callback?: ((yes: boolean) => false | void)): IDialog
Parameters
- msg: string
- title: undefined | string | ((yes: boolean) => void)
- Optional callback: ((yes: boolean) => false | void)
  - - (yes: boolean): false | void
    - Parameters
      
      yes: boolean
      
      Returns false | void
Returns IDialog

destruct

destruct(jodit?: IViewBased<IViewOptions>): any
Parameters
- Optional jodit: IViewBased<IViewOptions>
Returns any

dlg

dlg(options?: IDialogOptions): IDialog
Parameters
- Optional options: IDialogOptions
Returns IDialog

get

get<T>(chain: string, obj?: IDictionary<any, string>): Nullable<T>
Type Parameters
- T
Parameters
- chain: string
- Optional obj: IDictionary<any, string>
Returns Nullable<T>

getElm

getElm(elementName: string): Nullable<HTMLElement>
Parameters
- elementName: string
Returns Nullable<HTMLElement>

getElms

getElms(elementName: string): HTMLElement[]
Parameters
- elementName: string
Returns HTMLElement[]

getFullElName

getFullElName(elementName: string): string
Parameters
- elementName: string
Returns string
getFullElName(elementName: string, mod: string): string
Parameters
- elementName: string
- mod: string
Returns string
getFullElName(elementName: string, mod?: string, modValue?: string | boolean): string
Parameters
- elementName: string
- Optional mod: string
- Optional modValue: string | boolean
Returns string

getInstance

getInstance<T>(moduleName: string, options?: object): T
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T>
Parameters
- moduleName: string
- Optional options: object
Returns T

getMod

getMod(name: string): ModType
Parameters
- name: string
Returns ModType

getRegisteredButtonGroups

getRegisteredButtonGroups(): IDictionary<string[], string>
Returns IDictionary<string[], string>

getVersion

getVersion(): string
Returns string

hookStatus

hookStatus(status: ComponentStatus, callback: ((component: IFileBrowser<T>) => void)): void
Parameters
- status: ComponentStatus
- callback: ((component: IFileBrowser<T>) => void)
  - - (component: IFileBrowser<T>): void
    - Parameters
      
      component: IFileBrowser<T>
      
      Returns void
Returns void

i18n

i18n(text: string, ...params: (string | number)[]): string
Parameters
- text: string
- Rest ...params: (string | number)[]
Returns string

isLockedNotBy

isLockedNotBy(name: string): boolean
Parameters
- name: string
Returns boolean

lock

lock(name?: string): boolean
Parameters
- Optional name: string
Returns boolean

open

open(callback?: ((data: IFileBrowserCallBackData) => void), onlyImages?: boolean): Promise<void>
Parameters
- Optional callback: ((data: IFileBrowserCallBackData) => void)
  - - (data: IFileBrowserCallBackData): void
    - Parameters
      
      data: IFileBrowserCallBackData
      
      Returns void
- Optional onlyImages: boolean
Returns Promise<void>

prompt

prompt(msg: string, title: undefined | string | (() => false | void), callback: ((value: string) => false | void), placeholder?: string, defaultValue?: string): IDialog
Parameters
- msg: string
- title: undefined | string | (() => false | void)
- callback: ((value: string) => false | void)
  - - (value: string): false | void
    - Parameters
      
      value: string
      
      Returns false | void
- Optional placeholder: string
- Optional defaultValue: string
Returns IDialog

registerButton

registerButton(btn: IPluginButton): IFileBrowser<T>
Parameters
- btn: IPluginButton
Returns IFileBrowser<T>

setMod

setMod<T>(this: T, name: string, value: ModType): T
Set/remove modification (null - remove)
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IMods
Parameters
- this: T
- name: string
- value: ModType
Returns T

setPanel

setPanel(element: string | HTMLElement): void
Parameters
- element: string | HTMLElement
Returns void

setStatus

setStatus(componentStatus: ComponentStatus): void
Parameters
- componentStatus: ComponentStatus
Returns void

status

status(message: string | Error, success?: boolean): void
Parameters
- message: string | Error
- Optional success: boolean
Returns void

toggleFullSize

toggleFullSize(isFullSize?: boolean): void
Parameters
- Optional isFullSize: boolean
Returns void

unlock

unlock(): boolean
Returns boolean

unregisterButton

unregisterButton(btn: IPluginButton): IFileBrowser<T>
Parameters
- btn: IPluginButton
Returns IFileBrowser<T>

Jodit PRO

If you like Jodit - try Jodit PRO