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 = ...
buttonSize: "small" | "tiny" | "xsmall" | "middle" | "large" = 'middle'
container: HTMLElement
elements: IUIElement[] = []

Parent View element

mods: IDictionary<null | string | boolean, string> = {}
name: string = ''
options: {
    align?: "left" | "right" | "center" | "full";
    className?: string;
    mod?: string;
    ref?: string;
    width?: "full";
} = ...

Type declaration

  • Optional align?: "left" | "right" | "center" | "full"
  • Optional className?: string
  • Optional mod?: string
  • Optional ref?: string
  • Optional width?: "full"
ownerWindow: Window = window

The window in which jodit was created

syncMod: boolean = false

Synchronize mods to all children

uid: string

Methods

  • Parameters

    Returns void

  • Returns string

  • Returns any

  • 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

  • Get BEM class modification value

    Parameters

    • this: IMods
    • name: string

    Returns ModType

  • Adds a handler for changing the component's status

    Parameters

    • status: ComponentStatus

      the status at which the callback is triggered

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

      a function that will be called when the status is status

        • (component: UIBlock): void
        • Parameters

          Returns void

    Returns void

  • Parameters

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

    Returns string

  • Set component status

    See

    ComponentStatus

    Parameters

    Returns void

  • Update all children

    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

  • Parameters

    • jodit: IViewBased<IViewOptions>
    • Optional elements: (null | false | void | IUIElement)[]
    • options: {
          align?: "left" | "right" | "center" | "full";
          className?: string;
          mod?: string;
          ref?: string;
          width?: "full";
      } = ...
      • Optional align?: "left" | "right" | "center" | "full"
      • Optional className?: string
      • Optional mod?: string
      • Optional ref?: string
      • Optional width?: "full"

    Returns UIBlock

Jodit PRO

If you like Jodit - try Jodit PRO