IFileBrowser

Type parameters
Hierarchy
Implemented by

types.IFileBrowser

Type parameters

Name	Type
`T`	extends `IFileBrowserOptions` = `IFileBrowserOptions`

Hierarchy

IViewWithToolbar<T>
IDlgs

↳ IFileBrowser

Implemented by

FileBrowser

dataProvider

Readonly dataProvider: IFileBrowserDataProvider

Defined in

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

state

Readonly state: IFileBrowserState & IObservable

Defined in

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

tree

Readonly tree: IUIGroup

Defined in

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

files

Readonly files: IUIGroup

Defined in

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

isOpened

isOpened: boolean

Defined in

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

mods

mods: IDictionary<ModType>

Inherited from

IViewWithToolbar.mods

Defined in

src/types/traits.d.ts#28

container

container: HTMLElement

Inherited from

IViewWithToolbar.container

Defined in

src/types/types.d.ts#42

async

Readonly async: IAsync

Inherited from

IViewWithToolbar.async

Defined in

src/types/types.d.ts#46

ownerDocument

Readonly ownerDocument: Document

Inherited from

IViewWithToolbar.ownerDocument

Defined in

src/types/types.d.ts#47

od

Readonly od: Document

Inherited from

IViewWithToolbar.od

Defined in

src/types/types.d.ts#48

ownerWindow

Readonly ownerWindow: Window

Inherited from

IViewWithToolbar.ownerWindow

Defined in

src/types/types.d.ts#49

ow

Readonly ow: Window

Inherited from

IViewWithToolbar.ow

Defined in

src/types/types.d.ts#50

componentName

Readonly componentName: string

Inherited from

IViewWithToolbar.componentName

Defined in

src/types/types.d.ts#54

uid

Readonly uid: string

Inherited from

IViewWithToolbar.uid

Defined in

src/types/types.d.ts#65

isDestructed

Readonly isDestructed: boolean

Inherited from

IViewWithToolbar.isDestructed

Defined in

src/types/types.d.ts#66

isInDestruct

Readonly isInDestruct: boolean

Inherited from

IViewWithToolbar.isInDestruct

Defined in

src/types/types.d.ts#67

isReady

Readonly isReady: boolean

Inherited from

IViewWithToolbar.isReady

Defined in

src/types/types.d.ts#68

componentStatus

Readonly componentStatus: ComponentStatus

Inherited from

IViewWithToolbar.componentStatus

Defined in

src/types/types.d.ts#70

isView

Readonly isView: true

Inherited from

IViewWithToolbar.isView

Defined in

src/types/view.d.ts#108

parent

Readonly parent: Nullable<IViewBased<IViewOptions>>

Inherited from

IViewWithToolbar.parent

Defined in

src/types/view.d.ts#109

id

Readonly id: string

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

Inherited from

IViewWithToolbar.id

Defined in

src/types/view.d.ts#114

basePath

Readonly basePath: string

Inherited from

IViewWithToolbar.basePath

Defined in

src/types/view.d.ts#116

isLocked

Readonly isLocked: boolean

Inherited from

IViewWithToolbar.isLocked

Defined in

src/types/view.d.ts#118

isFullSize

Readonly isFullSize: boolean

Inherited from

IViewWithToolbar.isFullSize

Defined in

src/types/view.d.ts#123

buffer

Readonly buffer: IStorage<StorageValueType>

Inherited from

IViewWithToolbar.buffer

Defined in

src/types/view.d.ts#126

storage

Readonly storage: IStorage<StorageValueType>

Inherited from

IViewWithToolbar.storage

Defined in

src/types/view.d.ts#127

progressbar

Readonly progressbar: IProgressBar

Inherited from

IViewWithToolbar.progressbar

Defined in

src/types/view.d.ts#129

events

Readonly events: IEventEmitter

Inherited from

IViewWithToolbar.events

Defined in

src/types/view.d.ts#131

e

Readonly e: IEventEmitter

Inherited from

IViewWithToolbar.e

Defined in

src/types/view.d.ts#132

create

Readonly create: ICreate

Inherited from

IViewWithToolbar.create

Defined in

src/types/view.d.ts#134

c

Readonly c: ICreate

Inherited from

IViewWithToolbar.c

Defined in

src/types/view.d.ts#135

OPTIONS

Readonly OPTIONS: T

Inherited from

IViewWithToolbar.OPTIONS

Defined in

src/types/view.d.ts#137

options

Readonly options: T

Inherited from

IViewWithToolbar.options

Defined in

src/types/view.d.ts#138

o

Readonly o: T

Inherited from

IViewWithToolbar.o

Defined in

src/types/view.d.ts#140

defaultTimeout

Readonly defaultTimeout: number

Inherited from

IViewWithToolbar.defaultTimeout

Defined in

src/types/view.d.ts#144

components

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

Inherited from

IViewWithToolbar.components

Defined in

src/types/view.d.ts#148

message

Readonly message: IMessages

Inherited from

IViewWithToolbar.message

Defined in

src/types/view.d.ts#152

toolbar: IToolbarCollection

Inherited from

IViewWithToolbar.toolbar

Defined in

src/types/view.d.ts#156

toolbarContainer

toolbarContainer: HTMLElement

Inherited from

IViewWithToolbar.toolbarContainer

Defined in

src/types/view.d.ts#157

registeredButtons

registeredButtons: Set<IPluginButton>

Inherited from

IViewWithToolbar.registeredButtons

Defined in

src/types/view.d.ts#159

open

open(callback?, onlyImages?): Promise<void>

Parameters

Name	Type
`callback?`	(`data`: `IFileBrowserCallBackData`) => `void`
`onlyImages?`	`boolean`

Returns

Promise<void>

Defined in

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

close

close(): void

Returns

void

Defined in

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

status

status(message, success?): void

Parameters

Name	Type
`message`	`string` \| `Error`
`success?`	`boolean`

Returns

void

Defined in

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

setMod

setMod<T>(this, name, value): T

Set/remove modification (null - remove)

Type parameters

Name	Type
`T`	extends `IComponent`<`IViewBased`<`IViewOptions`>> & `IContainer` & `IMods`

Parameters

Name	Type
`this`	`T`
`name`	`string`
`value`	`ModType`

Returns

T

Inherited from

IViewWithToolbar.setMod

Defined in

src/types/traits.d.ts#20

afterSetMod

afterSetMod(name, value): void

Parameters

Name	Type
`name`	`string`
`value`	`ModType`

Returns

void

Inherited from

IViewWithToolbar.afterSetMod

Defined in

src/types/traits.d.ts#25

getMod

getMod(name): ModType

Parameters

Name	Type
`name`	`string`

Returns

Inherited from

IViewWithToolbar.getMod

Defined in

src/types/traits.d.ts#27

getElm

getElm(elementName): Nullable<HTMLElement>

Parameters

Name	Type
`elementName`	`string`

Returns

Nullable<HTMLElement>

Inherited from

IViewWithToolbar.getElm

Defined in

src/types/traits.d.ts#32

getElms

getElms(elementName): HTMLElement[]

Parameters

Name	Type
`elementName`	`string`

Returns

HTMLElement[]

Inherited from

IViewWithToolbar.getElms

Defined in

src/types/traits.d.ts#33

dlg

dlg(options?): IDialog

Parameters

Name	Type
`options?`	`IDialogOptions`

Returns

Inherited from

Defined in

src/types/traits.d.ts#37

confirm

confirm(msg, title, callback?): IDialog

Parameters

Name	Type
`msg`	`string`
`title`	`undefined` \| `string` \| (`yes`: `boolean`) => `void`
`callback?`	(`yes`: `boolean`) => `false` \| `void`

Returns

Inherited from

Defined in

src/types/traits.d.ts#39

prompt

prompt(msg, title, callback, placeholder?, defaultValue?): IDialog

Parameters

Name	Type
`msg`	`string`
`title`	`undefined` \| `string` \| () => `false` \| `void`
`callback`	(`value`: `string`) => `false` \| `void`
`placeholder?`	`string`
`defaultValue?`	`string`

Returns

Inherited from

Defined in

src/types/traits.d.ts#45

alert

alert(msg, title?, callback?, className?): IDialog

Parameters

Name	Type
`msg`	`string` \| `HTMLElement`
`title?`	`string` \| () => `false` \| `void`
`callback?`	`string` \| (`dialog`: `IDialog`) => `false` \| `void`
`className?`	`string`

Returns

Inherited from

Defined in

src/types/traits.d.ts#53

destruct

destruct(jodit?): any

Parameters

Name	Type
`jodit?`	`IViewBased`<`IViewOptions`>

Returns

any

Inherited from

IViewWithToolbar.destruct

Defined in

src/types/types.d.ts#32

get

get<T>(chain, obj?): Nullable<T>

Type parameters

Name
`T`

Parameters

Name	Type
`chain`	`string`
`obj?`	`IDictionary`<`any`, `string`>

Returns

Nullable<T>

Inherited from

IViewWithToolbar.get

Defined in

src/types/types.d.ts#52

className

className(): string

Returns

string

Inherited from

IViewWithToolbar.className

Defined in

src/types/types.d.ts#55

getFullElName

getFullElName(elementName): string

Parameters

Name	Type
`elementName`	`string`

Returns

string

Inherited from

IViewWithToolbar.getFullElName

Defined in

src/types/types.d.ts#57

getFullElName(elementName, mod): string

Parameters

Name	Type
`elementName`	`string`
`mod`	`string`

Returns

string

Inherited from

IViewWithToolbar.getFullElName

Defined in

src/types/types.d.ts#58

getFullElName(elementName, mod?, modValue?): string

Parameters

Name	Type
`elementName`	`string`
`mod?`	`string`
`modValue?`	`string` \| `boolean`

Returns

string

Inherited from

IViewWithToolbar.getFullElName

Defined in

src/types/types.d.ts#59

setStatus

setStatus(componentStatus): void

Parameters

Name	Type
`componentStatus`	`ComponentStatus`

Returns

void

Inherited from

IViewWithToolbar.setStatus

Defined in

src/types/types.d.ts#71

hookStatus

hookStatus(status, callback): void

Parameters

Name	Type
`status`	`ComponentStatus`
`callback`	(`component`: `this`) => `void`

Returns

void

Inherited from

IViewWithToolbar.hookStatus

Defined in

src/types/types.d.ts#73

bindDestruct

bindDestruct(component): this

Parameters

Name	Type
`component`	`IComponent`<`IViewBased`<`IViewOptions`>>

Returns

this

Inherited from

IViewWithToolbar.bindDestruct

Defined in

src/types/types.d.ts#78

isLockedNotBy

isLockedNotBy(name): boolean

Parameters

Name	Type
`name`	`string`

Returns

boolean

Inherited from

IViewWithToolbar.isLockedNotBy

Defined in

src/types/view.d.ts#119

lock

lock(name?): boolean

Parameters

Name	Type
`name?`	`string`

Returns

boolean

Inherited from

IViewWithToolbar.lock

Defined in

src/types/view.d.ts#120

unlock

unlock(): boolean

Returns

boolean

Inherited from

IViewWithToolbar.unlock

Defined in

src/types/view.d.ts#121

toggleFullSize

toggleFullSize(isFullSize?): void

Parameters

Name	Type
`isFullSize?`	`boolean`

Returns

void

Inherited from

IViewWithToolbar.toggleFullSize

Defined in

src/types/view.d.ts#124

i18n

i18n(text, ...params): string

Parameters

Name	Type
`text`	`string`
`...params`	(`string` \| `number`)[]

Returns

string

Inherited from

IViewWithToolbar.i18n

Defined in

src/types/view.d.ts#142

getVersion

getVersion(): string

Returns

string

Inherited from

IViewWithToolbar.getVersion

Defined in

src/types/view.d.ts#146

getInstance

getInstance<T>(module, options?): T

Type parameters

Name	Type
`T`	extends `IComponent`<`IViewBased`<`IViewOptions`>>

Parameters

Name	Type
`module`	`Function`
`options?`	`object`

Returns

T

Inherited from

IViewWithToolbar.getInstance

Defined in

src/types/view.d.ts#149

getInstance<T>(moduleName, options?): T

Type parameters

Name	Type
`T`	extends `IComponent`<`IViewBased`<`IViewOptions`>>

Parameters

Name	Type
`moduleName`	`string`
`options?`	`object`

Returns

T

Inherited from

IViewWithToolbar.getInstance

Defined in

src/types/view.d.ts#150

registerButton

registerButton(btn): this

Parameters

Name	Type
`btn`	`IPluginButton`

Returns

this

Inherited from

IViewWithToolbar.registerButton

Defined in

src/types/view.d.ts#160

unregisterButton

unregisterButton(btn): this

Parameters

Name	Type
`btn`	`IPluginButton`

Returns

this

Inherited from

IViewWithToolbar.unregisterButton

Defined in

src/types/view.d.ts#161

getRegisteredButtonGroups

getRegisteredButtonGroups(): IDictionary<string[]>

Returns

IDictionary<string[]>

Inherited from

IViewWithToolbar.getRegisteredButtonGroups

Defined in

src/types/view.d.ts#162

setPanel

setPanel(element): void

Parameters

Name	Type
`element`	`string` \| `HTMLElement`

Returns

void

Inherited from

IViewWithToolbar.setPanel

Defined in

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