kcesys/laravel-inertia-genealogy

Laravel bridge for KCESYS Genealogy library with Inertia support

dev-main 2025-12-15 17:34 UTC

Requires

• php: ^8.1
• illuminate/support: ^10.0|^11.0|^12.0
• kcesys/php-genealogy: *

MIT

• KCESYS

README

A Laravel bridge for kcesys/php-genealogy designed for seamless integration with Inertia.js.

Installation

composer require kcesys/laravel-inertia-genealogy

Features

• Fluent Helper: Genealogy::for($data) wrapper.
• Inertia Integration: share() method to automatically inject props.
• Auto-Discovery: Automatically transforms Eloquent Models.

Usage

In your Controller:

use KCESYS\LaravelGenealogy\Genealogy;
use App\Models\User;
use Inertia\Inertia;

public function index()
{
    $family = User::with('parents', 'children')->get();

    // Option 1: Pass as Prop
    return Inertia::render('MyTree', [
        'graph' => Genealogy::for($family)->toGraph([
             'label' => 'full_name', // Map 'label' to 'full_name' attribute
             'spouses' => fn($u) => $u->partners->pluck('id') // Custom relationship mapping
        ])
    ]);
}

Sharing Globally

If you want the genealogy data available on every page (e.g. for a sidebar widget):

// In HandleInertiaRequests Middleware
public function share(Request $request)
{
    return array_merge(parent::share($request), [
        'genealogy' => fn() => Genealogy::for($request->user()->family)->toGraph()
    ]);
}