UIMessages | Jodit Editor

Plugin display pop-up messages in the lower right corner of the editor

Hierarchy

UIGroup
- UIMessages

Implements

IMessages

Properties

`Static` STATUSES

STATUSES: {
    beforeDestruct: "beforeDestruct";
    beforeInit: "beforeInit";
    destructed: "destructed";
    ready: "ready";
} = STATUSES

Type declaration

beforeDestruct: "beforeDestruct"
beforeInit: "beforeInit"
destructed: "destructed"
ready: "ready"

`Readonly` async

async: IAsync = ...

buttonSize

buttonSize: "small" | "tiny" | "xsmall" | "middle" | "large" = 'middle'

container

container: HTMLElement

elements

elements: IUIElement[] = []

jodit

jodit: IViewBased<IViewOptions>

Parent View element

`Readonly` mods

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

name

name: string = ''

`Readonly` options

options: {
defaultOffset: number;
defaultTimeout: number;
} = ...

Type declaration

defaultOffset: number
defaultTimeout: number

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

syncMod

syncMod: boolean = false

Synchronize mods to all children

`Readonly` uid

uid: string

Methods

afterSetMod

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

append

append(elm: IUIElement | IUIElement[], distElement?: string): UIMessages
Append new element into group
Parameters
- elm: IUIElement | IUIElement[]
- Optional distElement: string
Returns UIMessages

appendTo

appendTo(element: HTMLElement): UIMessages
Append container to element
Parameters
- element: HTMLElement
Returns UIMessages

bindDestruct

bindDestruct(component: IComponent<IViewBased<IViewOptions>>): UIMessages
Bind destructor to some View
Parameters
- component: IComponent<IViewBased<IViewOptions>>
Returns UIMessages

bubble

bubble(callback: ((parent: IUIElement) => void)): UIMessages
Apply callback for all parents
Parameters
- callback: ((parent: IUIElement) => void)
  - - (parent: IUIElement): void
    - Parameters
      
      parent: IUIElement
      
      Returns void
Returns UIMessages

className

className(): string
Returns string

clear

clear(): UIMessages
Clear group

Returns UIMessages

closest

closest<T>(type: Function | T): Nullable<T>
Find match parent
Type Parameters
- T extends IUIElement<T>
Parameters
- type: Function | T
Returns Nullable<T>

`Static` closestElement

closestElement(node: Node, type: Function): Nullable<IUIElement>
Find closest UIElement in DOM
Parameters
- node: Node
- type: Function
Returns Nullable<IUIElement>

destruct

destruct(): any
Returns any

error

error(text: string, timeout?: number): void
Parameters
- text: string
- Optional timeout: number
Returns void

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<T>(this: T, elementName: string): Nullable<HTMLElement>
Return element with BEM class name
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IElms
Parameters
- this: T
- elementName: string
Returns Nullable<HTMLElement>

getElms

getElms<T>(this: T, elementName: string): HTMLElement[]
Return elements with BEM class name
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IElms
Parameters
- this: T
- elementName: string
Returns HTMLElement[]

getFullElName

getFullElName(elementName: string): string
Calc BEM element class name
Parameters
- elementName: string
  
  element name in the bem classification
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
- mod: string
- modValue: string | boolean
Returns string

getMod

getMod(this: IMods, name: string): ModType
Get BEM class modification value
Parameters
- this: IMods
- name: string
Returns ModType

hookStatus

hookStatus(status: ComponentStatus, callback: ((component: UIMessages) => void)): void
Adds a handler for changing the component's status
Parameters
- status: ComponentStatus
  
  the status at which the callback is triggered
- callback: ((component: UIMessages) => void)
  
  a function that will be called when the status is status
  - - (component: UIMessages): void
    - Parameters
      
      component: UIMessages
      
      Returns void
Returns void

i18n

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

info

info(text: string, timeout?: number): void
Parameters
- text: string
- Optional timeout: number
Returns void

`Static` isInstanceOf

isInstanceOf<T>(c: unknown, constructorFunc: Function): c is T
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T>
Parameters
- c: unknown
- constructorFunc: Function
Returns c is T

message

message(text: string, variant?: MessageVariant, timeout?: number): void
Parameters
- text: string
- Optional variant: MessageVariant
- Optional timeout: number
Returns void

remove

remove(elm: IUIElement): UIMessages
Remove element from group
Parameters
- elm: IUIElement
Returns UIMessages

setMod

setMod<T>(this: T, name: string, value: ModType, container?: HTMLElement): T
Set/remove BEM class modification
Type Parameters
- T extends IComponent<IViewBased<IViewOptions>, T> & IContainer & IMods
Parameters
- this: T
- name: string
- value: ModType
  
  if null, mod will be removed
- Optional container: HTMLElement
Returns T

setParentView

setParentView(jodit: IViewBased<IViewOptions>): UIMessages
Attach component to View
Parameters
- jodit: IViewBased<IViewOptions>
Returns UIMessages

setStatus

setStatus(componentStatus: ComponentStatus): void
Set component status

See
ComponentStatus
Parameters
- componentStatus: ComponentStatus
  
  component status
Returns void

success

success(text: string, timeout?: number): void
Parameters
- text: string
- Optional timeout: number
Returns void

update

update(): void
Update all children

Returns void

updateParentElement

updateParentElement(target: IUIElement): UIMessages
Parameters
- target: IUIElement
Returns UIMessages

Accessors

allChildren

get allChildren(): IUIElement[]
All group children

Returns IUIElement[]

componentName

get componentName(): string
Returns string

componentStatus

get componentStatus(): ComponentStatus
Current component status

Returns ComponentStatus
set componentStatus(componentStatus: ComponentStatus): void
Setter for current component status
Parameters
- componentStatus: ComponentStatus
Returns void

defaultTimeout

get defaultTimeout(): number
Returns number

isDestructed

get isDestructed(): boolean
Component was destructed

Returns boolean

isInDestruct

get isInDestruct(): boolean
The component is currently undergoing destructuring or has already been destroyed. Those. you should not hang new events on him now or do anything else with him.

Returns boolean

isReady

get isReady(): boolean
Component is ready for work

Returns boolean

j

get j(): T
Shortcut for this.jodit

Returns T

od

get od(): Document
Shortcut for this.ownerDocument

Returns Document

ow

get ow(): Window
Returns Window

ownerDocument

get ownerDocument(): Document
The document in which jodit was created

Returns Document

parentElement

get parentElement(): Nullable<IUIElement>
Returns Nullable<IUIElement>
set parentElement(parentElement: Nullable<IUIElement>): void
Parameters
- parentElement: Nullable<IUIElement>
Returns void

Constructors

constructor

new UIMessages(jodit: IViewBased<IViewOptions>, __box: HTMLElement, options?: {
defaultOffset: number;
defaultTimeout: number;
}): UIMessages
Parameters
- jodit: IViewBased<IViewOptions>
- __box: HTMLElement
- options: {
  defaultOffset: number;
  defaultTimeout: number;
  } = ...
  - defaultOffset: number
  - defaultTimeout: number
Returns UIMessages

Jodit PRO

If you like Jodit - try Jodit PRO

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Static STATUSES

Type declaration

beforeDestruct: "beforeDestruct"

beforeInit: "beforeInit"

destructed: "destructed"

ready: "ready"

Readonly async

buttonSize

container

elements

jodit

Readonly mods

name

Readonly options

Type declaration

defaultOffset: number

defaultTimeout: number

ownerWindow

syncMod

Readonly uid

Methods

afterSetMod

Parameters

name: string

value: ModType

Returns void

append

Parameters

elm: IUIElement | IUIElement[]

Optional distElement: string

Returns UIMessages

appendTo

Parameters

element: HTMLElement

Returns UIMessages

bindDestruct

Parameters

component: IComponent<IViewBased<IViewOptions>>

Returns UIMessages

bubble

Parameters

callback: ((parent: IUIElement) => void)

Parameters

parent: IUIElement

Returns void

Returns UIMessages

className

Returns string

clear

Returns UIMessages

closest

Type Parameters

T extends IUIElement<T>

Parameters

type: Function | T

Returns Nullable<T>

Static closestElement

Parameters

node: Node

type: Function

Returns Nullable<IUIElement>

destruct

Returns any

error

Parameters

text: string

Optional timeout: number

Returns void

get

Type Parameters

T

Parameters

`Static` STATUSES

`Readonly` async

`Readonly` mods

`Readonly` options

`Readonly` uid

`Optional` distElement: string

`Static` closestElement

`Optional` timeout: number

`Optional` obj: IDictionary<any, string>

`Rest` ...params: (string | number)[]

`Optional` timeout: number

`Static` isInstanceOf

`Optional` variant: MessageVariant

`Optional` timeout: number