Filament NestedSet

https://github.com/wsmallnews/filament-nestedset
Admin
Filament NestedSet is a Laravel Filament plugin that provides elegant nested set tree building...
Tokens:9,004
Snippets:70
Trust Score:6.8
License:MIT
Update:7 months ago
Show doc for...
Tokens:
Raw
### Install and Configure Filament NestedSet

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Commands to install the package via Composer and publish necessary assets including configuration, views, and translations. These commands prepare the environment for managing nested set data structures.

```bash
composer require wsmallnews/filament-nestedset:^2.0
php artisan vendor:publish --tag="sn-filament-nestedset-config"
php artisan vendor:publish --tag="sn-filament-nestedset-views"
php artisan vendor:publish --tag="sn-filament-nestedset-translations"
```

--------------------------------

### Create Custom Nestedset Page in PHP

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

Demonstrates how to extend the `NestedsetPage` class to create a custom page for managing a nested set structure. It covers essential configurations like model, title attribute, and optional settings for depth, labels, and UI elements. This example shows how to define schemas for general, create, and edit forms, as well as infolist details and tabbed filtering.

```php
<?php

namespace App\Filament\Pages;

use App\Models\Category;
use Filament\Forms\Components\Textarea;
use Filament\Forms\Components\TextInput;
use Filament\Infolists\Components\TextEntry;
use Filament\Resources\Components\Tab;
use Filament\Support\Enums\Alignment;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\HtmlString;
use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class CategoryTree extends NestedsetPage
{
    // Required: Model class for the nested set
    protected static ?string $model = Category::class;

    // Required: Attribute used to display node labels
    protected static string $recordTitleAttribute = 'name';

    // Optional: Limit tree depth (null = unlimited)
    protected static ?int $level = 3;

    // Optional: Custom labels
    protected static ?string $modelLabel = 'Category';
    protected static ?string $pluralModelLabel = 'Categories';
    protected static ?string $title = 'Category Management';
    protected static ?string $navigationLabel = 'Categories';
    protected static ?string $navigationGroup = 'Content';
    protected static ?string $slug = 'categories';
    protected static ?int $navigationSort = 1;

    // Optional: Empty state message
    protected static ?string $emptyLabel = 'No categories found';

    // Optional: Disable multi-tenancy scoping
    protected static bool $isScopedToTenant = true;

    // Optional: Infolist display settings
    protected static Alignment $infolistAlignment = Alignment::Right;
    protected static string $infolistHiddenEndpoint = 'md';

    // Optional: Tab field for categorization
    protected static ?string $tabFieldName = 'type';

    /**
     * Define form schema for both create and edit actions.
     * Use this when create and edit forms are identical.
     */
    protected function schema(array $arguments): array
    {
        return [
            TextInput::make('name')
                ->label('Category Name')
                ->required()
                ->maxLength(255),
            TextInput::make('slug')
                ->label('Slug')
                ->required()
                ->unique(ignoreRecord: true),
            Textarea::make('description')
                ->label('Description')
                ->rows(3),
        ];
    }

    /**
     * Define create-specific form schema.
     * Overrides schema() for create action only.
     */
    protected function createSchema(array $arguments): array
    {
        return [
            TextInput::make('name')
                ->label('Category Name')
                ->required()
                ->live(onBlur: true)
                ->afterStateUpdated(fn ($set, $state) => $set('slug', str($state)->slug())),
            TextInput::make('slug')
                ->label('Slug')
                ->required(),
        ];
    }

    /**
     * Define edit-specific form schema.
     * Overrides schema() for edit action only.
     */
    protected function editSchema(array $arguments): array
    {
        return [
            TextInput::make('name')
                ->label('Category Name')
                ->required(),
            TextInput::make('slug')
                ->label('Slug')
                ->required()
                ->disabled(),
            Textarea::make('description')
                ->label('Description'),
        ];
    }

    /**
     * Define additional attributes displayed in each tree row.
     * Returns Filament infolist components.
     */
    protected function infolistSchema(): array
    {
        return [
            TextEntry::make('slug')
                ->label('Slug')
                ->badge(),
            TextEntry::make('created_at')
                ->label('Created')
                ->dateTime('M d, Y'),
        ];
    }

    /**
     * Customize node label display (supports HtmlString).
     */
    public function getRecordLabel(Model $record): HtmlString|string
    {
        $icon = $record->isRoot() ? '📁' : '📄';
        return "{$icon} {$record->name}";
    }

    /**
     * Define tabs for filtering tree data.
     * Each tab creates a separate scoped tree view.
     */
    public function getTabs(): array
    {
        return [
            'products' => Tab::make()->label('Product Categories'),
            'blog' => Tab::make()->label('Blog Categories'),
            'pages' => Tab::make()->label('Page Categories'),
        ];
    }

    /**
     * Add additional scope parameters for kalnoy/nestedset scoping.
     */
    public function nestedScoped(): array
    {
        return ['status' => 'active'];
    }

    /**
     * Add custom Eloquent query conditions.
     */
    // public function getEloquentQuery(): Builder
    // {
    //     return parent::getEloquentQuery()->where('is_published', true);
    // }
}

```

--------------------------------

### Install Filament NestedSet via Composer

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

Use Composer to add the Filament NestedSet package to your Laravel project. This command fetches the latest compatible version for Filament v4 or v5.

```bash
composer require wsmallnews/filament-nestedset:^2.0
```

--------------------------------

### Run Database Migrations

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This command executes all pending database migrations, including those that add the nested set fields to your tables.

```bash
php artisan migrate
```

--------------------------------

### Configure Custom Theme Assets

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Instructions for disabling automatic asset loading and manually importing the package CSS into a Filament custom theme.

```php
return [
    ...
    
    'autoload_assets' => false,
];
```

```css
@import '../../../../vendor/wsmallnews/filament-nestedset/resources/css/index.css';
```

--------------------------------

### Prepare Eloquent Model with NodeTrait

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This snippet shows how to prepare an Eloquent model for use with the nestedset package by using the NodeTrait. Ensure your model extends Eloquent's Model and uses the NodeTrait.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Kalnoy\Nestedset\NodeTrait;

class YouModel extends Model
{
    use NodeTrait;

    ...

}
```

--------------------------------

### Enable Multi-tenancy Support (PHP)

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Configure multi-tenancy support by implementing the getScopeAttributes method in your model to include the 'team_id' field. This ensures data is scoped to the current tenant.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
...

class YouModel extends Model
{
    ...

    public function getScopeAttributes(): array
    {
        return ['team_id', ...];
    }

    ...
}
```

--------------------------------

### Scaffold Nested Set Pages via Artisan

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

Generate boilerplate code for nested set management pages using the provided Artisan command. Supports interactive prompts or direct arguments for model and panel specification.

```bash
# Interactive mode
php artisan make:filament-nestedset-page

# Direct creation
php artisan make:filament-nestedset-page CategoryTree Category --panel=admin
```

--------------------------------

### Publish Filament Nestedset Assets via Artisan

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

These commands publish the package's configuration, views, and translation files to your project. This allows for customization of the package's behavior and appearance.

```bash
# Publish configuration file
php artisan vendor:publish --tag="sn-filament-nestedset-config"

# Publish view files for customization
php artisan vendor:publish --tag="sn-filament-nestedset-views"

# Publish translation files for multi-language support
php artisan vendor:publish --tag="sn-filament-nestedset-translations"

# Publish stub files for command customization
php artisan vendor:publish --tag="filament-nestedset-stubs"

```

--------------------------------

### Create Filament Nestedset Page

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This command generates a new Filament page specifically designed for managing nested set data. It scaffolds the necessary files for the page.

```bash
php artisan make:filament-nestedset-page
```

--------------------------------

### Configure Filament NestedSet Settings

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

The configuration file allows customization of deletion rules, UI behavior, and asset loading. Publish this file to manage how parent and root nodes are handled within the Filament admin panel.

```php
<?php

// config/sn-filament-nestedset.php
return [
    'allow_delete_parent' => false,
    'allow_delete_root' => false,
    'create_action_modal_show_parent_select' => true,
    'show_create_child_node_action_in_row' => true,
    'autoload_assets' => true,
];
```

--------------------------------

### Configure NestedSet Plugin Settings

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

The configuration file allows developers to define constraints such as preventing the deletion of parent nodes or root nodes, toggling the parent select field in modals, and managing asset loading.

```php
return [
    /**
     * Restrict deletion of nodes with children
     */
    'allow_delete_parent' => false,

    /*
     * Restrict deletion of root nodes, even if 'allow_delete_parent' is true, root nodes can be deleted.
     */
    'allow_delete_root' => false,

    /**
     * create action show parent select field
     */
    'create_action_modal_show_parent_select' => true,

    /**
     * Display the "Create Child Node" action in each row (if 'create_action_modal_show_parent_select' is false, This field should be set to true)
     */
    'show_create_child_node_action_in_row' => true,

    /**
     * By default, the CSS file will be automatically loaded globally. If you use a filament custom theme, you can disable the automatic loading of the CSS file
     */
    'autoload_assets' => true,
];
```

--------------------------------

### Customize Nestedset Component Logic

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Demonstrates how to extend the Nestedset class to customize record labels, active states, click event handling, and URL generation for nodes.

```php
namespace App\Livewire\Components;

use App\Models\Category;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\HtmlString;
use Livewire\Attributes\On;
use Wsmallnews\FilamentNestedset\Livewire\Components\Nestedset;

use function Filament\Support\generate_href_html;

class Categories extends Nestedset
{
    public function getRecordLabel(Model $record): HtmlString | string
    {
        return $record->name_label;
    }

    public function getHasActive(Model $record): bool
    {
        return $record->has_active;
    }

    #[On('sn-filament-nestedset-leaf-click')]
    public function clickCategory($recordId)
    {
        $this->categoryId = $recordId;
    }

    public function getRecordUrl(Model $record): string | HtmlString | null
    {
        return generate_href_html(route('categories.show', $record->id), false);
    }

    public function getNestedset()
    {
        return Category::normal()->defaultOrder()
            ->get()->toTree();
    }
}
```

--------------------------------

### Configure Multi-Tenancy for Navigation Model

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

This PHP code configures the `Navigation` model to support multi-tenancy by defining scope attributes. It ensures that tree data is automatically scoped to the current tenant via the `team_id`.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Kalnoy\Nestedset\NodeTrait;

class Navigation extends Model
{
    use NodeTrait;

    protected $fillable = ['name', 'url', 'team_id', 'type'];

    /**
     * Define scope attributes for multi-tenancy.
     * Include team_id for automatic tenant filtering.
     */
    public function getScopeAttributes(): array
    {
        return ['team_id', 'type'];
    }

    public function team(): BelongsTo
    {
        return $this->belongsTo(Team::class);
    }
}

```

--------------------------------

### Configure Tabs Support (PHP)

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Implement tabbed navigation for your nestedset data by defining a $tabFieldName and the getTabs method. This integrates with the 'kalnoy/nestedset' scoping feature.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    protected static ?string $tabFieldName = 'type';

    public function getTabs(): array
    {
        return [
            'web' => Tab::make()->label('Website Navigation'),
            'shop' => Tab::make()->label('Shop Navigation')
        ];
    }

    ...
}
```

--------------------------------

### Customize Eloquent Query for Nested Sets

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

Demonstrates how to override the Eloquent query to filter nodes by visibility and implement dynamic level restrictions based on user roles. This approach ensures that data access is restricted according to business logic.

```php
public function getEloquentQuery($query)
{
    return $query->where('is_visible', true);
}

/**
 * Dynamic level calculation.
 */
public function getLevel(): ?int
{
    // Allow deeper nesting for admins
    return auth()->user()?->is_admin ? null : 3;
}
```

--------------------------------

### Define Separate Schemas for Create and Edit in Nestedset Page

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This demonstrates how to define distinct form schemas for creating new nodes and editing existing ones. Implement `createSchema` and `editSchema` methods separately.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    protected function createSchema(array $arguments): array
    {
        return [
            //
        ];
    }
    protected function editSchema(array $arguments): array
    {
        return [
            //
        ];
    }

    ...

}
```

--------------------------------

### Enable Tenant Scoping in Filament Navigation Manager Page

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

This PHP code extends the `NestedsetPage` to create a `NavigationManager` in Filament. It explicitly enables tenant scoping for the navigation tree by setting `static $isScopedToTenant = true;`.

```php
<?php

namespace App\Filament\Pages;

use App\Models\Navigation;
use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class NavigationManager extends NestedsetPage
{
    protected static ?string $model = Navigation::class;
    protected static string $recordTitleAttribute = 'name';

    // Enable tenant scoping (default is true)
    protected static bool $isScopedToTenant = true;

    // Or disable for global trees
    // protected static bool $isScopedToTenant = false;

    protected function schema(array $arguments): array
    {
        return [
            TextInput::make('name')->required(),
            TextInput::make('url')->url(),
        ];
    }
}

```

--------------------------------

### Prepare Eloquent Model for Nested Sets

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

Integrate the NodeTrait into your Eloquent model to enable hierarchical functionality. The getScopeAttributes method allows for multi-tenancy or scoped tree operations.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Kalnoy\Nestedset\NodeTrait;

class Category extends Model
{
    use NodeTrait;

    protected $fillable = ['name', 'slug', 'description'];

    public function getScopeAttributes(): array
    {
        return ['team_id', 'type'];
    }
}
```

--------------------------------

### Livewire Nestedset Component for Category Sidebar

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

This Livewire component extends the base Nestedset component to display a category sidebar. It customizes node labels, active state, URL generation, and handles click events for leaf and parent nodes. It also defines custom queries for fetching category data.

```php
<?php

namespace App\Livewire\Components;

use App\Models\Category;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Illuminate\Support\HtmlString;
use Livewire\Attributes\On;
use Wsmallnews\FilamentNestedset\Livewire\Components\Nestedset;

use function Filament\Support\generate_href_html;

class CategorySidebar extends Nestedset
{
    // Public state for selected category
    public ?int $selectedCategoryId = null;

    // Display settings
    public ?string $showLevel = '2'; // Limit visible depth
    public ?string $emptyLabel = 'No categories';
    public string $recordTitleAttribute = 'name';

    // Custom views (optional)
    public ?string $view = 'sn-filament-nestedset::livewire.components.nestedset';
    public ?string $recordView = 'sn-filament-nestedset::components.nestedset-record';

    // Model class
    protected static ?string $model = Category::class;

    /**
     * Customize how node labels are displayed.
     * Supports HtmlString for rich formatting.
     */
    public function getRecordLabel(Model $record): HtmlString|string
    {
        $childCount = $record->children->count();
        $badge = $childCount > 0 ? " <span class='badge'>{$childCount}</span>" : '';
        return new HtmlString($record->name . $badge);
    }

    /**
     * Determine if a node should show active state.
     */
    public function getHasActive(Model $record): bool
    {
        return $record->id === $this->selectedCategoryId;
    }

    /**
     * Generate URL for node links.
     * Return null to use click events instead.
     */
    public function getRecordUrl(Model $record): string|HtmlString|null
    {
        return generate_href_html(
            route('categories.show', $record->slug),
            shouldOpenInNewTab: false
        );
    }

    /**
     * Handle leaf node click event.
     * Dispatched when clicking nodes without children.
     */
    #[On('sn-filament-nestedset-leaf-click')]
    public function handleLeafClick(int $recordId): void
    {
        $this->selectedCategoryId = $recordId;
        $this->dispatch('category-selected', categoryId: $recordId);
    }

    /**
     * Handle parent node click event.
     * Dispatched when clicking nodes with children.
     */
    #[On('sn-filament-nestedset-node-click')]
    public function handleNodeClick(int $recordId): void
    {
        // Toggle expansion or navigate
        $this->selectedCategoryId = $recordId;
    }

    /**
     * Provide the nested set data.
     * Override for custom queries or filtering.
     */
    public function getNestedset(): Collection
    {
        return Category::query()
            ->where('is_visible', true)
            ->defaultOrder()
            ->withDepth()
            ->get()
            ->toTree();
    }

    /**
     * Add scoping parameters for filtered trees.
     */
    public function nestedScoped(): array
    {
        return ['type' => 'navigation'];
    }

    /**
     * Add custom query conditions.
     */
    public function getEloquentQuery($query)
    {
        return $query->where('status', 'published');
    }
}

```

--------------------------------

### Other Customizable Properties for Nestedset Page

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This snippet showcases various other properties that can be customized for a Filament nestedset page, including model binding, labels, titles, navigation settings, and slugs.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    protected static ?string $model = NavigationModel::class;
    
    protected static ?string $modelLabel = 'Test Management';

    protected static ?string $title = 'Page Title';

    protected static ?string $navigationLabel = 'Test Navigation';

    protected static ?string $navigationGroup = 'Test Group';

    protected static ?string $slug = 'tests';

    protected static string $recordTitleAttribute = 'name';

    protected static ?string $pluralModelLabel = 'Test Management';

    protected static ?int $navigationSort = 1;

    ...

}
```

--------------------------------

### Create Database Migration for Nested Sets

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

Define the database schema using the nestedSet() macro to automatically add the required _lft, _rgt, and parent_id columns for tree structure management.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        Schema::create('categories', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->string('slug')->unique();
            $table->text('description')->nullable();
            $table->nestedSet();
            $table->foreignId('team_id')->nullable()->constrained();
            $table->string('type')->default('default');
            $table->timestamps();
        });
    }

    public function down(): void
    {
        Schema::dropIfExists('categories');
    }
};
```

--------------------------------

### Define Unified Schema for Create/Edit in Nestedset Page

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This method defines the form schema that will be used for both creating new nodes and editing existing ones in the nestedset page. It accepts an array of arguments.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    protected function schema(array $arguments): array
    {
        return [
            //
        ];
    }
    ...

}
```

--------------------------------

### Manually Import Nestedset Styles in Custom Theme

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

When auto-loading is disabled, import the necessary Filament Nestedset CSS files manually within your custom theme's CSS file. This ensures the styles are correctly bundled and applied.

```css
/* resources/css/filament/admin/theme.css */
@import '/vendor/filament/filament/resources/css/theme.css';
@import '../../../../vendor/wsmallnews/filament-nestedset/resources/css/index.css';

/* Custom nested set styling */
.fi-nestedset-node {
    @apply border-l-2 border-primary-500;
}

.fi-nestedset-node-active {
    @apply bg-primary-50 dark:bg-primary-900/20;
}

```

--------------------------------

### Define Additional Scope Parameters (PHP)

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Set custom scope parameters for the 'kalnoy/nestedset' scoping mechanism by implementing the nestedScoped method in your page class.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    public function nestedScoped()
    {
        return ['category_id' => 5];
    }
    ...
}
```

--------------------------------

### Implement KalnoyNestedsetSelectTree Field

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

Configures a hierarchical select field for Filament forms using the KalnoyNestedsetSelectTree component. It supports depth limiting, searchability, and custom query scoping for nested category models.

```php
protected function getFormSchema(): array
{
    return [
        TextInput::make('name')
            ->required(),

        KalnoyNestedsetSelectTree::make('category_id')
            ->label('Category')
            ->level(3)
            ->searchable()
            ->query(
                fn () => Category::scoped(['type' => 'products']),
                titleAttribute: 'name',
                parentAttribute: NestedSet::PARENT_ID
            )
            ->enableBranchNode()
            ->withCount()
            ->placeholder('Select a category')
            ->emptyLabel('No categories available')
            ->treeKey('ProductCategory')
            ->required(),
    ];
}
```

--------------------------------

### Custom Record Label for Nestedset Page

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This method allows for custom formatting of the record label displayed in the nestedset tree. It supports returning an HtmlString for richer display options.

```php
<?php

namespace App\Filament\Pages;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\HtmlString;
use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    public function getRecordLabel(Model $item): HtmlString | string
    {
        return $item->{static::getRecordTitleAttribute()} ?? ' ';
    }
    ...

}
```

--------------------------------

### Disable Scoping to Tenant (PHP)

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

If your Filament panel supports multi-tenancy but a specific page does not require tenant distinction, set the static property $isScopedToTenant to false.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...
    protected static bool $isScopedToTenant = false;
    ...
}
```

--------------------------------

### Customize Infolist Display Breakpoint (PHP)

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Control the screen breakpoint at which the infolist is displayed. By default, it's shown on 'md' screens and above. This property can be set to other Tailwind CSS breakpoints like 'lg'.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...
    protected static string $infolistHiddenEndpoint = 'lg';
    ...
}
```

--------------------------------

### Customize Infolist Alignment (PHP)

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Adjust the horizontal alignment of the infolist content. The default alignment is 'right'. You can change this to 'left' or other supported alignments using Filament's Alignment enum.

```php
<?php

namespace App\Filament\Pages;

use Filament\Support\Enums\Alignment;
use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...
    protected static Alignment $infolistAlignment = Alignment::Left;
    ...
}
```

--------------------------------

### Add Nestedset Fields to New Model Migration

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This code demonstrates how to add the necessary fields for a nested set structure to a new database table using Laravel migrations. The `$table->nestedSet()` method is key for this.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        Schema::create('your_model_table', function (Blueprint $table) {
            ...
            $table->nestedSet();
            ...
        });
    }
};
```

--------------------------------

### Add Custom Eloquent Query Conditions (PHP)

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Modify the default Eloquent query used for fetching nested set data by implementing the getEloquentQuery method. This allows you to add custom where clauses or other query builder methods.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    public function getEloquentQuery($query)
    {
        return $query->where('status', 'normal');
    }
    ...
}
```

--------------------------------

### Disable Auto-Loading of Nestedset Assets

Source: https://context7.com/wsmallnews/filament-nestedset/llms.txt

To integrate with a custom Filament theme, disable the automatic loading of the package's assets by setting 'autoload_assets' to false in the configuration file. This prevents CSS conflicts and allows for manual import.

```php
// config/sn-filament-nestedset.php
return [
    // Disable automatic CSS loading
    'autoload_assets' => false,
];

```

--------------------------------

### Model Scope Attributes for Tabs (PHP)

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

When using tab support, ensure your model's getScopeAttributes method includes the field specified by $tabFieldName (e.g., 'type') to correctly scope the nested set data.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
...

class YouModel extends Model
{
    ...

    public function getScopeAttributes(): array
    {
        return ['type', ...];
    }

    ...
}
```

--------------------------------

### Add Nestedset Fields to Existing Model Migration

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This snippet illustrates how to add the nested set fields to an existing database table using Laravel migrations. It uses `Schema::table` and the `$table->nestedSet()` method.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        Schema::table('your_model_table', function (Blueprint $table) {
            $table->nestedSet();
        });
    }
};
```

--------------------------------

### Define Empty Label Text for Nestedset Page

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This property allows you to customize the text displayed when the nestedset tree is empty. It provides a user-friendly message for the initial state.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    protected static ?string $emptyLabel = 'no test data';

    ...

}
```

--------------------------------

### Model Scope Attributes for Custom Parameters (PHP)

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

Ensure your model's getScopeAttributes method includes any fields used in custom scope parameters defined in the nestedScoped method to maintain correct data scoping.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
...

class YouModel extends Model
{
    ...

    public function getScopeAttributes(): array
    {
        return ['category_id', ...];
    }

    ...
}
```

--------------------------------

### Define Record Title Attribute for Nestedset Page

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This PHP code defines the attribute that will be used to display the name of each node in the nestedset tree within the Filament page. By default, it uses 'name'.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    protected static string $recordTitleAttribute = 'name';
    ...

}
```

--------------------------------

### Limit Nestedset Level

Source: https://github.com/wsmallnews/filament-nestedset/blob/v2/README.md

This property sets a maximum depth for the nestedset structure. By default, the level is unlimited. You can also define a dynamic level using the `getLevel()` method.

```php
<?php

namespace App\Filament\Pages;

use Wsmallnews\FilamentNestedset\Pages\NestedsetPage;

class Test extends NestedsetPage
{
    ...

    protected static ?int $level = 3;

    // Alternatively, you may use the getLevel() to define a dynamic level

    public function getLevel(): ?int
    {
        return static::$level;
    }

    ...

}
```
Tokens:
Raw