@calumk/editorjs-Columns

A plugin which allows the user to have columns!

Please Read the Known Bugs Section! Pull requests are very much welcomed!

Installation

npm i @calumk/editorjs-columns

https://cdn.jsdelivr.net/npm/@calumk/editorjs-columns@latest

Demo

Features

• Support new vertical menu style
• Save/Load
• Support for 2 colums
• Support for 3 columns
  • Migrate storage to array
  • Add tool to change type
  • Added tool to switch/roll arrays
• Refactor code for legibility
• Tests

ChangeLog

28/04/23 - Re-added feature - EditorJs must now be passed as instance through tool to child, to avoid duplicate editorjs installs, and ensure only one editor js instance is used. 16/05/22 - Removed global tool varable. Switched to config variable for column tools (see Example) 22/05/22 - EditorJs must now be passed as instance through tool to child, to avoid duplicate editorjs installs - Rolled Back

Known Bugs

• Pressing enter key inside a column, will exit the column

  • Can be solved (sort-of) by using @calumk/editorjs-paragraph-linebreakable

• Pressing tab key inside column will launch both column, and parent tools - This is hard to solve, as pasting triggers propergation up the column editor into the main editor

• Copy/Pasting can cause duplication of data in the wrong place - This is hard to solve, as pasting triggers propergation up the column editor into the main editor

• z-index issues with toolboxes

• Tools are hosted as global var

• All Styling is currently only in the example.html

  • Column styling should move to plugin
  • Opinionaited styling (Borders, rounded corners, hover shaddow) will remain in example.html

• SVG logo is not rendering correctly in new vertical menu

Docs

None yet, see example/example.html for useage.

---

Note : Tools are passed to editorjs-columns using config.tools property

// first define the tools to be made avaliable in the columns
let column_tools = {
    header: Header,
    alert : Alert,
    paragraph : editorjsParagraphLinebreakable,
    delimiter : Delimiter
}

// next define the tools in the main block
// Warning - Dont just use main_tools - you will probably generate a circular reference 
let main_tools = {
// Load Official Tools
    header: Header,
    alert : Alert,
    paragraph : editorjsParagraphLinebreakable,
    delimiter : Delimiter,

    columns : {
        class : editorjsColumns,
        config : {
          EditorJsLibrary : EditorJs, // Pass the library instance to the columns instance.
          tools : column_tools // IMPORTANT! ref the column_tools
        }
      },
}


editor = new EditorJS({
    tools : main_tools,
});

You can also use the i18n feature of Editor.js to change the text of the tools.

i18n: {
	messages: {
		toolNames: {
			Columns: `Columnas`,
		},
		tools: {
			columns: {
				'2 Columns': `Dos columnas`,
				'3 Columns': `Tres columnas`, 
				'Roll Columns': `Rotar columnas`,
                'Are you sure?': `¿Está seguro?`,
				'This will delete Column 3!': `¡Esto eliminará la Columna 3!`,
				'Yes, delete it!': `¡Sí, eliminar!`,
				Cancel: `Cancelar`,
			},
		},
	},
};