https://github.com/4rw44z/editorjs-table

editorjs-table
https://github.com/4rw44z/editorjs-table

Last synced: 2 months ago
JSON representation

editorjs-table

• Host: GitHub
• URL: https://github.com/4rw44z/editorjs-table
• Owner: codinova-tech
• Created: 2020-11-09T06:12:14.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-04T14:38:53.000Z (7 months ago)
• Last Synced: 2024-10-29T14:18:41.545Z (3 months ago)
• Language: CSS
• Size: 218 KB
• Stars: 42
• Watchers: 7
• Forks: 22
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-editorjs - editorjs-table - Table contructor tool with great editing row/column options. (Tools / Block Tools)

README

        
![](https://badgen.net/badge/Editor.js/v2.0/blue)

# Table tool

Table Block for the [Editor.js](https://editorjs.io).

![](screenshot.png)

## Installation

### Install via NPM or Yarn

Get the package

```shell

npm i --save-dev editorjs-table

```

or

```shell

yarn add editorjs-table --dev

```

Include module in your application

```javascript

const Table = require('editorjs-table');

```

### Upload to your project's source dir

1. Download folder `dist` from repository

2. Add `dist/bundle.js` file to your page.

## Usage

Add a new Tool to the `tools` property of the Editor.js initial config.

```javascript

var editor = EditorJS({

  ...

  

  tools: {

    ...

    table: {

      class: Table,

    }

  }

  

  ...

});

```

Or init Table Tool with additional settings

```javascript

var editor = EditorJS({

  ...

  

  tools: {

    ...

    table: {

      class: Table,

      inlineToolbar: true,

      config: {

        rows: 2,

        cols: 3,

      },

    },

  },

  

  ...

});

```

## Config Params

| Field              | Type     | Description                              |

| ------------------ | -------- | ---------------------------------------- |

| rows               | `number` | initial number of rows. by default `2`   |

| cols               | `number` | initial number of columns. by default `2`|

## Output data

This Tool returns `data` with following format

| Field     | Type         | Description                               |

| --------- | ------------ | ----------------------------------------- |

| content   | `string[][]` | two-dimensional array with table contents |

```json

{

    "type" : "table",

    "data" : {

        "content" : [ ["Kine", "1 pcs", "100$"], ["Pigs", "3 pcs", "200$"], ["Chickens", "12 pcs", "150$"] ]

    }

}

```