friendsoftypo3headless/headless-bootstrap-package

This extension provides integration with bootstrap_package to output content from TYPO3 in JSON format.

v2.0.0 2023-01-11 13:55 UTC

This package is auto-updated.

Last update: 2023-05-11 14:44:17 UTC


README

SWUbanner

StandWithUkraine TYPO3 11 CI Status Code Coverage Badge Total Downloads Latest Stable Version License PHP Version Require

TYPO3 Extension "headless_bootstrap_package" - Provides TypoScript definitions for proper JSON output from EXT:bootstrap_package content elements and configuration

This extension provides integration for EXT:bootstrap_package with EXT:headless.

It provides TypoScript rendering definitions for all of EXT:bootstrap_packages ContentElements to output them as proper JSON.

Requirements

This Extension requires:

Compatibility

The following table shows the compatibilty of this extension to the respective EXT:bootstrap_package versions.

BP 13.x BP 12.x
v2.x ✔️
v1.x ✔️

TYPO3 Installation

Install extension using composer
composer require friendsoftypo3headless/headless-bootstrap-package

and then, include TypoScript template, and you are ready to go.

Important: Do NOT include the Setup/Constants provided by EXT: bootstrap_package since they would interfere with the EXT:headless page config.

Instead please include the provided "Headless Boostrap Package: Boostrap Package Constants" TypoScript config in order to gain access to the EXT: bootstrap_package constants.

This extension adds a "bootstrapPackage" key to every JSON page reponse containing the EXT:bootstrap_package constants/config: BootstrapPackageConstants

It also merges the page.meta constants into the page.meta JSON array: pageMetaData

Testing

This Extension comes with a phpunit testsuite with functional tests for all content elements.
To run the tests simply use the provided composer script:

composer ci:test

Credits

A special thanks goes to TRIXIE Heimtierbedarf GmbH & Co. KG, which is sponsoring development of this extension.

Developers involved in the project