Hinclude Laravel Package

Product Decisions This Supports

• Feature Expansion for Web Apps: Enables declarative, client-side inclusion of external resources (e.g., partials, widgets, or third-party content) without full-page reloads, reducing latency and improving UX.
• Modular Architecture: Supports a "composable" UI strategy by allowing teams to build reusable components (e.g., headers, footers, or dynamic ads) that can be included across pages via simple markup.
• Build vs. Buy: Avoids reinventing client-side inclusion logic (e.g., custom AJAX or iframe solutions) while offering more flexibility than server-side templating (e.g., Laravel Blade @include).
• Use Cases:
  • Progressive Enhancement: Gradually add dynamic content (e.g., comments, recommendations) without blocking render.
  • Third-Party Integrations: Safely embed external services (e.g., analytics, chat widgets) with fallback logic.
  • A/B Testing: Dynamically swap included components (e.g., hero banners) without redeploying templates.
  • Multi-Tenant Apps: Serve tenant-specific partials (e.g., localized headers) via declarative includes.

When to Consider This Package

• Adopt if:
  • Your app relies on client-side modularity (e.g., SPAs with server-rendered fallbacks) or declarative UI composition.
  • You need lightweight, standards-based inclusion (uses HTML <link rel="hinclude"> and JavaScript) without heavy frameworks (e.g., React, Vue).
  • Your team prioritizes separation of concerns (e.g., frontend teams managing includes independently of backend templates).
  • You require fallback support (e.g., graceful degradation if JavaScript fails).
• Look Elsewhere if:
  • You’re building a fully client-side rendered app (consider React/Vue’s component model instead).
  • Your use case demands real-time updates (WebSockets or SSR frameworks like Next.js may be better).
  • You need server-side inclusion (Laravel’s @include or PHP’s include() suffice).
  • Your stack is non-PHP (e.g., Node.js, Ruby) and you lack a PHP runtime for preprocessing.

How to Pitch It (Stakeholders)

For Executives: "This package lets us build faster, more modular web apps by declaratively including external content (like widgets or partials) without full-page reloads. Think of it as ‘copy-paste for the web’—teams can assemble pages dynamically, reducing dev time and improving performance. It’s lightweight, standards-based, and plays well with our Laravel stack, enabling use cases like A/B testing or third-party integrations without reinventing the wheel."

For Engineering: *"mnot/hinclude gives us a client-side inclusion system that’s simpler than custom AJAX solutions but more flexible than server-side templating. Key benefits:

• Declarative: Add includes via HTML attributes (e.g., <div hinclude="partials/header.html">).
• Progressive: Works with or without JavaScript (fallbacks included).
• Performance: Reduces payload size by lazy-loading components.
• Integration: Plays nicely with Laravel’s asset pipeline and Blade templates. Use it for reusable components, dynamic content, or embedding external services—just avoid it for real-time apps or full SPAs."*

For Design/Systems: "This enables component-driven design at scale. Designers can define reusable UI blocks (e.g., cards, modals) as ‘includeable’ assets, while developers manage their inclusion logic. It’s a middle ground between rigid server-side templates and monolithic frontend frameworks."