friendsoftypo3headless / headless-bootstrap-package
This extension provides integration with bootstrap_package to output content from TYPO3 in JSON format.
Fund package maintenance!
www.paypal.me/hardanders
www.paypal.me/derseeli
Installs: 885
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 0
Type:typo3-cms-extension
Requires
- php: ^8.1
- bk2k/bootstrap-package: ^13.0 || ^14.0
- friendsoftypo3/headless: ^4.2
- typo3/cms-core: ^12.4
Requires (Dev)
- ext-json: *
- ergebnis/composer-normalize: ^2.15.0
- friendsofphp/php-cs-fixer: ^3.1
- helmich/typo3-typoscript-lint: ^3.0
- justinrainbow/json-schema: ^5.2
- phpspec/prophecy-phpunit: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan: ^1.9.2
- phpunit/phpcov: ^8.2
- saschaegerer/phpstan-typo3: ^1.8.2
- typo3/coding-standards: ^0.5.0
- typo3/testing-framework: ^7
README
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:
- TYPO3 in version at least 11.5
- EXT:headless in version at least 3.0.3
- EXT:bk2k/bootstrap-package in version at least 12.0
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:
It also merges the page.meta constants into the page.meta JSON array:
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.