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

Hierarchy

Properties

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

Type declaration

  • beforeDestruct: "beforeDestruct"
  • beforeInit: "beforeInit"
  • destructed: "destructed"
  • ready: "ready"
async: IAsync = ...
buttons: undefined | IPluginButton[] = []
hasStyle: boolean = false

Plugin have CSS style and it should be loaded

jodit: IJodit

Parent View element

ownerWindow: Window = window

The window in which jodit was created

requires: string[] = []
uid: string

Methods

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Returns string

  • Returns void

  • Safe get any field

    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

    Type Parameters

    • T

    Parameters

    • chain: string

      the path to be traversed in the obj object

    • Optional obj: IDictionary<any, string>

      the object in which the value is searched

    Returns Nullable<T>

  • Calc BEM element class name

    Parameters

    • elementName: string

      element name in the bem classification

    Returns string

  • Parameters

    • elementName: string
    • mod: string

    Returns string

  • Parameters

    • elementName: string
    • mod: string
    • modValue: string | boolean

    Returns string

  • Adds a handler for changing the component's status

    Parameters

    • status: ComponentStatus

      the status at which the callback is triggered

    • callback: ((component: sticky) => void)

      a function that will be called when the status is status

        • (component: sticky): void
        • Parameters

          Returns void

    Returns void

  • Parameters

    • text: string
    • Rest ...params: (string | number)[]

    Returns string

  • Parameters

    Returns void

  • Remove sticky behaviour

    Parameters

    Returns void

  • Set component status

    See

    ComponentStatus

    Parameters

    Returns void

Accessors

  • get componentName(): string
  • Returns string

  • get defaultTimeout(): number
  • Returns number

  • get isDestructed(): boolean
  • Component was destructed

    Returns boolean

  • 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

  • get isReady(): boolean
  • Component is ready for work

    Returns boolean

  • get j(): T
  • Shortcut for this.jodit

    Returns T

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

    Returns Document

Constructors

Jodit PRO

If you like Jodit - try Jodit PRO