Download the PHP package 4viewture/headless-menu without Composer
On this page you can find all versions of the php package 4viewture/headless-menu. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download 4viewture/headless-menu
More information about 4viewture/headless-menu
Files in 4viewture/headless-menu
Package headless-menu
Short Description Menu via json for TYPO3, might be used in Webcomponents and to speed up page generation
License GPL-2.0+
Homepage https://www.4viewture.de
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package headless-menu
Headless Menu for TYPO3
This TYPO3 extension provides a JSON endpoint for generating menus. It is particularly useful for Webcomponents or headless frontend integrations where you need a slim, JSON-based representation of your page navigation.
Features
- Generates a menu as JSON.
- Custom
WhitelistMenuFieldsProcessorto filter exactly which fields are exposed in the JSON output. - Configurable menu depth and field selection via TypoScript.
- Lightweight and cacheable via TYPO3's native page caching.
Installation
Install via composer:
Then, include the TypoScript template in your TYPO3 site configuration.
Usage
JSON Endpoint
The extension provides a new page type. You can access the menu JSON by appending type=1770960021 to your URL:
By default, the menu is only generated for the site's root page (site("rootPageId")) to prevent unnecessary cache entries for every single page.
This extension is compatible with TYPO3 v12, v13, and v14 as it uses modern TypoScript conditions.
Output example
With the standard configuration, the output will look like this:
TypoScript Configuration
The following TypoScript constants are available to customize the menu output:
| Constant | Default Value | Description |
|---|---|---|
lib.tx_headlessmenu.menu.level |
7 |
How many levels deep the menu should be generated. |
lib.tx_headlessmenu.menu.fields |
title,link,target,children |
Main fields to include for each menu item. |
lib.tx_headlessmenu.menu.dataFields |
uid,slug,nav_title |
Specific fields from the raw record to include in the data section. |
lib.tx_headlessmenu.menu.childrenKey |
children |
The key used for nesting child menu items. |
lib.tx_headlessmenu.menu.header.allowOrigin |
(empty) | Define Access-Control-Allow-Origin header. |
lib.tx_headlessmenu.menu.page.typeNum |
1770960021 |
The typeNum used for the JSON endpoint. |
CORS Support
You can enable CORS by setting the lib.tx_headlessmenu.menu.header.allowOrigin constant. If set, it will also add Access-Control-Allow-Methods: GET, OPTIONS.
Data Processor
The extension includes a custom DataProcessor: FourViewture\HeadlessMenu\DataProcessing\WhitelistMenuFieldsProcessor.
It can be used in your own Fluid templates or TypoScript to filter menu arrays:
Authors
- Kay Strobach - 4viewture
License
This project is licensed under the GPL-2.0+ License.
