lee-to/moonshine-tree-resource

Tree resource for moonshine

2.0.0 2024-10-19 20:59 UTC

This package is auto-updated.

Last update: 2025-02-18 08:20:48 UTC


README

Requirements

  • MoonShine v3.0+

Support MoonShine versions

Installation

composer require lee-to/moonshine-tree-resource

Get started

Example usage with tree

use Leeto\MoonShineTree\Resources\TreeResource;

class CategoryResource extends TreeResource
{
    // Required
    protected string $column = 'title';

    protected string $sortColumn = 'sorting';

    protected function pages(): array
    {
        return [
            CategoryTreePage::class,
            FormPage::class,
            DetailPage::class,
        ];
    }

    // ... fields, model, etc ...

    public function treeKey(): ?string
    {
        return 'parent_id';
    }

    public function sortKey(): string
    {
        return 'sorting';
    }

    // ...
}

And add component

namespace App\MoonShine\Pages;

use Leeto\MoonShineTree\View\Components\TreeComponent;
use MoonShine\Laravel\Pages\Crud\IndexPage;

class CategoryTreePage extends IndexPage
{
    protected function mainLayer(): array
    {
        return [
            ...$this->getPageButtons(),
            TreeComponent::make($this->getResource()),
        ];
    }
}

Or modify index component from resource

protected string $sortColumn = 'sorting';

public function modifyListComponent(ComponentContract $component): ComponentContract
{
    return TreeComponent::make($this);
}

Just a sortable usage

use Leeto\MoonShineTree\Resources\TreeResource;

class CategoryResource extends TreeResource
{
    // Required
    protected string $column = 'title';

    protected string $sortColumn = 'sorting';

    // ... fields, model, etc ...

    public function treeKey(): ?string
    {
        return null;
    }

    public function sortKey(): string
    {
        return 'sorting';
    }

    // ...
}

Additional content

public function itemContent(Model $item): string
{
    return 'Custom content here';
}

Turn off sortable or wrapable

public function wrapable(): bool
{
    return false;
}

public function sortable(): bool
{
    return false;
}