Setting page TSconfig¶

Setting the page TSconfig globally¶

Global page TSconfig should be stored within an extension, usually a sitepackage extension. The content of the file Configuration/page.tsconfig within an extension is automatically loaded during build time.

It is possible to load other TSconfig files with the import syntax within this file:

@import 'EXT:my_sitepackage/Configuration/TsConfig/Page/Basic.tsconfig'
@import 'EXT:my_sitepackage/Configuration/TsConfig/Page/Mod/Wizards/NewContentElement.tsconfig'

Many page TSconfig settings can be set globally. This is useful for installations that contain only one site and use only one sitepackage extension.

Extensions supplying custom default page TSconfig that should always be included, can also set the page TSconfig globally.

The PSR-14 event BeforeLoadedPageTsConfigEvent is available to add global static page TSconfig before anything else is loaded.

<?php

declare(strict_types=1);

use TYPO3\CMS\Core\Information\Typo3Version;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

defined('TYPO3') or die();

$versionInformation = GeneralUtility::makeInstance(Typo3Version::class);
// Only include page.tsconfig if TYPO3 version is below 12 so that it is not imported twice.
if ($versionInformation->getMajorVersion() < 12) {
    ExtensionManagementUtility::addPageTSConfig(
        '@import "EXT:my_sitepackage/Configuration/page.tsconfig"'
    );
}

Page TSconfig on site level¶

Page TSconfig can be defined on a site level by placing a file called page.tsconfig in the storage directory of the site (config/sites/<identifier>/).

Extensions and site packages can provide page TSconfig in site sets by placing a file called page.tsconfig into the folder of that set.

This way sites and sets can ship page TSconfig without the need for database entries or by polluting global scope. Dependencies can be expressed via site sets, allowing for automatic ordering and deduplication.

See also site sets as page TSconfig provider.

name: my-vendor/my-set
label: My Set

base: 'http://example.com/'
rootPageId: 1
dependencies:
  - my-vendor/my-set

# This tsconfig will be loaded for pages in site "my-site"
# [...]

# This tsconfig will be loaded for pages in all sites that depend on set 'my-vendor/my-set'
# [...]

Static page TSconfig¶

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

ExtensionManagementUtility::registerPageTSConfigFile(
    'extension_name',
    'Configuration/TsConfig/Page/myPageTSconfigFile.tsconfig',
    'My special config'
);

<?php

$GLOBALS['TCA']['pages']['columns']['tsconfig_includes']['config']['items'][] =
    [
        'LLL:EXT:my_sitepackage/Resources/Private/Language/locallang_db.xlf:pages.pageTSconfig.my_ext_be_layouts',
        'EXT:my_sitepackage/Configuration/TsConfig/Page/myPageTSconfigFile.tsconfig',
    ];

Set page TSconfig directly in the page properties¶

Go to the page properties of the page where you want to include the page TSconfig and open the tab Resources.

You can enter page TSconfig directly into the field Page TSconfig:

Page TSconfig inserted directly into the page properties is applied to the page itself and all its subpages.

Verify the final configuration¶

The full page TSconfig for any given page can be viewed using the module Page TSconfig with in the Site Management section.

Overriding and modifying values¶

Page TSconfig is loaded in the following order, the latter override the former:

1. Default page TSconfig that was set globally
2. Static page TSconfig that was included for a page tree.
3. Direct page TSconfig entered directly in the page properties.
4. User TSconfig overrides

Static and direct page TSconfig are loaded for the page they are set on and all their subpages.

The TypoScript syntax to modify values can also be used for the page TSconfig.

Example¶

Default page TSconfig

RTE.default.proc.allowTagsOutside = hr

Static page TSconfig included on the parent page

RTE.default.proc.allowTagsOutside := addToList(blockquote)

Finally you get the value "hr,blockquote".