IControlType

types.IControlType

Type parametersType parametersType parameters

HierarchyHierarchyHierarchy

• IControlType

  ↳ IControlTypeStrong

namenamename

Optional name: string

Defined inDefined inDefined in

src/types/toolbar.d.ts#31

texttexttext

Optional text: string

Defined inDefined inDefined in

src/types/toolbar.d.ts#32

textTemplatetextTemplatetextTemplate

Optional textTemplate: (jodit: T, value: string) => string

Type declarationType declarationType declaration

(jodit, value): string

ParametersParametersParameters

ReturnsReturnsReturns

string

Defined inDefined inDefined in

src/types/toolbar.d.ts#33

modemodemode

Optional mode: Modes

Defined inDefined inDefined in

src/types/toolbar.d.ts#35

hotkeyshotkeyshotkeys

Optional hotkeys: string | string[]

Defined inDefined inDefined in

src/types/toolbar.d.ts#36

datadatadata

Optional data: IDictionary

Defined inDefined inDefined in

src/types/toolbar.d.ts#37

isInputisInputisInput

Optional isInput: boolean

Defined inDefined inDefined in

src/types/toolbar.d.ts#39

componentcomponentcomponent

Optional component: "button" | "select"

Defined inDefined inDefined in

src/types/toolbar.d.ts#41

isVisibleisVisibleisVisible

Optional isVisible: (editor: T, control: IControlType<IViewBased<IViewOptions> | IJodit | IFileBrowser<IFileBrowserOptions>, IToolbarButton>) => boolean

Type declarationType declarationType declaration

(editor, control): boolean

ParametersParametersParameters

ReturnsReturnsReturns

boolean

Defined inDefined inDefined in

src/types/toolbar.d.ts#43

isActiveisActiveisActive

Optional isActive: (editor: T, button: B) => boolean

You can use it function for control - active/not active button

See

copyformat plugin

Example

var editor = Jodit.make('.selectorclass', {
    buttons: {
         checkbox: {
             data: {
                 active: false,
             },
             iconURL: 'checkbox.png',
             exec: function (a, b, btn) {
                 btn.data.active = !btn.data.active;
             },
             isActive: function (editor, btn) {
                 return !!btn.data.active;
             }
         }
    }
})

Type declarationType declarationType declaration

(editor, button): boolean

ParametersParametersParameters

ReturnsReturnsReturns

boolean

Defined inDefined inDefined in

src/types/toolbar.d.ts#69

updateupdateupdate

Optional update: (editor: T, button: B) => void

Type declarationType declarationType declaration

(editor, button): void

ParametersParametersParameters

ReturnsReturnsReturns

void

Defined inDefined inDefined in

src/types/toolbar.d.ts#71

isChildActiveisChildActiveisChildActive

Optional isChildActive: (editor: T, button: B) => boolean

Type declarationType declarationType declaration

(editor, button): boolean

ParametersParametersParameters

ReturnsReturnsReturns

boolean

Defined inDefined inDefined in

src/types/toolbar.d.ts#73

getContentgetContentgetContent

Optional getContent: (editor: T, button: B) => string | HTMLElement

Type declarationType declarationType declaration

(editor, button): string | HTMLElement

ParametersParametersParameters

ReturnsReturnsReturns

string | HTMLElement

Defined inDefined inDefined in

src/types/toolbar.d.ts#75

isDisabledisDisabledisDisabled

Optional isDisabled: (editor: T, button: B) => boolean

You can use it function for control - disable/enable button

See

copyformat plugin

Example

var editor = Jodit.make('.selectorclass', {
    buttons: {
         checkbox: {
             data: {
                 enable: false,
             },
             iconURL: 'checkbox.png',
             exec: function (a, b, btn) {
                 btn.data.active = !btn.data.active;
             },
             isDisabled: function (editor, btn) {
                 return !!btn.data.enable;
             }
         }
    }
})

Type declarationType declarationType declaration

(editor, button): boolean

ParametersParametersParameters

ReturnsReturnsReturns

boolean

Defined inDefined inDefined in

src/types/toolbar.d.ts#101

isChildDisabledisChildDisabledisChildDisabled

Optional isChildDisabled: (editor: T, button: B) => boolean

Type declarationType declarationType declaration

(editor, button): boolean

ParametersParametersParameters

ReturnsReturnsReturns

boolean

Defined inDefined inDefined in

src/types/toolbar.d.ts#103

listlistlist

Optional list: string[] | number[] | IDictionary<string | number>

Drop-down list. A hash or array. You must specify the command which will be submitted for the hash key
(or array value) (see .IJodit.execCommand or define 'exec' function. See example

Example

Jodit.make('#editor2', {
    buttons: Jodit.defaultOptions.buttons.concat([{
       name: 'listsss',
       iconURL: 'stuf/dummy.png',
       list: {
           h1: 'insert Header 1',
           h2: 'insert Header 2',
           clear: 'Empty editor',
       },
       exec: (editor, current, control) => {
            var key = control.args[0],
               value = control.args[1];

            if (key === 'clear') {
                this.setEditorValue('');
                return;
            }
            this.s.insertNode(this.c.element(key, ''));
            this.message.info('Was inserted ' + value);
       },
       template: function (key, value) {
           return '<div>' + value + '</div>';
       }
 });

Defined inDefined inDefined in

src/types/toolbar.d.ts#136

commandcommandcommand

Optional command: string

The command executes when the button is pressed. Allowed all

See

https://developer.mozilla.org/ru/docs/Web/API/Document/execCommand#commands
and several specific IJodit.execCommand

Defined inDefined inDefined in

src/types/toolbar.d.ts#143

tagRegExptagRegExptagRegExp

Optional tagRegExp: RegExp

Defined inDefined inDefined in

src/types/toolbar.d.ts#144

tagstagstags

Optional tags: HTMLTagNames[]

Tag list: when cursor inward tag from this list, button will be highlighted

Defined inDefined inDefined in

src/types/toolbar.d.ts#149

csscsscss

Optional css: IDictionary<string | string[]>

Defined inDefined inDefined in

src/types/toolbar.d.ts#151

iconiconicon

Optional icon: string

String name for existing icons.

Example

var editor = Jodit.make('.editor', {
 buttons: [
     {
         icon: 'source',
         exec: function (editor) {
             editor.toggleMode();
         }
     }
 ]
})

Defined inDefined inDefined in

src/types/toolbar.d.ts#169

iconURLiconURLiconURL

Optional iconURL: string

Use this property if you want set background image for the button. This icon can be 16 * 16 px in SVG or
another image formats

Defined inDefined inDefined in

src/types/toolbar.d.ts#175

tooltiptooltiptooltip

Optional tooltip: string | (editor: T, control: IControlType<T, B>, button?: B) => string

Buttons hint

Defined inDefined inDefined in

src/types/toolbar.d.ts#180

execexecexec

Optional exec: (view: T, current: Nullable<Node>, options: { control: IControlType<T, B> ; originalEvent: Event ; button: IToolbarButton }) => any

This function will be executed when the button is pressed.

Type declarationType declarationType declaration

(view, current, options): any

ParametersParametersParameters

ReturnsReturnsReturns

any

Defined inDefined inDefined in

src/types/toolbar.d.ts#187

childExecchildExecchildExec

Optional childExec: (view: T, current: Nullable<Node>, options: { parentControl: IControlType<T, B> ; control: IControlType<T, B> ; originalEvent: Event ; button: IToolbarButton }) => any

Allows you to set a separate handler for list items

Example

Jodit.make('.editor', {
  buttons: [
    {
      name: 'add-date',
      iconURL: 'stuf/dummy.png',
      list: {
        options: 'Open options',
      },
      exec(editor, current, control) {
        editor.s.insertHTML(new Date().toString());
      },
      childExec(editor, current, control) {
        if (control.args[0] === 'options') {
          editor.alert('Options');
        }
      }
    }
  ]
})

Type declarationType declarationType declaration

(view, current, options): any

ParametersParametersParameters

ReturnsReturnsReturns

any

Defined inDefined inDefined in

src/types/toolbar.d.ts#222

argsargsargs

Optional args: any[]

Defined inDefined inDefined in

src/types/toolbar.d.ts#233

templatetemplatetemplate

Optional template: (jodit: T, key: string, value: string) => string

The method which will be called for each element of button.list

Type declarationType declarationType declaration

(jodit, key, value): string

ParametersParametersParameters

ReturnsReturnsReturns

string

Defined inDefined inDefined in

src/types/toolbar.d.ts#238

childTemplatechildTemplatechildTemplate

Optional childTemplate: (jodit: T, key: string, value: string, button: IToolbarButton) => string

Type declarationType declarationType declaration

(jodit, key, value, button): string

ParametersParametersParameters

ReturnsReturnsReturns

string

Defined inDefined inDefined in

src/types/toolbar.d.ts#240

popuppopuppopup

Optional popup: (jodit: T, current: Nullable<Node>, close: () => void, button: B) => string | false | HTMLElement | IUIElement

After click on the button it will show popup element which consist value that this function returned

Example

var editor = Jodit.make('.editor', {
   buttons: [
     {
         icon: "insertCode",
         popup: function (editor) {
             var div = document.createElement('div'), button = dccument.createElement('button');
             div.innerHTML = 'Hi! Click button and enter your code';
             button.innerHTML = 'Click me';

             div.appendChild(button);

             button.addEventListener('click', function (e) {
                 editor.s.insertHTML(prompt("Enter your code"));
                 return false;
             });
             return div;
         }
     }
   ]
});

Type declarationType declarationType declaration

(jodit, current, close, button): string | false | HTMLElement | IUIElement

ParametersParametersParameters

ReturnsReturnsReturns

string | false | HTMLElement | IUIElement

Defined inDefined inDefined in

src/types/toolbar.d.ts#273

defaultValuedefaultValuedefaultValue

Optional defaultValue: string | string[]

Defined inDefined inDefined in

src/types/toolbar.d.ts#280

valuevaluevalue

Optional value: (jodit: T, button: B) => undefined | string

Type declarationType declarationType declaration

(jodit, button): undefined | string

ParametersParametersParameters

ReturnsReturnsReturns

undefined | string

Defined inDefined inDefined in

src/types/toolbar.d.ts#282

modsmodsmods

Optional mods: IDictionary<ModType>

Defined inDefined inDefined in

jodit/src/types/toolbar.d.ts:283