itplusx/headless-gridelements

Grid Elements json output for EXT:headless

v3.0.0 2023-06-12 15:41 UTC

Requires

• php: ^7.4 || ^8.0
• friendsoftypo3/headless: ^3.0
• gridelementsteam/gridelements: ^11.0
• typo3/cms-core: ^11.5

Replaces

• typo3-ter/headless_gridelements: v3.0.0

MIT

• Ramón Schlosser

• extension
• headless
• typo3
• TYPO3 CMS
• Gridelements

README

This extension makes it possible to use EXT:gridelements with EXT:headless.

Installation

Installation with composer (recommended)

$ composer require itplusx/headless-gridelements

Installation with the TYPO3 Extension Manager

see: Extension Management

Requirements and compatibility

Usage

After a successful install just include the TypoScript of this package and you are ready to go.

NOTE:
Including the original Gridelements TypoScript might break the JSON output. Therefore it is not recommended to do so. The TypoScript of headless_gridelements is enough.

Example json output

{
  "id": 14,
  "pid": 8,
  "type": "structured_content",
  "colPos": 0,
  "categories": "",
  "appearance": {
    "layout": "default",
    "frameClass": "default",
    "spaceBefore": "",
    "spaceAfter": ""
  },
  "content": {
    "header": "",
    "subheader": "",
    "headerLayout": 0,
    "headerPosition": "",
    "headerLink": "",
    "structure": {
      "layout": "25-25-25-25",
      "rows": [
        {
          "columns": [
            {
              "config": {
                "name": "25%",
                "colPos": 401
              },
              "elements": [
                {"id": 123, "pid": 321, "type": "{CType}", ...},
                {...}
              ]
            },
            {
              "config": {
                "name": "25%",
                "colPos": 402
              },
              "elements": [
                {"id": 123, "pid": 321, "type": "{CType}", ...},
                {...}
              ]
            },
            {
              "config": {
                "name": "25%",
                "colPos": 403
              },
              "elements": [
                {"id": 123, "pid": 321, "type": "{CType}", ...},
                {...}
              ]
            },
            {
              "config": {
                "name": "25%",
                "colPos": 404
              },
              "elements": [
                {"id": 123, "pid": 321, "type": "{CType}", ...},
                {...}
              ]
            }
          ]
        }
      ]
    }
  }
}

Contribution

Any help on this project is very welcome! May it be as code contribution or just an idea for improvement. But we would like to ask you to follow some rules:

• Issues:
  When adding issues please always describe the bug/feature/task as detailed as possible. Only providing a title is not enough. Please use issue templates.
• Commits:
  Our team is following the Conventional Commits. We would like ask you stick to these rules whenever you want to contribute.
• Pull Requests:
  Before you submit a PR please create an issue first and link it to the pull request or at least add a PR description with detailed information about what this PR does. Otherwise we are not able to decide if this PR is worth going into the main branch.