Merge pull request #623 from code16/command-icon

aguingand · web-flow · commit 3ff530fb494a · 2025-09-01T19:17:38.000+02:00
Command icon
diff --git a/demo/app/Sharp/Authors/Commands/VisitFacebookProfileCommand.php b/demo/app/Sharp/Authors/Commands/VisitFacebookProfileCommand.php
@@ -14,7 +14,8 @@ public function label(): string
 
     public function buildCommandConfig(): void
     {
-        $this->configureDescription('You will leave Sharp');
+        $this->configureDescription('You will leave Sharp')
+            ->configureIcon('lucide-facebook');
     }
 
     public function execute(mixed $instanceId, array $data = []): array
diff --git a/demo/app/Sharp/Posts/Commands/BulkPublishPostsCommand.php b/demo/app/Sharp/Posts/Commands/BulkPublishPostsCommand.php
@@ -15,6 +15,7 @@ public function label(): ?string
     public function buildCommandConfig(): void
     {
         $this->configureDescription('Bulk command to publish posts')
+            ->configureIcon('lucide-check-check')
             ->configureInstanceSelectionRequired();
     }
 
diff --git a/demo/app/Sharp/Posts/Commands/ComposeEmailWithPostsWizardCommand.php b/demo/app/Sharp/Posts/Commands/ComposeEmailWithPostsWizardCommand.php
@@ -21,7 +21,8 @@ public function label(): ?string
 
     public function buildCommandConfig(): void
     {
-        $this->configureDescription('Use this wizard command to compose a message choosing posts links in a list');
+        $this->configureDescription('Use this wizard command to compose a message choosing posts links in a list')
+            ->configureIcon('lucide-mail');
     }
 
     public function buildFormFieldsForFirstStep(FieldsContainer $formFields): void
diff --git a/ide.json b/ide.json
@@ -16,6 +16,56 @@
                     ]
                 }
             ]
+        },
+        {
+            "complete": "bladeIcon",
+            "condition": [
+                {
+                    "classFqn": [
+                        "Code16\\Sharp\\Utils\\Menu\\HasSharpMenuItems"
+                    ],
+                    "methodNames": [
+                        "addEntityLink"
+                    ],
+                    "parameters": [
+                        3
+                    ]
+                },
+                {
+                    "classFqn": [
+                        "Code16\\Sharp\\Form\\Fields\\Embeds\\SharpFormEditorEmbed"
+                    ],
+                    "methodNames": [
+                        "configureIcon"
+                    ],
+                    "parameters": [
+                        1
+                    ]
+                },
+                {
+                    "classFqn": [
+                        "Code16\\Sharp\\EntityList\\Commands\\Command"
+                    ],
+                    "methodNames": [
+                        "configureIcon"
+                    ],
+                    "parameters": [
+                        1
+                    ]
+                },
+                {
+                    "place": "parameter",
+                    "classFqn": [
+                        "Code16\\Sharp\\EntityList\\EntityListEntities"
+                    ],
+                    "methodNames": [
+                        "addEntity"
+                    ],
+                    "parameters": [
+                        3
+                    ]
+                }
+            ]
         }
     ],
     "view": {
@@ -285,4 +335,4 @@
             ]
         }
     ]
-}
+}
diff --git a/resources/js/commands/components/CommandDropdownItems.vue b/resources/js/commands/components/CommandDropdownItems.vue
@@ -6,6 +6,7 @@
     import { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger } from "@/components/ui/tooltip";
     import { useBreakpoints } from "@/composables/useBreakpoints";
     import { showAlert } from "@/utils/dialogs";
+    import Icon from "@/components/ui/Icon.vue";
 
     const props = defineProps<{
         commands: CommandData[][],
@@ -38,6 +39,9 @@
                                 @click="$emit('select', command)"
                                 :disabled="requiresSelection(command)"
                             >
+                                <template v-if="command.icon">
+                                    <Icon :icon="command.icon" class="size-4" />
+                                </template>
                                 <div>
                                     {{ command.label }}
                                     <template v-if="command.description">
diff --git a/resources/js/types/generated.d.ts b/resources/js/types/generated.d.ts
@@ -44,6 +44,7 @@ export type CommandData = {
     buttonLabel: string | null;
   } | null;
   hasForm: boolean;
+  icon: IconData | null;
   authorization: Array<string | number> | boolean;
   instanceSelection: InstanceSelectionMode | null;
   primary: boolean | null;
diff --git a/src/Data/Commands/CommandData.php b/src/Data/Commands/CommandData.php
@@ -3,6 +3,7 @@
 namespace Code16\Sharp\Data\Commands;
 
 use Code16\Sharp\Data\Data;
+use Code16\Sharp\Data\IconData;
 use Code16\Sharp\Enums\CommandType;
 use Code16\Sharp\Enums\InstanceSelectionMode;
 use Spatie\TypeScriptTransformer\Attributes\LiteralTypeScriptType;
@@ -20,6 +21,7 @@ public function __construct(
         #[LiteralTypeScriptType('{ text: string, title: string | null, buttonLabel: string | null } | null')]
         public ?array $confirmation,
         public bool $hasForm,
+        public ?IconData $icon,
         /** @var array<string|int>|bool */
         public array|bool $authorization,
         public ?InstanceSelectionMode $instanceSelection = null,
@@ -34,6 +36,7 @@ public static function from(array $command): self
             'instanceSelection' => isset($command['instanceSelection'])
                 ? InstanceSelectionMode::from($command['instanceSelection'])
                 : null,
+            'icon' => IconData::optional($command['icon'] ?? null),
         ];
 
         return new self(...$command);
diff --git a/src/EntityList/Commands/Command.php b/src/EntityList/Commands/Command.php
@@ -33,6 +33,7 @@ abstract class Command
     private ?string $confirmationTitle = null;
     private ?string $confirmationButtonLabel = null;
     private ?string $description = null;
+    private ?string $icon = null;
 
     protected function info(string $message, bool $reload = false): array
     {
@@ -146,6 +147,13 @@ final protected function configureConfirmationText(string $confirmationText, ?st
         return $this;
     }
 
+    final protected function configureIcon(string $icon): self
+    {
+        $this->icon = $icon;
+
+        return $this;
+    }
+
     /**
      * Check if the current user is allowed to use this Command.
      */
@@ -179,6 +187,11 @@ final public function getDescription(): ?string
         return $this->description;
     }
 
+    final public function getIcon(): ?string
+    {
+        return $this->icon;
+    }
+
     final public function getFormModalTitle(?array $formData): ?string
     {
         return ($callback = $this->formModalTitle) instanceof Closure
diff --git a/src/EntityList/Traits/Utils/CommonCommandUtils.php b/src/EntityList/Traits/Utils/CommonCommandUtils.php
@@ -4,6 +4,7 @@
 
 use Code16\Sharp\EntityList\Commands\Command;
 use Code16\Sharp\EntityList\Commands\EntityCommand;
+use Code16\Sharp\Utils\Icons\IconManager;
 use Illuminate\Support\Collection;
 
 trait CommonCommandUtils
@@ -30,6 +31,7 @@ protected function appendCommandsToConfig(Collection $commandHandlers, array &$c
                     'authorization' => $instanceId
                         ? $handler->authorizeFor($instanceId)
                         : $handler->getGlobalAuthorization(),
+                    'icon' => app(IconManager::class)->iconToArray($handler->getIcon()),
                     ...$handler instanceof EntityCommand ? [
                         'instanceSelection' => $handler->getInstanceSelectionMode(),
                     ] : [],
diff --git a/tests/Unit/Dashboard/DashboardCommandTest.php b/tests/Unit/Dashboard/DashboardCommandTest.php
@@ -34,6 +34,7 @@ public function execute(array $data = []): array {}
             'description' => null,
             'confirmation' => null,
             'hasForm' => false,
+            'icon' => null,
         ]);
 });
 
@@ -113,6 +114,7 @@ public function execute(array $data = []): array {}
                         'authorization' => true,
                         'confirmation' => null,
                         'description' => null,
+                        'icon' => null,
                     ],
                 ],
             ],
diff --git a/tests/Unit/EntityList/SharpEntityListCommandTest.php b/tests/Unit/EntityList/SharpEntityListCommandTest.php
@@ -53,6 +53,7 @@ public function execute($instanceId, array $data = []): array {}
                     'instanceSelection' => null,
                     'confirmation' => null,
                     'hasForm' => false,
+                    'icon' => null,
                 ],
             ],
         ],
@@ -66,6 +67,7 @@ public function execute($instanceId, array $data = []): array {}
                     'description' => null,
                     'confirmation' => null,
                     'hasForm' => false,
+                    'icon' => null,
                 ],
             ],
         ],
@@ -265,7 +267,7 @@ public function getListData(): array|\Illuminate\Contracts\Support\Arrayable
     expect($list->listConfig()['commands']['instance'][0][0]['authorization'])->toEqual([1, 2]);
 });
 
-it('allows to define a description on a command', function () {
+it('allows to define a description & icon on a command', function () {
     $list = new class() extends FakeSharpEntityList
     {
         public function getEntityCommands(): ?array
@@ -280,7 +282,8 @@ public function label(): string
 
                     public function buildCommandConfig(): void
                     {
-                        $this->configureDescription('My Entity Command description');
+                        $this->configureDescription('My Entity Command description')
+                            ->configureIcon('testicon-user');
                     }
 
                     public function execute(array $data = []): array {}
@@ -291,7 +294,13 @@ public function execute(array $data = []): array {}
 
     $list->buildListConfig();
 
-    expect($list->listConfig()['commands']['entity'][0][0]['description'])->toEqual('My Entity Command description');
+    expect($list->listConfig()['commands']['entity'][0][0])->toMatchArray([
+        'description' => 'My Entity Command description',
+        'icon' => [
+            'name' => 'testicon-user',
+            'svg' => '<svg><!--user--></svg>',
+        ],
+    ]);
 });
 
 it('allows to define separators in instance commands', function () {

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,8 @@ public function label(): string`
`14`	`14`
`15`	`15`	`public function buildCommandConfig(): void`
`16`	`16`	`{`
`17`		`- $this->configureDescription('You will leave Sharp');`
	`17`	`+ $this->configureDescription('You will leave Sharp')`
	`18`	`+ ->configureIcon('lucide-facebook');`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`public function execute(mixed $instanceId, array $data = []): array`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public function label(): ?string`
`15`	`15`	`public function buildCommandConfig(): void`
`16`	`16`	`{`
`17`	`17`	`$this->configureDescription('Bulk command to publish posts')`
	`18`	`+ ->configureIcon('lucide-check-check')`
`18`	`19`	`->configureInstanceSelectionRequired();`
`19`	`20`	`}`
`20`	`21`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@ public function label(): ?string`
`21`	`21`
`22`	`22`	`public function buildCommandConfig(): void`
`23`	`23`	`{`
`24`		`- $this->configureDescription('Use this wizard command to compose a message choosing posts links in a list');`
	`24`	`+ $this->configureDescription('Use this wizard command to compose a message choosing posts links in a list')`
	`25`	`+ ->configureIcon('lucide-mail');`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`public function buildFormFieldsForFirstStep(FieldsContainer $formFields): void`