Weave Code
Sidebar Laravel Package
typicms/sidebar
A Laravel/PHP package for TypiCMS that adds sidebar management, enabling editors to create, organize, and render reusable sidebar content or widgets within CMS themes through the admin interface.
At a glance
Frequently asked questions about Sidebar
- What is typicms/sidebar used for?
- TypiCMS Sidebar adds a configurable sidebar to the TypiCMS content management system, which is itself built on Laravel. It gives editors an admin interface for creating and ordering sidebar content, and gives developers a simple way to output that content in Blade templates. It is best thought of as a TypiCMS extension rather than a general-purpose widget package.
- Does typicms/sidebar work with plain Laravel, or only with TypiCMS?
- It is designed specifically for TypiCMS, so it expects the CMS to be installed and configured inside your Laravel application. In a plain Laravel project without TypiCMS there is no admin integration for it to hook into, so a generic menu or widget package would suit you better. Use it when your project already runs TypiCMS and you need a managed sidebar.
- How do I install typicms/sidebar with Composer?
- Install it through Composer by requiring typicms/sidebar in your TypiCMS application. Because the package builds on TypiCMS conventions, make sure the CMS and its dependencies are already installed and working first. After installation, the sidebar management screens become available inside the TypiCMS admin interface.
- How do I render a sidebar in a Blade template?
- You render the sidebar from your TypiCMS theme's Blade templates, which keeps sidebar configuration separate from the main page content. The exact syntax depends on your theme and on the content blocks you configure in the admin. This separation means editors can change sidebar content without touching page bodies or template code.
- Can editors order and reorder sidebar items from the admin?
- Yes, managing and ordering sidebar items is one of the package's core features. Editors can add content blocks and arrange them into the order they want displayed. That ordering is then reflected wherever the sidebar is rendered in your Blade templates.
- Are sidebar content blocks configurable?
- The package supports configurable content blocks, so the sidebar is not limited to one hard-coded list of links. You define the blocks editors can manage, and they fill them in through the admin interface. The rendered output stays in your theme's Blade templates, which keeps presentation under developer control.
- Which Laravel versions does typicms/sidebar support?
- Version support follows TypiCMS itself, so the Laravel version you can use depends on the TypiCMS release your application runs. Check the package's composer.json constraints and the TypiCMS documentation before upgrading Laravel. Pinning compatible versions in Composer is the safest approach.
- How should I test sidebar rendering in my application?
- Keep the sidebar rendering in Blade partials so you can assert on the rendered output in feature tests. You can create sidebar content through your models or admin flows, then make a request that renders the theme. If your test suite does not boot TypiCMS, test the underlying content and ordering logic separately.
- Is typicms/sidebar maintained and safe to use in production?
- Maintenance is tied to the TypiCMS project, so check the repository's recent commits, releases, and open issues before adopting it. Because it is a small, focused package, the surface area to audit is limited. Confirm that the version you install matches your TypiCMS and Laravel versions before deploying to production.
- What are the alternatives to typicms/sidebar for adding a sidebar in Laravel?
- Alternatives depend on what you need: a general Laravel menu or widget package, a page-builder field, or custom Blade partials backed by your own models. Those options work in any Laravel application, whereas typicms/sidebar is specifically integrated with the TypiCMS admin. If you are already running TypiCMS, the built-in admin integration is usually the simplest path.
Weaver
How can I help you explore Laravel packages today?