Ai Client Html Laravel Package

Getting Started

Install the package via Composer: composer require aimeos/ai-client-html. Ensure aimeos/aimeos-laravel is also installed, as this package is tightly coupled to Aimeos core. After installation, run php artisan vendor:publish --provider="Aimeos\AiClientHtml\Provider" to publish config and views. Begin with embedding a mini basket on any page: {{ \Aimeos\Facades\Aimeos::get('basket/mini')->get() }}. For your first meaningful use case, render a product list on the homepage using @aimeos('product/list', $items) where $items is a collection of Aimeos product items—this immediately delivers responsive, SEO-ready markup.

Implementation Patterns

Prefer Blade directives over the facade for cleaner syntax: @aimeos('catalog/tree'), @aimeos('basket/standard'), and @aimeos('checkout/standard') map directly to full-page components. Use Aimeos\Shop\Base\Page in controllers to compose complex pages (e.g., homepage = hero + navigation + product list + testimonials) while reusing context (locale, currency, customer group) across components. Extend functionality by overriding partials—copy resources/views/vendor/aimeos/product/list-slide.php to your local resources/views/vendor/aimeos/ and modify without touching vendor code. For advanced use, combine with JSON API endpoints: serve static landing pages with HTML clients and dynamic cart interactions via /jsonapi.

Gotchas and Tips

• View caching trap: Laravel’s view cache doesn’t reflect Aimeos’ internal template partial changes—always run php artisan view:clear after overriding templates.
• Debug partial rendering: Enable 'client/html' => ['debug' => true] in config/aimeos.php to inject HTML comments marking which partials render and in what order—essential for diagnosing missing or misrendered sections.
• Locale mismatch: Aimeos uses en, de, etc., not en-US. If config(app.locale) is en_US, force match via Aimeos\Shop\Base\Page::setLocale('en') in middleware or before rendering.
• Template inheritance over direct overrides: Instead of copying entire templates (e.g., product/list-standard.php), extend via partials (list-slide.php, list-item.php) to survive upgrades.
• Avoid business logic in Blade: Move logic like basket totals or inventory checks into custom frontend controllers (Aimeos\Controller\Frontend::create($context, 'basket'))—Blade should only render, not compute.
• Bootstrap conflicts: Aimeos assumes Bootstrap 4/5. To use Tailwind or custom themes, override the CSS classes in config/aimeos.php or publish and replace core template files with custom markup.