StatusBar
- Hierarchy
- Implements
- constructor
- STATUSES
- async
- uid
- ownerWindow
- jodit
- container
- mods
- target
- componentName
- ownerDocument
- od
- ow
- isReady
- isDestructed
- isInDestruct
- componentStatus
- j
- defaultTimeout
- isShown
- getFullElName
- get
- bindDestruct
- setStatus
- hookStatus
- isInstanceOf
- i18n
- setParentView
- getElm
- getElms
- afterSetMod
- setMod
- getMod
- className
- hide
- show
- getHeight
- append
- destruct
modules/status-bar.StatusBar
The base class of all Jodit UI components. Provides work with a life cycle.
Hierarchy
-
↳
StatusBar
Implements
constructor
new StatusBar(jodit, target): StatusBar
Parameters
| Name | Type |
|---|---|
jodit |
IJodit |
target |
HTMLElement |
Returns
Inherited from
Defined in
src/modules/status-bar/status-bar.ts#104
STATUSES
Static STATUSES: Object = STATUSES
Type declaration
| Name | Type |
|---|---|
beforeInit |
"beforeInit" |
ready |
"ready" |
beforeDestruct |
"beforeDestruct" |
destructed |
"destructed" |
Inherited from
Defined in
src/core/component/component.ts#40
async
async: IAsync
Implementation of
Inherited from
Defined in
src/core/component/component.ts#44
uid
Readonly uid: string
Implementation of
Inherited from
Defined in
src/core/component/component.ts#59
ownerWindow
ownerWindow: Window = window
The window in which jodit was created
Implementation of
Inherited from
Defined in
src/core/component/component.ts#109
jodit
jodit: IJodit
Parent View element
Inherited from
Defined in
src/core/component/view-component.ts#22
container
Readonly container: HTMLDivElement
Implementation of
Defined in
src/modules/status-bar/status-bar.ts#37
mods
Readonly mods: IDictionary<ModType> = {}
Implementation of
Inherited from
Defined in
src/modules/status-bar/status-bar.ts#60
target
Readonly target: HTMLElement
Defined in
src/modules/status-bar/status-bar.ts#106
componentName
get componentName(): string
Returns
string
Implementation of
Defined in
src/core/component/component.ts#46
ownerDocument
get ownerDocument(): Document
The document in which jodit was created
Returns
Implementation of
Defined in
src/core/component/component.ts#95
od
get od(): Document
Shortcut for this.ownerDocument
Returns
Implementation of
Defined in
src/core/component/component.ts#102
ow
get ow(): Window
Returns
Implementation of
Defined in
src/core/component/component.ts#110
isReady
get isReady(): boolean
Component is ready for work
Returns
boolean
Implementation of
Defined in
src/core/component/component.ts#145
isDestructed
get isDestructed(): boolean
Component was destructed
Returns
boolean
Implementation of
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
Defined in
src/core/component/component.ts#160
componentStatus
get componentStatus(): ComponentStatus
Current component status
Returns
Implementation of
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
Defined in
src/core/component/component.ts#217
j
get j(): T
Shortcut for this.jodit
Returns
T
Defined in
src/core/component/view-component.ts#27
defaultTimeout
get defaultTimeout(): number
Returns
number
Defined in
src/core/component/view-component.ts#31
isShown
get isShown(): boolean
Status bar is shown
Returns
boolean
Implementation of
Defined in
src/modules/status-bar/status-bar.ts#56
getFullElName
getFullElName(elementName): string
Calc BEM element class name
Parameters
| Name | Type | Description |
|---|---|---|
elementName |
string |
element name in the bem classification |
Returns
string
Inherited from
Defined in
src/core/component/component.ts#65
getFullElName(elementName, mod): string
Parameters
| Name | Type |
|---|---|
elementName |
string |
mod |
string |
Returns
string
Inherited from
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
Inherited from
Defined in
src/core/component/component.ts#67
get
get<T>(chain, obj?): Nullable<T>
Safe get any field
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
chain |
string |
the path to be traversed in the obj object |
obj? |
IDictionary |
the object in which the value is searched |
Returns
Nullable<T>
Example
private a = {
b: {
c: {
e: {
g: {
color: 'red'
}
}
}
}
}
this.get('a.b.c.e.g.color'); // Safe access to color
// instead using optionsl chaining
this?.a?.b?.c?.e?.g?.color
Inherited from
Defined in
src/core/component/component.ts#138
bindDestruct
bindDestruct(component): this
Bind destructor to some View
Parameters
| Name | Type |
|---|---|
component |
IComponent<IViewBased<IViewOptions>> |
Returns
this
Inherited from
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
Inherited from
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
Inherited from
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
Defined in
src/core/component/component.ts#283
i18n
i18n(text, ...params): string
Parameters
| Name | Type |
|---|---|
text |
string |
...params |
(string | number)[] |
Returns
string
Inherited from
Defined in
src/core/component/view-component.ts#35
setParentView
setParentView(jodit): this
Attach component to View
Parameters
| Name | Type |
|---|---|
jodit |
IJodit |
Returns
this
Inherited from
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
Inherited from
Defined in
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
Inherited from
Defined in
afterSetMod
afterSetMod(name, value): void
Parameters
| Name | Type |
|---|---|
name |
string |
value |
ModType |
Returns
void
Inherited from
Defined in
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
Inherited from
Defined in
getMod
getMod(this, name): ModType
Get BEM class modification value
Parameters
| Name | Type |
|---|---|
this |
IMods |
name |
string |
Returns
Inherited from
Defined in
className
className(): string
Returns
string
Inherited from
Defined in
src/modules/status-bar/status-bar.ts#33
hide
hide(): void
Hide statusbar
Returns
void
Defined in
src/modules/status-bar/status-bar.ts#42
show
show(): void
Show statusbar
Returns
void
Defined in
src/modules/status-bar/status-bar.ts#49
getHeight
getHeight(): number
Height of statusbar
Returns
number
Defined in
src/modules/status-bar/status-bar.ts#65
append
append(child, inTheRight?): void
Add element in statusbar
Parameters
| Name | Type | Default value |
|---|---|---|
child |
HTMLElement |
undefined |
inTheRight |
boolean |
false |
Returns
void
Defined in
src/modules/status-bar/status-bar.ts#84
destruct
destruct(): void
Returns
void
Inherited from
Defined in
jodit/src/modules/status-bar/status-bar.ts:116