Giter Club home page Giter Club logo

backendpreviews's Introduction

Nice Backend Previews for Content Elements in TYPO3

About this extension

This extension adds a hook for rendering content element previews for TYPO3's backend view in the page module, adding the ability to use Fluid Partials and Layouts to enable consistent preview markup.

Installation

Use composer to add this content element to your project

composer require b13/backendpreviews

and install the extension using the Extension Manager in your TYPO3 backend.

Add configuration

Add this to your PageTsConfig to include the default Fluid Templates provided with this extension:

@import 'EXT:backendpreviews/Configuration/PageTs/PageTs.tsconfig'

You can add your own paths to the setup using PageTsConfig in your own site-extension:

mod.web_layout.tt_content.preview.view {
  layoutRootPaths.10 = EXT:site_example/Resources/Private/Contenttypes/Backend/Layouts
  partialRootPaths.10 = EXT:site_example/Resources/Private/Contenttypes/Backend/Partials
  templateRootPaths.10 = EXT:site_example/Resources/Private/Contenttypes/Backend/Templates
}

By default, we will try to find a template to render a preview based on the CType of the element, meaning for CType mytype we will try to find a template named Mytype.html in one of the paths defined in the templateRootPaths-Array.

You can set a different templateName explicitly like this:

mod.web_layout.tt_content.preview.template.mytype = Myowntemplate

For plugins a template name for a specific plugin can be specified like this:

mod.web_layout.tt_content.preview.template.list.mylist_type = Listtypetemplate

All flexform data of the plugin are available in {pi_flexform_transformed} to create meaningful previews:

<b>Page:</b> {pi_flexform_transformed.settings.page}

Use custom backend previews for default CTypes

Default CTypes for fluid_styled_content define dedicated previewRenderer classes. If you want to use EXT:backendpreviews instead, remove the configuration for each of these CTypes in your extension's ext_localconf.php:

unset($GLOBALS['TCA']['tt_content']['types']['textpic']['previewRenderer']);

License

As TYPO3 Core, backendpreviews is licensed under GPL2 or later. See the LICENSE file for more details.

Background, Authors & Further Maintenance

EXT:backendpreviews was initially created by David Steeb in 2021 for b13, Stuttgart. We use this as a basis to add consistent previews for our custom content element types.

Find more TYPO3 extensions we have developed that help us deliver value in client projects. As part of the way we work, we focus on testing and best practices to ensure long-term performance, reliability, and results in all our code.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.