Jodit Editor

ProgressBar

ui/progress-bar.ProgressBar

The base class of all Jodit UI components. Provides work with a life cycle.

Hierarchy

Implements

constructor

new ProgressBar(jodit, options?): ProgressBar

Parameters

Name Type
jodit IViewBased<IViewOptions>
options? IDictionary

Returns

ProgressBar

Inherited from

UIElement.constructor

Defined in

src/core/ui/element.ts#175

STATUSES

Static STATUSES: Object = STATUSES

Type declaration

Name Type
beforeInit "beforeInit"
ready "ready"
beforeDestruct "beforeDestruct"
destructed "destructed"

Inherited from

UIElement.STATUSES

Defined in

src/core/component/component.ts#40

async

async: IAsync

Implementation of

IProgressBar.async

Inherited from

UIElement.async

Defined in

src/core/component/component.ts#44

uid

Readonly uid: string

Implementation of

IProgressBar.uid

Inherited from

UIElement.uid

Defined in

src/core/component/component.ts#59

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

Implementation of

IProgressBar.ownerWindow

Inherited from

UIElement.ownerWindow

Defined in

src/core/component/component.ts#109

jodit

jodit: IViewBased<IViewOptions>

Parent View element

Implementation of

IProgressBar.jodit

Inherited from

UIElement.jodit

Defined in

src/core/component/view-component.ts#22

container

container: HTMLElement

Implementation of

IProgressBar.container

Inherited from

UIElement.container

Defined in

src/core/ui/element.ts#32

name

name: string = ''

Implementation of

IProgressBar.name

Inherited from

UIElement.name

Defined in

src/core/ui/element.ts#33

mods

Readonly mods: IDictionary<null | string | boolean> = {}

Implementation of

IProgressBar.mods

Inherited from

UIElement.mods

Defined in

src/core/ui/element.ts#119

componentName

get componentName(): string

Returns

string

Implementation of

IProgressBar.componentName

Inherited from

UIElement.componentName

Defined in

src/core/component/component.ts#46

ownerDocument

get ownerDocument(): Document

The document in which jodit was created

Returns

Document

Implementation of

IProgressBar.ownerDocument

Inherited from

UIElement.ownerDocument

Defined in

src/core/component/component.ts#95

od

get od(): Document

Shortcut for this.ownerDocument

Returns

Document

Implementation of

IProgressBar.od

Inherited from

UIElement.od

Defined in

src/core/component/component.ts#102

ow

get ow(): Window

Returns

Window

Implementation of

IProgressBar.ow

Inherited from

UIElement.ow

Defined in

src/core/component/component.ts#110

isReady

get isReady(): boolean

Component is ready for work

Returns

boolean

Implementation of

IProgressBar.isReady

Inherited from

UIElement.isReady

Defined in

src/core/component/component.ts#145

isDestructed

get isDestructed(): boolean

Component was destructed

Returns

boolean

Implementation of

IProgressBar.isDestructed

Inherited from

UIElement.isDestructed

Defined in

src/core/component/component.ts#152

isInDestruct

get isInDestruct(): boolean

The component is currently undergoing destructuring or has already been destroyed.
Those. you should not the app froze new events on him now or do anything else with him.

Returns

boolean

Implementation of

IProgressBar.isInDestruct

Inherited from

UIElement.isInDestruct

Defined in

src/core/component/component.ts#160

componentStatus

get componentStatus(): ComponentStatus

Current component status

Returns

ComponentStatus

Implementation of

IProgressBar.componentStatus

Inherited from

UIElement.componentStatus

Defined in

src/core/component/component.ts#210

set componentStatus(componentStatus): void

Setter for current component status

Parameters

Name Type
componentStatus ComponentStatus

Returns

void

Implementation of

IProgressBar.componentStatus

Inherited from

UIElement.componentStatus

Defined in

src/core/component/component.ts#217

j

get j(): T

Shortcut for this.jodit

Returns

T

Implementation of

IProgressBar.j

Inherited from

UIElement.j

Defined in

src/core/component/view-component.ts#27

defaultTimeout

get defaultTimeout(): number

Returns

number

Implementation of

IProgressBar.defaultTimeout

Inherited from

UIElement.defaultTimeout

Defined in

src/core/component/view-component.ts#31

parentElement

get parentElement(): Nullable<IUIElement>

Returns

Nullable<IUIElement>

Implementation of

IProgressBar.parentElement

Inherited from

UIElement.parentElement

Defined in

src/core/ui/element.ts#37

set parentElement(parentElement): void

Parameters

Name Type
parentElement Nullable<IUIElement>

Returns

void

Implementation of

IProgressBar.parentElement

Inherited from

UIElement.parentElement

Defined in

src/core/ui/element.ts#41

getFullElName

getFullElName(elementName): string

Calc BEM element class name

Parameters

Name Type Description
elementName string element name in the bem classification

Returns

string

Implementation of

IProgressBar.getFullElName

Inherited from

UIElement.getFullElName

Defined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

Parameters

Name Type
elementName string
mod string

Returns

string

Implementation of

IProgressBar.getFullElName

Inherited from

UIElement.getFullElName

Defined in

src/core/component/component.ts#66

getFullElName(elementName, mod, modValue): string

Parameters

Name Type
elementName string
mod string
modValue string | boolean

Returns

string

Implementation of

IProgressBar.getFullElName

Inherited from

UIElement.getFullElName

Defined in

src/core/component/component.ts#67

bindDestruct

bindDestruct(component): this

Bind destructor to some View

Parameters

Name Type
component IComponent<IViewBased<IViewOptions>>

Returns

this

Implementation of

IProgressBar.bindDestruct

Inherited from

UIElement.bindDestruct

Defined in

src/core/component/component.ts#170

setStatus

setStatus(componentStatus): void

Set component status

Parameters

Name Type Description
componentStatus ComponentStatus component status

Returns

void

See

ComponentStatus

Implementation of

IProgressBar.setStatus

Inherited from

UIElement.setStatus

Defined in

src/core/component/component.ts#226

hookStatus

hookStatus(status, callback): void

Adds a handler for changing the component's status

Parameters

Name Type Description
status ComponentStatus the status at which the callback is triggered
callback (component: this) => void a function that will be called when the status is status

Returns

void

Implementation of

IProgressBar.hookStatus

Inherited from

UIElement.hookStatus

Defined in

src/core/component/component.ts#265

isInstanceOf

isInstanceOf<T>(c, constructorFunc): c is T

Type parameters

Name Type
T extends Component

Parameters

Name Type
c unknown
constructorFunc Function

Returns

c is T

Inherited from

UIElement.isInstanceOf

Defined in

src/core/component/component.ts#283

i18n

i18n(text, ...params): string

Parameters

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

Returns

string

Implementation of

IProgressBar.i18n

Inherited from

UIElement.i18n

Defined in

src/core/component/view-component.ts#35

setParentView

setParentView(jodit): this

Attach component to View

Parameters

Name Type
jodit IViewBased<IViewOptions>

Returns

this

Implementation of

IProgressBar.setParentView

Inherited from

UIElement.setParentView

Defined in

src/core/component/view-component.ts#42

getElm

getElm<T>(this, elementName): Nullable<HTMLElement>

Return element with BEM class name

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms

Parameters

Name Type
this T
elementName string

Returns

Nullable<HTMLElement>

Implementation of

IProgressBar.getElm

Inherited from

UIElement.getElm

Defined in

src/core/traits/elms.ts#18

getElms

getElms<T>(this, elementName): HTMLElement[]

Return elements with BEM class name

Type parameters

Name Type
T extends IComponent<IViewBased<IViewOptions>> & IContainer & IElms

Parameters

Name Type
this T
elementName string

Returns

HTMLElement[]

Implementation of

IProgressBar.getElms

Inherited from

UIElement.getElms

Defined in

src/core/traits/elms.ts#30

afterSetMod

afterSetMod(name, value): void

Parameters

Name Type
name string
value ModType

Returns

void

Implementation of

IProgressBar.afterSetMod

Inherited from

UIElement.afterSetMod

Defined in

src/core/traits/mods.ts#23

setMod

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

Set/remove BEM class modification

Type parameters

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

Parameters

Name Type Description
this T -
name string -
value ModType if null, mod will be removed
container? HTMLElement -

Returns

T

Implementation of

IProgressBar.setMod

Inherited from

UIElement.setMod

Defined in

src/core/traits/mods.ts#30

getMod

getMod(this, name): ModType

Get BEM class modification value

Parameters

Name Type
this IMods
name string

Returns

ModType

Implementation of

IProgressBar.getMod

Inherited from

UIElement.getMod

Defined in

src/core/traits/mods.ts#64

bubble

bubble(callback): this

Apply callback for all parents

Parameters

Name Type
callback (parent: IUIElement) => void

Returns

this

Implementation of

IProgressBar.bubble

Inherited from

UIElement.bubble

Defined in

src/core/ui/element.ts#51

updateParentElement

updateParentElement(target): this

Parameters

Name Type
target IUIElement

Returns

this

Implementation of

IProgressBar.updateParentElement

Inherited from

UIElement.updateParentElement

Defined in

src/core/ui/element.ts#62

get

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

Type parameters

Name
T

Parameters

Name Type
chain string
obj? IDictionary

Returns

Nullable<T>

Implementation of

IProgressBar.get

Inherited from

UIElement.get

Defined in

src/core/ui/element.ts#68

closest

closest<T>(type): Nullable<T extends typeof UIElement ? InstanceType<T> : T>

Find match parent

Type parameters

Name Type
T extends typeof UIElement | UIElement<IViewBased<IViewOptions>>

Parameters

Name Type
type Function | UIElement<IViewBased<IViewOptions>>

Returns

Nullable<T extends typeof UIElement ? InstanceType<T> : T>

Implementation of

IProgressBar.closest

Inherited from

UIElement.closest

Defined in

src/core/ui/element.ts#75

closestElement

closestElement(node, type): Nullable<IUIElement>

Find closest UIElement in DOM

Parameters

Name Type
node Node
type Function

Returns

Nullable<IUIElement>

Inherited from

UIElement.closestElement

Defined in

src/core/ui/element.ts#106

update

update(): void

Update UI from state

Returns

void

Implementation of

IProgressBar.update

Inherited from

UIElement.update

Defined in

src/core/ui/element.ts#124

appendTo

appendTo(element): this

Append container to element

Parameters

Name Type
element HTMLElement

Returns

this

Implementation of

IProgressBar.appendTo

Inherited from

UIElement.appendTo

Defined in

src/core/ui/element.ts#131

className

className(): string

Returns

string

Implementation of

IProgressBar.className

Overrides

UIElement.className

Defined in

src/core/ui/progress-bar/progress-bar.ts#21

show

show(): IProgressBar

Show progress bar

Returns

IProgressBar

Implementation of

IProgressBar.show

Defined in

src/core/ui/progress-bar/progress-bar.ts#33

hide

hide(): IProgressBar

Returns

IProgressBar

Implementation of

IProgressBar.hide

Defined in

src/core/ui/progress-bar/progress-bar.ts#39

progress

progress(percentage): IProgressBar

Parameters

Name Type
percentage number

Returns

IProgressBar

Implementation of

IProgressBar.progress

Defined in

src/core/ui/progress-bar/progress-bar.ts#44

destruct

destruct(): any

Returns

any

Implementation of

IProgressBar.destruct

Overrides

UIElement.destruct

Defined in

jodit/src/core/ui/progress-bar/progress-bar.ts:49

In this article: