Add API Docs (#671)

robsontenorio · Oct 17, 2024 · 88fc474 · 88fc474
1 parent fe33310
commit 88fc474
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/src/View/Components/Alert.php b/src/View/Components/Alert.php
@@ -10,6 +10,14 @@ class Alert extends Component
 {
     public string $uuid;
 
+    /**
+     * @param ?string  $title  The title of the alert, displayed in bold.
+     * @param ?string  $icon  The icon displayed at the beginning of the alert.
+     * @param ?string  $description  A short description under the title.
+     * @param ?bool  $shadow  Whether to apply a shadow effect to the alert.
+     * @param ?bool  $dismissible  Whether the alert can be dismissed by the user.
+     * @slot  mixed  $actions  Slots for actionable elements like buttons or links.
+     */
     public function __construct(
         public ?string $title = null,
         public ?string $icon = null,

diff --git a/src/View/Components/Avatar.php b/src/View/Components/Avatar.php
@@ -10,6 +10,13 @@ class Avatar extends Component
 {
     public string $uuid;
 
+    /**
+     * @param  ?string  $image  The URL of the avatar image.
+     * @param  ?string  $title  The title text displayed beside the avatar.
+     * @slot  ?string  $title  The title text displayed beside the avatar.
+     * @param  ?string  $subtitle  The subtitle text displayed beside the avatar.
+     * @slot  ?string  $subtitle The subtitle text displayed beside the avatar.
+     */
     public function __construct(
         public ?string $image = '',