Merge pull request #32 from cheesegrits/cheese-graph

Adding AdjacencyListWidget

.github/workflows/dependabot-auto-merge.yml

@@ -14,7 +14,7 @@ jobs:
 
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.6.0
+        uses: dependabot/fetch-metadata@v2.2.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
 

.github/workflows/phpstan.yml

@@ -21,7 +21,7 @@ jobs:
           coverage: none
 
       - name: Install composer dependencies
-        uses: ramsey/composer-install@v2
+        uses: ramsey/composer-install@v3
 
       - name: Run PHPStan
         run: ./vendor/bin/phpstan --error-format=github

README.md

@@ -17,6 +17,25 @@ You can install the package via composer:
 composer require saade/filament-adjacency-list
 ```
 
+> [!IMPORTANT]
+> In an effort to align with Filament's theming methodology you will need to use a custom theme to use this plugin.
+>>  If you have not set up a custom theme and are using a Panel follow the instructions in the Filament Docs first. The following applies to both the Panels Package and the standalone Forms package.
+
+1. Add the plugin's views to your `tailwind.config.js` file.
+
+```js
+content: [
+    ...
+    '<path-to-vendor>/saade/filament-adjacency-list/resources/**/*.blade.php',
+]
+```
+
+2. Rebuild your custom theme.
+
+```sh
+npm run build
+```
+
 ## Usage
 
 ```php
@@ -49,10 +68,13 @@ AdjacencyList::make('subjects')
     ->maxDepth(2)               // defaults to -1 (unlimited depth)
 ```
 
-### Customizing the `MaxDepth` of the tree.
+### Triggering an action or opening a URL when clicking on an item.
 ```php
 AdjacencyList::make('subjects')
-    ->maxDepth(2)               // defaults to -1 (unlimited depth)
+    ->itemAction('edit') // or view, delete, moveUp, indent etc ...
+    ->itemUrl(
+        fn (array $item) => YourResource::getUrl('view', ['record' => $item['id']]) // for example
+    )
 ```
 
 ### Creating items without a modal.
@@ -201,6 +223,36 @@ AdjacencyList::make('subdepartments')
     ->orderColumn('sort')   // or any other column
 ```
 
+## Widget
+
+The `AdjacencyListWidget` can be used to render a tree for any model with a recursive child relationship (including many-to-many graph relationships, using Staudenmeir's HasGraphRelationships trait).
+
+The simplest use case is ...
+
+```php
+class DepartmentTreeWidget extends AdjacencyListWidget
+{    
+    protected static string $relationshipName = 'descendantsAndSelf';
+
+    // If you're using a widget on an Edit or View page, the plugin will automatically set the $record for you.
+    // However, you're free to override this method to customize the record.
+    public function getModel(): Model | string | null
+    {
+        return Department::query()->where(['is_root' => true])->first();
+    }
+
+    // You can configure the widget using the same methods as the form component.
+    protected function adjacencyList(AdjacencyList $adjacencyList): AdjacencyList
+    {
+        return $adjacencyList
+            ->label('Foo')
+            ->editable()
+            ->labelKey('nombre')
+            ->childrenKey('hijos');
+    }
+}
+
+```
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.