README

👁 Extension icon

TYPO3 extension bw_jsoneditor

👁 Latest version
👁 Supported TYPO3 versions
👁 Total downloads
👁 Composer
👁 codecov

Integrates the svelte-jsoneditor into the TYPO3 Backend.

👁 Screenshot

Installation

Composer

composer require blueways/bw-jsoneditor

TER

👁 TER version

Download the zip file from TYPO3 extension repository (TER).

Usage

The extension adds a new custom input with renderType jsonEditor. You can use the new type in TCA or Content Blocks.

TCA

When adding a new field to your TCA, use the type user and the renderType jsonEditor:

ExtensionManagementUtility::addTCAcolumns('my_table', [
 'new_field' => [
 'label' => 'My JSON Field',
 'config' => [
 'type' => 'user',
 'renderType' => 'jsonEditor',
 ],
 ],
]);

Make sure the database column of your field is large enough:

-- ext_tables.sql

CREATE TABLE my_table (
 new_field text
);

Content Blocks

You can use the new renderType in Content Blocks by adding the following configuration:

fields:
 - identifier: new_field
 label: 'My JSON Field'
 type: Textarea
 renderType: jsonEditor

Configuration

You can configure the JSON Editor with the offical API by adding the settings to the options array:

$GLOBALS['TCA']['my_table']['columns']['my_field']['config']['options'] = [
 'mode' => 'tree'
];

The new option height controls the maximum height of the editor, it defaults to auto. Setting a value in pixels will set a fixed height to the editor.

License

This project is licensed under GNU General Public License 2.0 (or later).