Download the PHP package ubertech-za/filament-tree-enhanced without Composer
On this page you can find all versions of the php package ubertech-za/filament-tree-enhanced. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ubertech-za/filament-tree-enhanced
More information about ubertech-za/filament-tree-enhanced
Files in ubertech-za/filament-tree-enhanced
Package filament-tree-enhanced
Short Description An enhanced tree layout plugin for Filament Admin with policy authorization and dedicated tree resources
License MIT
Homepage https://github.com/ubertech-za/filament-tree-enhanced
Informations about the package filament-tree-enhanced
Enhanced Filament Tree
This is an enhanced version of the Filament Tree plugin, maintained by Uber Technologies cc. We've built upon the excellent work of the original authors at Solution Forest to add policy authorization, dedicated tree resources that replace table views, and enhanced Filament v4 and v5 compatibility.
Key Enhancements:
- Laravel policy authorization with automatic action hiding
- Dedicated tree resources that replace table views entirely
- Enhanced parent-child relationship management
- Improved action system with hooks
- Full backward compatibility with original features
Attribution: Originally created by Solution Forest, enhanced and maintained by Uber Technologies cc.
Filament Tree
Filament Tree is a plugin for Filament Admin that creates a model management page with a heritage tree structure view. This plugin can be used to create menus and more.
This plugin creates model management page with heritage tree structure view for Filament Admin. It could be used to create menu, etc.
Supported Filament versions
| Filament Version | Plugin Version |
|---|---|
| v5 | 5.x.x |
| v4 | 4.x.x |
Installation
To install the package, run the following command:
Important: Need to publish assets after version 2.x
Note: Add plugin Blade files to your custom theme
tailwind.config.jsfor dark mode.To set up your own custom theme, you can visit the official instruction page on the Filament website.
Add the plugin's views and css to your theme.css file.
Then, publish the config file using:
You can set your preferred options by adding the following code to your config/filament-tree-enhanced.php file:
Usage
Prepare the database and model
To use Filament Tree, follow these table structure conventions:
Tip: The
parent_idfield must always default to -1!!!
This plugin provides a convenient method called treeColumns() that you can use to add the required columns for the tree structure to your table more easily. Here's an example:
This will automatically add the required columns for the tree structure to your table.
The above table structure contains three required fields: parent_id, order, title, and other fields do not have any requirements.
The corresponding model is app/Models/ProductCategory.php:
The field names of the three fields parent_id, order, and title in the table structure can also be modified:
Widget
Filament provides a powerful feature that allows you to display widgets inside pages, below the header and above the footer. This can be useful for adding additional functionality to your resource pages.
To create a Tree Widget and apply it to a resource page, you can follow these steps:
1. Creating a Filament Resource Page
To create a resources page, run the following command:
2. Create Tree Widget
Prepare the filament-tree Widget and show it in Resource page.
Now you can see the Widget in Filament Folder
3. Displaying a widget on a resource page
Once you have created the widget, modify the getHeaderWidgets() or getFooterWidgets() methods of the resource page to show the tree view:
Resources
Filament allows you to create a custom pages for resources, you also can create a tree page that display hierarchical data.
Create a Page
To create a tree page for resource, you can use:
Register a Page to the resource
You must register the tree page to a route in the static getPages() methods of your resource. For example:
Actions
Define the available "actions" for the tree page using the getActions() and getTreeActions() methods of your page class.
The getActions() method defines actions that are displayed next to the page's heading:
The getTreeActions() method defines the actions that are displayed for each record in the tree. For example:
Alternatively, you can use the hasDeleteAction(), hasEditAction(), and hasViewAction() methods to customize each action individually.
Record ICON
To customize the prefix icon for each record in a tree page, you can use the getTreeRecordIcon() method in your tree page class. This method should return a string that represents the name of the icon you want to use for the record. For example:
Node collapsed state
You can customize a collapsed state of the node. If you would like to show your tree initially collapsed you can use:
Record Title
To customize the ttile for each record in a tree page, you can use the getTreeRecordTitle() method in your tree page class. This method should return a string that represents the name of the icon you want to use for the record. For example:
Configuring Tree Item Actions
You can customize the behavior and appearance of tree item actions (Delete, Edit, and View) by overriding the configuration methods in your widget or page class. Each action type has its own configuration method:
Configure Delete Action
Override the configureDeleteAction() method to customize the delete action:
Configure Edit Action
Override the configureEditAction() method to customize the edit action:
Configure View Action
Override the configureViewAction() method to customize the view action:
Example: Complete Action Configuration
Here's a complete example showing how to configure all three actions in a tree widget:
Pages
This plugin enables you to create tree pages in the admin panel. To create a tree page for a model, use the make:filament-tree-page command. For example, to create a tree page for the ProductCategory model, you can run:
Create a Page
Tip: Note that you should make sure the model contains the required columns or already uses the
ModelTreetrait
Actions, Widgets and Icon for each record
Once you've created the tree page, you can customize the available actions, widgets, and icon for each record. You can use the same methods as for resource pages. See the Resource Page for more information on how to customize actions, widgets, and icons.
Translation
Suggest used with Spatie Translatable https://github.com/lara-zeus/translatable Plugin.
-
Ensure your model already apply translatable setup. (Refence on https://spatie.be/docs/laravel-translatable/v6/installation-setup)
- You need to add the necessary trait and
LocaleSwitcherheader action to your tree page:
Publishing Views
To publish the views, use:
Publishing Translations
To publish the translations, use:
🆕 Enhanced Features
This enhanced fork includes powerful new features that extend the capabilities of Filament Tree:
1. Tree Resource Generation Command
Create complete tree resources that replace table views with hierarchical tree interfaces:
Command: make:filament-tree-resource
Generated Structure (Filament v4 / v5 Pattern)
The command creates a complete resource following Filament v4 / v5's folder-based organization:
Key Differences from Original Approaches
Tree Resource vs Resource with Tree Widget:
- Creates a dedicated tree resource (not a regular resource + tree widget)
- The tree view completely replaces the table view
- Designed specifically for hierarchical data management
Page-Based Navigation (No Modals):
- Uses dedicated pages for Create, Edit, List, and View operations
- Matches standard Filament resource behavior
- Better UX for complex forms and workflows
- Supports deep linking and browser navigation
Enhanced Capabilities:
- Relation Manager Support: Add ContactsRelationManager, etc. (not supported in widget/old integration)
- Custom Record Actions: Full support for custom actions on tree records
- Policy Integration: Complete Laravel policy authorization
- Parent ID Auto-Population: Child creation automatically sets parent relationships
Usage Example
2. Laravel Policy Authorization
Automatically hide unauthorized actions based on Laravel policies:
Features:
- Actions are completely hidden when unauthorized (not just disabled)
- Tree reordering disabled when user lacks update permissions
- Works with any Laravel authorization system (Gates, Policies, Spatie)
- Configurable ability mapping
Policy Methods Supported:
3. Enhanced Action System
CreateChildAction with Auto Parent-Child Relationships
Action Hooks System
All tree actions now support powerful before/after hooks:
4. Enhanced Configuration
The config file now includes additional options:
5. Backward Compatibility
All original functionality remains fully supported:
make:filament-tree-page: Creates standalone tree pages with modal formsmake:filament-tree-widget: Creates tree widgets for dashboards- Resource Integration: Original "create in resource" option still works
The enhanced features are additive and don't break existing implementations.
Testing
To run the tests, run:
Changelog
See the CHANGELOG for more information on what has changed recently.
Contributing
See CONTRIBUTING for details.
Security Vulnerabilities
If you discover any security related issues, please report them via the GitHub issue tracker or create a private security advisory.
Credits
Original Work: Solution Forest - Carly and contributors
Enhancements: Uber Technologies cc
License
Enhanced Filament Tree is open-sourced software licensed under the MIT license.
All versions of filament-tree-enhanced with dependencies
filament/filament Version ^4.0 || ^5.0
spatie/laravel-package-tools Version ^1.15.0