feat: rename 'state' to 'status' in Progress Stepper; update related documentation and examples for Posts

Author: suraj-webkul

src/master/advanced/images/filter-view.png

@@ -31,11 +31,11 @@ public static function form(Form $form): Form
 {
     return $form
         ->schema([
-            ProgressStepper::make('state')
+            ProgressStepper::make('status')
                 ->hiddenLabel()
                 ->inline()
                 ->options(fn ($record) => self::getStateOptions($record))
-                ->default(OrderState::DRAFT->value)
+                ->default(PostStatus::DRAFT->value)
                 ->disabled()
                 ->live()
                 ->reactive(),
@@ -44,14 +44,17 @@ public static function form(Form $form): Form
 
 protected static function getStateOptions($record): array
 {
-    $options = OrderState::options();
+    $options = PostStatus::options();
 
-    if ($record && $record->state !== OrderState::CANCEL->value) {
-        unset($options[OrderState::CANCEL->value]);
+    if (
+        $record
+        && $record->status !== PostStatus::UNPUBLISHED->value
+    ) {
+        unset($options[PostStatus::UNPUBLISHED->value]);
     }
 
-    if (!$record) {
-        unset($options[OrderState::CANCEL->value]);
+    if (! $record) {
+        unset($options[PostStatus::UNPUBLISHED->value]);
     }
 
     return $options;
@@ -60,19 +63,19 @@ protected static function getStateOptions($record): array
 
 ## **Changing Button Colors**
 
-To modify the colors of different states, use the `colors()` method:
+To modify the colors of different status, use the `colors()` method:
 
 ```php
-ProgressStepper::make('state')
+ProgressStepper::make('status')
     ->options([
-        'draft' => 'Draft',
-        'processing' => 'Processing',
-        'completed' => 'Completed'
+        'draft'       => 'Draft',
+        'unpublished' => 'Unpublished',
+        'published'   => 'Published'
     ])
     ->colors([
-        'draft' => 'gray',
-        'processing' => 'info',
-        'completed' => 'success',
+        'draft'       => 'gray',
+        'unpublished' => 'info',
+        'published'   => 'success',
     ]);
 ```
 
@@ -83,14 +86,14 @@ To display icons alongside state labels, use the `icons()` method:
 ```php
 ProgressStepper::make('state')
     ->options([
-        'draft' => 'Draft',
-        'processing' => 'Processing',
-        'completed' => 'Completed'
+        'draft'       => 'Draft',
+        'unpublished' => 'Unpublished',
+        'published'   => 'Published'
     ])
     ->icons([
-        'draft' => 'heroicon-o-pencil',
-        'processing' => 'heroicon-o-clock',
-        'completed' => 'heroicon-o-check-circle',
+        'draft'       => 'heroicon-o-pencil',
+        'unpublished' => 'heroicon-o-circle',
+        'published'   => 'heroicon-o-check-badge',
     ]);
 ```
 
@@ -99,37 +102,36 @@ ProgressStepper::make('state')
 Instead of defining options manually, you can use an Enum:
 
 ```php
-use App\Enums\OrderState;
+use App\Enums\PostStatus;
 
-ProgressStepper::make('state')
-    ->options(OrderState::options())
-    ->colors(OrderState::colors())
-    ->icons(OrderState::icons());
+ProgressStepper::make('status')
+    ->options(PostStatus::options())
+    ->colors(PostStatus::colors())
+    ->icons(PostStatus::icons());
 ```
 
-This keeps the state definitions centralized in an `OrderState` enum.
+This keeps the status definitions centralized in an `PostStatus` enum.
 
-## **Handling Conditional States**
+## **Handling Conditional Statuses**
 
-To prevent certain states from being displayed (e.g., hiding "Canceled" if the order is active):
+To prevent certain statuses from being displayed (e.g., hiding "UNPUBLISHED" if the status is unpublished):
 
 ```php
-ProgressStepper::make('state')
+ProgressStepper::make('status')
     ->options(function ($record) {
-        $options = OrderState::options();
+        $options = PostStatus::options();
 
-        if ($record && $record->state != OrderState::CANCEL->value) {
-            unset($options[OrderState::CANCEL->value]);
+        if (
+            $record
+            && $record->status != PostStatus::UNPUBLISHED->value
+        ) {
+            unset($options[PostStatus::UNPUBLISHED->value]);
         }
 
         return $options;
     });
 ```
 
-## **Example Output**
-
-![Progress Stepper](./images/progress-stepper.png)
-
 ## **Key Features**
 
 - **Extends Filament’s `ToggleButtons`**: Ensures seamless integration with Filament forms.

src/master/advanced/images/progress-stepper.png

@@ -93,20 +93,20 @@ When applied to a resource page, this trait:
 
 ## Implementation Example
 
-The `ListOrders` class demonstrates how to implement table views in a resource page:
+The `ListBlogs` class demonstrates how to implement table views in a resource page:
 
 ```php
-namespace Webkul\Purchase\Filament\Admin\Clusters\Orders\Resources\OrderResource\Pages;
+namespace Webkul\Blog\Filament\Admin\Clusters\Blog\Resources\BlogResource\Pages;
 ```
 
-This class uses the `HasTableViews` trait and defines multiple preset views for the Orders table:
+This class uses the `HasTableViews` trait and defines multiple preset views for the Blogs table:
 
 ```php
 public function getPresetTableViews(): array
 {
     return [
-        'my_purchases' => PresetView::make(__('My Purchases'))
-            ->icon('heroicon-o-shopping-cart')
+        'my_posts' => PresetView::make(__('My Posts'))
+            ->icon('heroicon-o-user')
             ->favorite()
             ->modifyQueryUsing(fn (Builder $query) => $query->where('user_id', Auth::id())),
 
@@ -115,22 +115,12 @@ public function getPresetTableViews(): array
 }
 ```
 
-### Available Preset Views in the Example
-
-1. **My Purchases**: Shows orders created by the current user
-2. **Purchase Orders**: Filters orders in PURCHASE or DONE states
-3. **Starred Orders**: Shows high-priority (starred) orders
-4. **Orders**: Shows orders in DRAFT or SENT states
-5. **Draft Orders**: Shows only orders in DRAFT state
-6. **Waiting Orders**: Shows only orders in SENT state
-7. **Late Orders**: Shows orders past their ordered_at date that are still in DRAFT or SENT states
-
 ## Customizing Queries
 
 Each preset view can modify the underlying query using the `modifyQueryUsing` method. This allows for powerful filtering capabilities:
 
 ```php
-->modifyQueryUsing(fn (Builder $query) => $query->where('state', OrderState::DRAFT))
+->modifyQueryUsing(fn (Builder $query) => $query->where('author_id', Auth::id()))
 ```
 
 ## User Favorites System
@@ -163,7 +153,7 @@ Preset views can include icons for better visual recognition:
 The example shows proper use of translation strings for view labels:
 
 ```php
-PresetView::make(__('purchases::filament/admin/clusters/orders/resources/order/pages/list-orders.tabs.my-purchases'))
+PresetView::make(__('blogs::filament/admin/clusters/blogs/resources/posts/pages/list-posts.tabs.my-posts'))
 ```
 
 ## **Example Output of Table View Filters**

src/master/advanced/images/table-filters-view.png

@@ -24,48 +24,47 @@ To enable clusters in Aures ERP, configure the panel to discover cluster classes
         $panel
             ->when($panel->getId() == 'admin', function (Panel $panel) {
                 $panel
-                    ->discoverResources(in: $this->getPluginBasePath('/Filament/Resources'), for: 'Webkul\\Inventory\\Filament\\Resources')
-                    ->discoverPages(in: $this->getPluginBasePath('/Filament/Pages'), for: 'Webkul\\Inventory\\Filament\\Pages')
-                    ->discoverClusters(in: $this->getPluginBasePath('/Filament/Clusters'), for: 'Webkul\\Inventory\\Filament\\Clusters')
-                    ->discoverWidgets(in: $this->getPluginBasePath('/Filament/Widgets'), for: 'Webkul\\Inventory\\Filament\\Widgets');
+                    ->discoverResources(in: $this->getPluginBasePath('/Filament/Resources'), for: 'Webkul\\Blog\\Filament\\Resources')
+                    ->discoverPages(in: $this->getPluginBasePath('/Filament/Pages'), for: 'Webkul\\Blog\\Filament\\Pages')
+                    ->discoverClusters(in: $this->getPluginBasePath('/Filament/Clusters'), for: 'Webkul\\Blog\\Filament\\Clusters')
+                    ->discoverWidgets(in: $this->getPluginBasePath('/Filament/Widgets'), for: 'Webkul\\Blog\\Filament\\Widgets');
             });
     }
 ```
 
 Now, generate a cluster using:
 
 ```sh
-php artisan make:filament-cluster Products
+php artisan make:filament-cluster Posts
 ```
 
-This creates a `Products` cluster in `Webkul\Inventory\Filament\Clusters`:
+This creates a `Products` cluster in `Webkul\Blog\Filament\Clusters`:
 
 ```php
 <?php
 
-namespace Webkul\Inventory\Filament\Clusters;
+namespace Webkul\Blog\Filament\Clusters;
 
 use Filament\Clusters\Cluster;
 
-class Products extends Cluster
+class Posts extends Cluster
 {
-    protected static ?string $slug = 'inventory/products';
+    protected static ?string $slug = 'blog/posts';
 
-    protected static ?string $navigationIcon = 'heroicon-o-shopping-bag';
+    protected static ?string $navigationIcon = 'heroicon-o-document-text';
 
     protected static ?int $navigationSort = 2;
 
     public static function getNavigationLabel(): string
     {
-        return __('Products');
+        return __('Posts');
     }
 
     public static function getNavigationGroup(): string
     {
-        return __('Inventory');
+        return __('Blog');
     }
 }
-
 ```
 
 You can customize the navigation using `$navigationLabel`, `$navigationSort`, and `$navigationGroup`.
@@ -75,9 +74,9 @@ You can customize the navigation using `$navigationLabel`, `$navigationSort`, an
 To assign a resource or page to a cluster, set the `$cluster` property:
 
 ```php
-use Webkul\Inventory\Filament\Clusters\Products;
+use Webkul\Blog\Filament\Clusters\Posts;
 
-protected static ?string $cluster = Products::class;
+protected static ?string $cluster = Posts::class;
 ```
 
 ## Recommended Code Structure
@@ -86,15 +85,15 @@ For better organization, store related resources and pages inside a directory ma
 
 ```
 +-- Clusters
-|   +-- Products.php
-|   +-- Products
+|   +-- Posts.php
+|   +-- Posts
 |   |   +-- Resources
-|   |   |   +-- ProductResource.php
-|   |   |   +-- ProductResource
+|   |   |   +-- PostResource.php
+|   |   |   +-- PostResource
 |   |   |   |   +-- Pages
-|   |   |   |   |   +-- CreateProduct.php
-|   |   |   |   |   +-- EditProduct.php
-|   |   |   |   |   +-- ListProducts.php
+|   |   |   |   |   +-- CreatePost.php
+|   |   |   |   |   +-- EditPost.php
+|   |   |   |   |   +-- ListPosts.php
 ```
 
 Filament will prompt whether to place new resources or pages inside a cluster when using `make:filament-resource` or `make:filament-page`.

src/master/advanced/progress-stepper.md

@@ -17,8 +17,6 @@ public function getTabs(): array
         'all' => Tab::make(__('All Products'))->badge(Product::count()),
         'archived' => Tab::make(__('Archived'))->badge(Product::onlyTrashed()->count())
             ->modifyQueryUsing(fn ($query) => $query->onlyTrashed()),
-        'out_of_stock' => Tab::make(__('Out of Stock'))->badge(Product::where('stock', 0)->count())
-            ->modifyQueryUsing(fn ($query) => $query->where('stock', 0)),
     ];
 }
 ```