Weave Code
Newsticker Bundle Laravel Package
pdir/newsticker-bundle
A lightweight bundle for adding a configurable news ticker to your application. Display rotating headlines, announcements, or updates through templates and simple settings, making it easy to surface timely content without custom frontend code.
newsticker bundle for Contao Open Source CMS
Frequently asked questions about Newsticker Bundle
- What is pdir/newsticker-bundle used for?
- It is a Symfony bundle that adds a lightweight, configurable news ticker to your application so you can surface rotating headlines, announcements, or site notices. Content and display options come from bundle configuration, and the output is rendered through Twig templates. It is intended for simple setup with predictable rendering, without writing custom frontend JavaScript.
- How do I install pdir/newsticker-bundle with Composer?
- Install it with composer require pdir/newsticker-bundle from your project root. If you are not using Symfony Flex, enable the bundle in your bundles.php or Kernel registration. Because the package has minimal dependencies, the install normally completes without extra setup, but you should still check the Symfony and PHP constraints listed in its composer.json before committing.
- How do I display the news ticker in a Twig template?
- The bundle is Twig-ready, so you embed the ticker by including the template it ships or by calling the Twig helper it exposes, then passing in your configured content. The exact template path or function name is documented in the bundle README for your installed version. Keep the block in a shared layout partial if you want the ticker visible across multiple pages.
- How do I configure the ticker content and display options?
- Configuration lives in your Symfony config directory, typically under config/packages, where you define the ticker content and display options. Since the bundle is designed around bundle configuration, you can keep headlines in config files or feed them into the template from a controller. Clear the Symfony cache after changing configuration so the new settings take effect.
- Does pdir/newsticker-bundle work with Laravel?
- No. This is a Symfony bundle built on Symfony's bundle registration and configuration system, so it does not ship a Laravel service provider, facade, or publishable Laravel config. In a Laravel application you would be better served by a Laravel-specific ticker package or a plain JavaScript ticker component. Mixing Symfony bundles into Laravel is not a supported or practical path here.
- Which Symfony and PHP versions does this news ticker bundle support?
- Supported versions are declared in the package's composer.json, so check the require section for the exact Symfony and PHP constraints before installing or upgrading. Because the implementation is lightweight with minimal dependencies, it generally adapts easily to current Symfony releases. If you are on an older Symfony version, verify compatibility first, since bundles are not always backported.
- Can I show more than one headline or multiple tickers on a page?
- The ticker content is configurable, so you can list several headlines, announcements, or notices and let the ticker rotate through them. Running two independent ticker instances on the same page may require rendering the template twice with different content, so check the README for the exact mechanism. If you need per-instance settings, keep the configuration separate and pass values into the template.
- Can I customize the ticker markup and styling to match my site?
- Yes. Because rendering happens in Twig, you can override the bundle's template and add your own CSS classes to match your design system. The lightweight implementation means there is little markup to fight against, and the bundle is described as easy to extend or adapt to project-specific needs. Overriding templates is the recommended approach rather than editing files inside vendor.
- How do I test that the news ticker renders correctly?
- Write a functional test that requests a route or renders the template containing the ticker, then assert that your configured headlines appear in the response. Clear the test environment cache first so configuration changes are picked up. For content coming from config, keep a fixture config for tests so assertions are stable and not tied to production headlines.
- Is pdir/newsticker-bundle production-ready, and what are the alternatives?
- It is a small, low-dependency bundle aimed at straightforward production use, and its config-driven rendering keeps overhead minimal. Review the GitHub repository's recent commits and open issues to judge maintenance activity before adopting it long term. Alternatives include pure JavaScript ticker libraries, a custom Twig partial with CSS animations, or Laravel-specific packages if you are not on Symfony.
Weaver
How can I help you explore Laravel packages today?