Skip to content

contao-thememanager/core

Repository files navigation

ContaoThemeManager

Contao ThemeManager: A lightweight forward-thinking CSS component-first-framework leveraging flexbox and custom properties

Oveleon

Read the Docs


Support

If you like this extension, we'd love your support in keeping the open-source spirit alive.

If you think this plugin is useful, please consider sponsoring us to help contribute to our time invested and to further development of this and other open source projects.

Your contributions, whether through coding, testing, providing feedback, or even a donation, help ensure that we can continue offering free open source software. Join us in making a difference, and thank you for your support! - Oveleon.


Working with Contao 4.13 and Contao ^5.3 (PHP ^8.1)


About

Built with a focus on customization, efficiency, and adherence to industry best practices, the Contao ThemeManager offers a fully configurable system eliminating the need for knowing or writing CSS. Features include an integrated scssphp-based asset compiler, CSS versioning, dynamic CSS background image generation, icon font management, an array of new content elements and much more.

With comprehensive customization options via the backend, it's the technical cornerstone for crafting modern, responsive web experiences with Contao.

Table of contents

Features

  • Lightweight (~55.8 kB (minified), ~11.4 kB (gzipped))
  • Grid-System (based on Flexbox)
  • Working with Contao 4.13 and Contao ^5.3
  • In-built SCSS and asset compiler (based on scssphp)
  • Fully customizable CSS framework configuration in the Contao Backend
  • Default styles and layout for almost every Contao component
  • Fully customizable contao components using the Contao Component StyleManager
  • Extended Headline configuration
  • Enhancing Contao standard components (Table, gallery, news and more)
  • New content elements (wrappers, text- / image- / icon- / list-components)
  • Create CSS backgrounds within the filesystem
  • Changing and integrating icon-fonts easily
  • Dynamically generated StyleManager options
  • and more ...

Tools

  • Backend configuration for SCSS-variables πŸ”—
  • Asset-Compiler for generating and renewing CSS-Files from the theme configuration πŸ”—
  • Styles and component configuration using the StyleManager πŸ”—
  • Custom scss-file integration to customize whole websites using this framework

Installation

Upgrading to version 2

An upgrade from Contao ThemeManager v1.* to v2.* is not recommended

Via composer

composer require contao-thememanager/core

Via contao-manager

Search for 'Contao ThemeManager Core' and add it to your extensions.

After installing the Contao ThemeManager Core, you need to run the pending schema updates.

Documentation

A german documentation (WIP - work in progress) can be found by using the following link: Documentation

Bugs and feature requests

We appreciate your contributions when opening issues or requesting features. To help keep our issue list tidy, we may need to close issues if questions go unanswered.

Bugs

If you think you have found a bug please follow these guidelines

  1. Search for existing issues and check if your problem has already been reported
  2. Check if you are using the latest version and if the issue has been fixed already
  3. Provide a step-by-step tutorial on how to reproduce the issue in an isolated environment using only the Contao ThemeManager Core

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Extensions / Addons

  • Slider (Tiny Slider) πŸ”—
  • Recommendation (Contao Recommendation) πŸ”—
  • ...

Further Links

License

This project is licensed under the AGPL-3.0 License

Sponsoring

If you find this plugin useful, please consider sponsoring us to help contribute to our time invested and to further development of this and other open source projects. Thank you for your support! - Oveleon.