README

📌 About

This Contao bundle adds a teaser image field to articles (tl_article) in Contao CMS.
You can use it to display featured images for articles in both the backend and frontend.

🚀 Installation

1. Install via Composer

Run the following command in your Contao installation directory:

composer require whiterabbitstudiosch/contao-article-teaser-image

2. Clear the Cache

After installation, clear the Contao cache:

vendor/bin/contao-console cache:clear

3. Run Database Migration

Apply the database changes:

vendor/bin/contao-console contao:migrate

4. Update Contao Manager (Optional)

If you use Contao Manager, update your package list:

Open Contao Manager.
Click "Update Packages" to fetch the latest version.

🛠 Usage

1. Assign a Teaser Image to an Article

Go to Content > Articles in the Contao backend.
Edit an article and find the "Teaser Image" field.
Upload or select an image from the file manager.

2. Display Teaser Image in a Template

To display the teaser image in your frontend templates, use the following code:

<?php if ($this->article_teaser_image): ?>
    <figure>
        <img src="<?= \Contao\FilesModel::findByUuid($this->article_teaser_image)->path ?>" alt="<?= $this->headline ?>">
    </figure>
<?php endif; ?>

Place this snippet in your mod_article.html5 template or a custom module.

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.

🤝 Contributing

Contributions are welcome!
Feel free to submit issues, feature requests, or pull requests on GitHub.

📬 Support

For any questions or feedback, please contact White Rabbit Studios:
📧 mail@whiterabbitstudios.ch

Made with ❤️ by White Rabbit Studios

whiterabbitstudiosch / contao-article-teaser-image

Maintainers

Details